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

# Create billing checkout session



## OpenAPI

````yaml api-reference/openapi.json POST /orgs/{orgID}/billing/checkout-sessions
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /orgs/{orgID}/billing/checkout-sessions:
    post:
      tags:
        - billing
      summary: Create billing checkout session
      operationId: createBillingCheckoutSession
      parameters:
        - in: path
          name: orgID
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              discriminator:
                mapping:
                  credit_pack: >-
                    #/components/schemas/CreateBillingCreditPackCheckoutSessionRequest
                  inference_topup: >-
                    #/components/schemas/CreateBillingInferenceTopUpCheckoutSessionRequest
                  subscription: >-
                    #/components/schemas/CreateBillingSubscriptionCheckoutSessionRequest
                propertyName: checkout_type
              oneOf:
                - $ref: >-
                    #/components/schemas/CreateBillingSubscriptionCheckoutSessionRequest
                - $ref: >-
                    #/components/schemas/CreateBillingCreditPackCheckoutSessionRequest
                - $ref: >-
                    #/components/schemas/CreateBillingInferenceTopUpCheckoutSessionRequest
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                discriminator:
                  mapping:
                    credit_pack: '#/components/schemas/BillingCreditPackCheckoutSession'
                    inference_topup: '#/components/schemas/BillingInferenceTopUpCheckoutSession'
                    subscription: '#/components/schemas/BillingSubscriptionCheckoutSession'
                  propertyName: checkout_type
                oneOf:
                  - $ref: '#/components/schemas/BillingSubscriptionCheckoutSession'
                  - $ref: '#/components/schemas/BillingCreditPackCheckoutSession'
                  - $ref: '#/components/schemas/BillingInferenceTopUpCheckoutSession'
          description: Created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/BillingErrorResponse'
                  - $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingErrorResponse'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingErrorResponse'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingErrorResponse'
          description: Internal Server Error
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingErrorResponse'
          description: Bad Gateway
