> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vellaro.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Recurring

> Admin: create a new recurring billing profile.



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json post /api/v1/admin/recurrings
openapi: 3.1.0
info:
  title: Vellaro Admin API
  description: >-
    Store management under `/api/v1/admin`, for back ends and integrations.
    Every call takes `Authorization: Bearer <token>`: an admin API token or a
    staff user's token. The permissions of its role decide what it can do,
    always in its own store.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Orders
    description: >-
      Orders and manual orders, payments, refunds, shipments, invoices, returns,
      customer subscriptions.
  - name: Products
    description: Products, variants, images, prices and discounts, product lookups.
  - name: Categories & catalog setup
    description: >-
      Categories, brands, attributes, options, filters, downloadable files,
      recurring profiles.
  - name: Inventory
    description: Stock of the variants and stock statuses.
  - name: Customers
    description: Customers, customer groups, custom fields.
  - name: Reviews & questions
    description: Moderation of product reviews and questions.
  - name: Promotions & coupons
    description: Coupons and gift vouchers.
  - name: Marketing
    description: Campaigns, newsletter subscribers, affiliates and their commissions.
  - name: Content
    description: >-
      CMS pages, menus, banners, information pages, flipbooks, media library,
      SEO URLs, email templates, translations.
  - name: Settings
    description: >-
      Store settings, email delivery, languages, currencies, physical stores,
      social login providers.
  - name: Shipping
    description: Couriers, shipping rates, weight and length classes.
  - name: Taxes & geo
    description: Tax classes, rates and rules; countries, zones and geo zones.
  - name: Integrations & modules
    description: >-
      Integrations, plugins and modules (Iute, extra warranty, Nextera, Financa
      5, WhatsApp, Firebase), outbound webhooks.
  - name: AI
    description: AI content generation and the settings of the AI shopping assistant.
  - name: Imports
    description: 'CSV imports and the universal import: runs, mappings, previews, undo.'
  - name: Reports & dashboard
    description: Dashboard figures and reports.
  - name: Users & API keys
    description: Staff users and roles, publishable keys, admin API tokens.
  - name: Audit
    description: The store's audit log.
paths:
  /api/v1/admin/recurrings:
    post:
      tags:
        - Categories & catalog setup
      summary: Create Recurring
      description: 'Admin: create a new recurring billing profile.'
      operationId: create_recurring_api_v1_admin_recurrings_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecurringCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_RecurringOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    RecurringCreate:
      properties:
        name_i18n:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Name I18N
        price:
          anyOf:
            - type: number
              maximum: 99999999.99
              exclusiveMinimum: 0
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Price
        frequency:
          type: string
          title: Frequency
        duration:
          type: integer
          maximum: 1000
          minimum: 1
          title: Duration
          default: 1
        cycle:
          type: integer
          maximum: 1000
          minimum: 0
          title: Cycle
          default: 0
        trial_status:
          type: boolean
          title: Trial Status
          default: false
        trial_price:
          anyOf:
            - type: number
              maximum: 99999999.99
              minimum: 0
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Trial Price
        trial_frequency:
          anyOf:
            - type: string
            - type: 'null'
          title: Trial Frequency
        trial_duration:
          anyOf:
            - type: integer
              maximum: 1000
              minimum: 0
            - type: 'null'
          title: Trial Duration
        trial_cycle:
          anyOf:
            - type: integer
              maximum: 1000
              minimum: 0
            - type: 'null'
          title: Trial Cycle
        is_active:
          type: boolean
          title: Is Active
          default: true
        sort_order:
          type: integer
          title: Sort Order
          default: 0
      type: object
      required:
        - price
        - frequency
      title: RecurringCreate
      description: >-
        VEN-3: `duration` = ogni quante unita' di `frequency` si addebita (>=
        1);

        `cycle` = quante volte in tutto, acquisto compreso (0 = senza fine);

        `trial_duration` = durata della prova in `trial_frequency` (>= 1 se

        `trial_status`). `trial_cycle` resta accettato ma la prova e' un solo

        periodo: conta solo per i piani salvati senza `trial_duration`.
    ApiResponse_RecurringOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/RecurringOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[RecurringOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RecurringOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name_i18n:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Name I18N
        price:
          type: number
          title: Price
        frequency:
          type: string
          title: Frequency
        duration:
          type: integer
          title: Duration
        cycle:
          type: integer
          title: Cycle
        trial_status:
          type: boolean
          title: Trial Status
        trial_price:
          anyOf:
            - type: number
            - type: 'null'
          title: Trial Price
        trial_frequency:
          anyOf:
            - type: string
            - type: 'null'
          title: Trial Frequency
        trial_duration:
          anyOf:
            - type: integer
            - type: 'null'
          title: Trial Duration
        trial_cycle:
          anyOf:
            - type: integer
            - type: 'null'
          title: Trial Cycle
        is_active:
          type: boolean
          title: Is Active
        sort_order:
          type: integer
          title: Sort Order
        billing_interval:
          type: integer
          title: Billing Interval
          default: 1
        billing_charges:
          type: integer
          title: Billing Charges
          default: 0
        trial_length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Trial Length
        legacy_schedule:
          type: boolean
          title: Legacy Schedule
          default: false
        active_subscriptions:
          type: integer
          title: Active Subscriptions
          default: 0
        total_subscriptions:
          type: integer
          title: Total Subscriptions
          default: 0
      type: object
      required:
        - id
        - name_i18n
        - price
        - frequency
        - duration
        - cycle
        - trial_status
        - trial_price
        - trial_frequency
        - trial_duration
        - trial_cycle
        - is_active
        - sort_order
      title: RecurringOut
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.