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

# Publish a version

> Publishes a `draft` version. From here on its pricing is fixed and the product can be sold. By default the published version becomes the product's default (what a buyer gets when nothing names another one) and a first payment link is created.

Send `{"default": false}` to publish an offer instead: the version is sellable, but only through a payment link created with `productVersionId`. Use it to run a promotional price alongside the standard one without it showing up in your storefront. This only works once the product already has a default version; before that, the response is `422`.




## OpenAPI

````yaml /api-reference/openapi.en.json post /products/{productID}/versions/{versionID}/publish
openapi: 3.1.0
info:
  title: Infi API
  version: 0.0.1
  description: >
    The Infi REST API: catalog, customers, usage metering, subscriptions,

    invoices, payments and checkout.


    **Authentication.** Send your secret key as `Authorization: Bearer
    sk_test_…`

    (sandbox) or `sk_live_…` (production). The key prefix selects the
    environment.

    Checkout routes (`/pay/*`) and `/public/*` take no key: they run in the

    payer's browser.


    **Idempotency.** Every request that changes data requires an

    `Idempotency-Key` header. A retry with the same key returns the original

    response instead of running again.


    **Amounts.** Money and quantities travel as decimal strings (`"150.00"`,

    `"0.0001"`), never as floating-point numbers.


    **Errors.** The body carries `error_code` (stable, branch on it), `message`

    (for humans) and `tracer_id` (send it to support). Rate-limit and
    idempotency

    errors are nested under `error`, with `code` and `request_id`.
servers:
  - url: https://api-sandbox.beinfi.com
    description: Sandbox
  - url: https://api.beinfi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Catalog
  - name: Customers
  - name: Metering
  - name: Subscriptions
  - name: Invoices
  - name: Payments
  - name: Checkout
  - name: Coupons
  - name: Billing
  - name: Account
  - name: Webhooks
  - name: Test account
  - name: Rail
  - name: Storefronts
paths:
  /products/{productID}/versions/{versionID}/publish:
    parameters:
      - $ref: '#/components/parameters/ProductID'
      - $ref: '#/components/parameters/VersionID'
    post:
      tags:
        - Catalog
      summary: Publish a version
      description: >
        Publishes a `draft` version. From here on its pricing is fixed and the
        product can be sold. By default the published version becomes the
        product's default (what a buyer gets when nothing names another one) and
        a first payment link is created.


        Send `{"default": false}` to publish an offer instead: the version is
        sellable, but only through a payment link created with
        `productVersionId`. Use it to run a promotional price alongside the
        standard one without it showing up in your storefront. This only works
        once the product already has a default version; before that, the
        response is `422`.
      operationId: publishVersion
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishVersionRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
          description: The published version.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: '`version_not_draft`: the version is already published.'
        '422':
          $ref: '#/components/responses/ValidationFailed'
components:
  parameters:
    ProductID:
      name: productID
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Product ID.
    VersionID:
      name: versionID
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Product version ID.
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
      description: >-
        A unique key per operation (a UUID works). Retrying with the same key
        returns the original response.
  schemas:
    PublishVersionRequest:
      type: object
      properties:
        default:
          type: boolean
          default: true
          description: >-
            `true` (or omitted) makes this the product's default version.
            `false` publishes it as an offer, sold only by a link that names it.
      description: Optional. With no body, the version is published as the default.
    Version:
      type: object
      properties:
        id:
          type: string
          format: uuid
        productId:
          type: string
          format: uuid
        version:
          type: integer
          description: Sequential version number (1, 2, 3…).
        billingCycle:
          type:
            - string
            - 'null'
          enum:
            - weekly
            - monthly
            - annual
            - null
          description: '`weekly`, `monthly` or `annual`; `null` for non-recurring products.'
        basePrice:
          type:
            - string
            - 'null'
          description: Base price as a decimal string; `null` for a usage-only product.
        status:
          type: string
          enum:
            - draft
            - published
            - archived
          description: >-
            `draft` (editable), `published` (sellable, fixed pricing) or
            `archived`.
        isDefault:
          type: boolean
          description: >-
            Whether this is the version a buyer gets when nothing names another.
            A published version with `isDefault: false` is an offer: it is only
            sold through a payment link created with `productVersionId`.
        publishedAt:
          type:
            - string
            - 'null'
          format: date-time
        commitmentAmount:
          type:
            - string
            - 'null'
          description: >-
            Minimum charged per cycle, as a decimal string; `null` when there is
            none.
        commitmentResets:
          type: boolean
          description: >-
            `true`: the unused minimum is lost at cycle close. `false`: it rolls
            over.
        consumptionFloor:
          type:
            - string
            - 'null'
          description: >-
            Balance below which usage recording is refused. See
            `VersionConsumption.floor`.
        grants:
          type: array
          items:
            $ref: '#/components/schemas/VersionGrant'
          description: Usage credits the version grants.
      description: >-
        A product version: a snapshot of its pricing. A published version never
        changes; to change the price, create another.
    Error:
      type: object
      required:
        - message
        - error_code
        - tracer_id
      properties:
        message:
          type: string
          description: Human-readable sentence.
        error_code:
          $ref: '#/components/schemas/ErrorCode'
          description: Stable error code. Branch on it.
        tracer_id:
          type: string
          description: Request id. Include it when contacting support.
      description: >-
        The standard error body. It is flat (no `error` wrapper) and the trace
        id is `tracer_id`.
    VersionGrant:
      type: object
      required:
        - meter
        - amount
        - 'on'
      properties:
        meter:
          type: string
          description: >-
            The `name` of the meter credited (for example, `tokens`). `credits`
            is the general credits balance.
        amount:
          type: string
          description: Quantity to credit, as a decimal string.
        'on':
          type: string
          enum:
            - cycle
            - payment
          description: >-
            `cycle`: at each new subscription period. `payment`: when the
            payment is confirmed.
      description: A usage credit granted by the version.
    NotFoundError:
      type: object
      required:
        - message
        - error_code
        - tracer_id
        - resource
      properties:
        message:
          type: string
        error_code:
          $ref: '#/components/schemas/ErrorCode'
        tracer_id:
          type: string
        resource:
          type: string
    ErrorCode:
      type: string
      examples:
        - internal_error
        - validation_failed
        - bad_request
        - unauthorized
        - forbidden
        - not_found
        - conflict
        - rate_limited
      description: >-
        Stable error code. The list is open: besides the generic codes, each
        area defines its own (`coupon_expired`, `insufficient_balance`,
        `version_not_draft`, `idempotency_key_reused`…). Handle a code you do
        not recognize by its HTTP status and show `message`; do not fail parsing
        the response.
    ValidationError:
      type: object
      required:
        - message
        - error_code
        - tracer_id
        - errors
      properties:
        message:
          type: string
        error_code:
          $ref: '#/components/schemas/ErrorCode'
        tracer_id:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - value
              - constraint
              - description
            properties:
              field:
                type: string
              value:
                type: string
              constraint:
                type: string
              description:
                type: string
          description: >-
            Per-field detail (`field`, `description`). Always present on a
            `422`; may be empty.
      description: >-
        Body of a `422`. Same shape as `Error`, plus `errors[]` with per-field
        detail. That is where the sentence telling you what to fix lives (for
        example, "product has no published version").
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Missing or invalid API key.
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
      description: Resource not found.
    ValidationFailed:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
      description: One or more fields are invalid. Per-field detail is in `errors[]`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your account's secret key: `Authorization: Bearer sk_test_…` or
        `sk_live_…`. Server-side only.

````