components:
  schemas:
    CreateBillingCreditPackCheckoutSessionRequest:
      additionalProperties: false
      properties:
        checkout_type:
          enum:
            - credit_pack
          type: string
        credit_pack_id:
          enum:
            - credits_100
            - credits_250
            - credits_500
            - credits_1000
          type: string
        return_path:
          description: >-
            Where the hosted checkout returns. Required on the web; refused on
            ios and android.
          maxLength: 500
          pattern: >-
            ^/(?:(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)/)*(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)?$
          type: string
        surface:
          description: >-
            The client purchasing: web opens a Stripe hosted checkout; ios and
            android create a store purchase intent.
          enum:
            - web
            - ios
            - android
          type: string
      required:
        - checkout_type
        - surface
        - credit_pack_id
      type: object
    CreateBillingInferenceTopUpCheckoutSessionRequest:
      additionalProperties: false
      properties:
        amount_usd:
          description: >-
            Any whole-cent amount within the bounds on the web; one of
            top_up_skus' amounts on ios and android.
          format: double
          maximum: 5000
          minimum: 5
          type: number
        checkout_type:
          enum:
            - inference_topup
          type: string
        return_path:
          description: >-
            Where the hosted checkout returns. Required on the web; refused on
            ios and android.
          maxLength: 500
          pattern: >-
            ^/(?:(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)/)*(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)?$
          type: string
        surface:
          description: >-
            The client purchasing: web opens a Stripe hosted checkout; ios and
            android create a store purchase intent.
          enum:
            - web
            - ios
            - android
          type: string
      required:
        - checkout_type
        - surface
        - amount_usd
      type: object
    CreateBillingSubscriptionCheckoutSessionRequest:
      additionalProperties: false
      properties:
        checkout_type:
          enum:
            - subscription
          type: string
        return_path:
          description: >-
            Where the hosted checkout returns. Required on the web; refused on
            ios and android.
          maxLength: 500
          pattern: >-
            ^/(?:(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)/)*(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)?$
          type: string
        surface:
          description: >-
            The client purchasing: web opens a Stripe hosted checkout; ios and
            android create a store purchase intent.
          enum:
            - web
            - ios
            - android
          type: string
        tier:
          enum:
            - starter
            - pro
            - max
            - team
          type: string
      required:
        - checkout_type
        - surface
        - tier
      type: object
    BillingCreditPackCheckoutSession:
      additionalProperties: false
      properties:
        amount_usd:
          format: double
          type: number
        checkout_session_id:
          format: uuid
          type: string
        checkout_session_token:
          pattern: ^pcs_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        checkout_type:
          enum:
            - credit_pack
          type: string
        claimed_store_purchase:
          description: >-
            Present and true when binding the store transaction claimed the
            purchase the store had already reported: the intent completed and
            granted from it.
          type: boolean
        credit_pack_id:
          enum:
            - credits_100
            - credits_250
            - credits_500
            - credits_1000
          type: string
        credits:
          format: int64
          type: integer
        purchase_status:
          enum:
            - failed
            - granted
            - pending
            - pending_grant
          type: string
        status:
          enum:
            - created
            - completed
            - expired
            - failed
          type: string
        store_app_user_id:
          description: >-
            The store identity the device buys as. Present only when a store
            purchase intent is created.
          format: uuid
          type: string
        store_product_id:
          description: >-
            The store product the device buys. Present only when a store
            purchase intent is created.
          type: string
        url:
          description: >-
            The Stripe hosted checkout to open. Absent for a store purchase
            intent.
          type: string
      required:
        - checkout_session_id
        - checkout_session_token
        - checkout_type
        - status
        - purchase_status
        - credit_pack_id
        - credits
        - amount_usd
      type: object
    BillingInferenceTopUpCheckoutSession:
      additionalProperties: false
      properties:
        amount_usd:
          format: double
          type: number
        checkout_session_id:
          format: uuid
          type: string
        checkout_session_token:
          pattern: ^pcs_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        checkout_type:
          enum:
            - inference_topup
          type: string
        claimed_store_purchase:
          description: >-
            Present and true when binding the store transaction claimed the
            purchase the store had already reported: the intent completed and
            granted from it.
          type: boolean
        fee_usd:
          format: double
          type: number
        purchase_status:
          enum:
            - failed
            - granted
            - pending
            - pending_grant
          type: string
        status:
          enum:
            - created
            - completed
            - expired
            - failed
          type: string
        store_app_user_id:
          description: >-
            The store identity the device buys as. Present only when a store
            purchase intent is created.
          format: uuid
          type: string
        store_product_id:
          description: >-
            The store product the device buys. Present only when a store
            purchase intent is created.
          type: string
        url:
          description: >-
            The Stripe hosted checkout to open. Absent for a store purchase
            intent.
          type: string
      required:
        - checkout_session_id
        - checkout_session_token
        - checkout_type
        - status
        - purchase_status
        - amount_usd
        - fee_usd
      type: object
    BillingSubscriptionCheckoutSession:
      additionalProperties: false
      properties:
        checkout_session_id:
          format: uuid
          type: string
        checkout_session_token:
          pattern: ^pcs_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        checkout_type:
          enum:
            - subscription
          type: string
        claimed_store_purchase:
          description: >-
            Present and true when binding the store transaction claimed the
            purchase the store had already reported: the intent completed and
            granted from it.
          type: boolean
        status:
          enum:
            - created
            - completed
            - expired
            - failed
          type: string
        store_app_user_id:
          description: >-
            The store identity the device buys as. Present only when a store
            purchase intent is created.
          format: uuid
          type: string
        store_product_id:
          description: >-
            The store product the device buys. Present only when a store
            purchase intent is created.
          type: string
        subscription_status:
          enum:
            - active
            - failed
            - pending
            - pending_webhook
          type: string
        target_tier:
          enum:
            - starter
            - pro
            - max
            - team
          type: string
        url:
          description: >-
            The Stripe hosted checkout to open. Absent for a store purchase
            intent.
          type: string
      required:
        - checkout_session_id
        - checkout_session_token
        - checkout_type
        - status
        - target_tier
        - subscription_status
      type: object
    BillingErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - bad_gateway
            - bad_request
            - checkout_pending
            - conflict
            - enterprise_invoice
            - forbidden
            - free_tier
            - gateway_timeout
            - gone
            - internal_error
            - invalid_surface
            - managed_elsewhere
            - method_not_allowed
            - no_billing_history
            - not_acceptable
            - not_found
            - not_implemented
            - payment_delinquent
            - payment_required
            - personal_org_requires_personal_plan
            - precondition_failed
            - provider_unavailable
            - rate_limited
            - request_canceled
            - request_timeout
            - request_too_large
            - requires_org_admin
            - service_unavailable
            - subscription_active
            - subscription_pending
            - team_org_requires_team_plan
            - team_plan_web_only
            - team_seats_via_membership
            - unauthenticated
            - unsupported_media_type
            - validation_failed
            - warm_slot_occupied
            - web_only
          minLength: 1
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
        - code
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
            - agent_host_route_not_allowed
            - credential_kind_not_admitted
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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