Crevio Checkout Configuration API

openapi: 3.2.0
info:
  title: Crevio API V1 Checkout Configuration API
  version: 1.0.0
  description: 'API for the Crevio creator platform — a multi-tenant SaaS for digital product sales.

    Uses snake_case keys following Stripe conventions. All resource IDs are string IDs (e.g., "prod_abc123").


    Authentication is a bearer token: `Authorization: Bearer $CREVIO_API_KEY`.

    List endpoints are cursor-paginated with `limit` and `starting_after`.

    Writes accept an `Idempotency-Key` header and are safe to retry.


    Every response carries IETF RateLimit headers (`RateLimit`, `RateLimit-Policy`) so a client can

    self-throttle, and `Retry-After` on a 429. The quota is 600 requests per minute per credential.


    The API is versioned in the URL path (`/v1`). Nothing is removed without in-band warning: a

    deprecated operation is marked `"deprecated": true` here and serves `Deprecation` (RFC 9745),

    `Sunset` (RFC 8594) and `Link; rel="deprecation"` headers for at least six months before it

    stops answering. See https://crevio.co/docs/developer/guides/versioning.'
  contact:
    email: support@crevio.co
    name: Crevio Support
    url: https://crevio.co/docs
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://crevio.co/legal/terms-of-service
servers:
- url: https://api.crevio.co/v1
  description: Production
security:
- ApiKey: []
tags:
- name: CheckoutConfiguration
  description: Account-wide checkout settings
paths:
  /checkout_configuration:
    get:
      summary: Get checkout configuration
      description: 'Returns the account-wide checkout settings: country allow-list, tax collection, discount codes, the phone / shipping address / tax ID fields shown at checkout, quantity selection, and the post-purchase success URL. Read it before changing anything — omitted fields keep their current value on update.'
      operationId: getCheckoutConfiguration
      x-crevio-sdk-method: get
      tags:
      - CheckoutConfiguration
      security:
      - ApiKey: []
      responses:
        '200':
          description: Checkout configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutConfiguration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: allow
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.checkoutConfiguration.get();\n\n  console.log(result);\n}\n\nrun();"
    patch:
      summary: Update checkout configuration
      description: Partially updates the account-wide checkout settings; only the fields sent change. `allowed_countries` is an allow-list of ISO 3166-1 alpha-2 codes (`["US", "CA"]` lets only US and Canadian buyers through) — send `[]` to lift the restriction, never the full list of countries. `success_url` must be a full https:// URL; send `null` or `""` to restore the default thank-you page. Saving expires every open checkout session and re-syncs the account's Stripe Tax settings.
      operationId: updateCheckoutConfiguration
      x-crevio-sdk-method: update
      tags:
      - CheckoutConfiguration
      security:
      - ApiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutConfigurationRequest'
      responses:
        '200':
          description: Checkout configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutConfiguration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: allow
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.checkoutConfiguration.update({});\n\n  console.log(result);\n}\n\nrun();"
components:
  responses:
    TooManyRequests:
      description: 'Rate limit exceeded — 600 requests per minute per owner on the free tier: every API key and OAuth token one person holds on an account shares one budget, and the account''s team keys share another. Retry after the number of seconds in `Retry-After`.'
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: rate_limit_exceeded
              message: Too many requests. Please retry later.
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: forbidden
              message: You do not have permission to perform this action
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: api_error
              code: internal_error
              message: An unexpected error occurred
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: bad_request
              message: The request was malformed or contained invalid parameters
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: authentication_required
              message: You did not provide an API key.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    UnprocessableEntity:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: validation_error
              code: validation_failed
              message: Email is required
              errors:
                email:
                - can't be blank
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        examples:
        - 11
    Sunset:
      description: Present only on a deprecated operation. HTTP-date (RFC 8594) after which the operation stops responding. Always at least six months after `Deprecation`.
      schema:
        type: string
        examples:
        - Thu, 01 Oct 2026 00:00:00 GMT
    RateLimit:
      description: 'Remaining quota for the current window, as an IETF structured field: `"default";r=<remaining>;t=<seconds until reset>`.'
      schema:
        type: string
        examples:
        - '"default";r=596;t=11'
    RateLimitPolicy:
      description: 'The quota this credential is subject to: `"default";q=<requests>;w=<window seconds>`.'
      schema:
        type: string
        examples:
        - '"default";q=600;w=60'
    RequestId:
      description: Unique id for this request. Quote it when reporting a problem.
      schema:
        type: string
        examples:
        - 8fe045fe-cb8a-4407-a44d-5df60385e522
    DeprecationLink:
      description: Present only on a deprecated operation. `<url>; rel="deprecation"` pointing at the migration notes.
      schema:
        type: string
        examples:
        - <https://crevio.co/docs/developer/guides/versioning>; rel="deprecation"
    Deprecation:
      description: Present only on a deprecated operation. Structured-field date (RFC 9745) — `@` followed by the Unix timestamp at which the operation became deprecated.
      schema:
        type: string
        examples:
        - '@1775001600'
  schemas:
    CheckoutConfigurationRequest:
      type: object
      properties:
        success_url:
          type:
          - string
          - 'null'
          description: Full https:// URL buyers land on after paying. Pass null or "" to restore the default thank-you page.
        collect_tax:
          type: boolean
          description: Collect tax at checkout via Stripe Tax.
        tax_behavior:
          type: string
          enum:
          - unspecified
          - inclusive
          - exclusive
          description: Whether prices include tax (inclusive) or tax is added on top (exclusive).
        allow_discount_codes:
          type: boolean
        show_tax_id_input:
          type: boolean
        show_phone_number_input:
          type: boolean
        collect_call_consent:
          type: boolean
        collect_shipping_address:
          type: boolean
        allow_multiple_quantity:
          type:
          - boolean
          - 'null'
        abandoned_checkout_emails:
          type: boolean
        abandoned_checkout_email_delay_hours:
          type: integer
        cancellation_message:
          type:
          - string
          - 'null'
        cancellation_pause_max_intervals:
          type:
          - integer
          - 'null'
        cancellation_discount:
          type:
          - string
          - 'null'
          description: Cancellation discount ID
        allowed_countries:
          type: array
          items:
            type: string
          description: Allow-list of ISO 3166-1 alpha-2 country codes (e.g. ["DE", "AT"]); buyers outside it are blocked at checkout. Case-insensitive. Pass [] to allow every country.
        cancellation_reasons:
          type: array
          items:
            type: string
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - api_error
              - invalid_request_error
              - validation_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            errors:
              type: object
            doc_url:
              type: string
          required:
          - type
          - message
      required:
      - error
    CheckoutConfiguration:
      type: object
      properties:
        object:
          type: string
        allowed_countries:
          type: array
          items:
            type: string
          description: ISO 3166-1 alpha-2 allow-list; empty means every country can check out.
        collect_tax:
          type: boolean
        tax_behavior:
          type: string
          enum:
          - unspecified
          - inclusive
          - exclusive
        tax_code:
          type: string
        allow_discount_codes:
          type: boolean
        show_tax_id_input:
          type: boolean
        show_phone_number_input:
          type: boolean
        collect_call_consent:
          type: boolean
        collect_shipping_address:
          type: boolean
        abandoned_checkout_emails:
          type: boolean
        abandoned_checkout_email_delay_hours:
          type: integer
        allow_multiple_quantity:
          type: boolean
        cancellation_reasons:
          type: array
          items:
            type: string
            enum:
            - too_expensive
            - missing_features
            - switched_service
            - unused
            - customer_service
            - too_complex
            - low_quality
            - other
        cancellation_message:
          type:
          - string
          - 'null'
        cancellation_pause_max_intervals:
          type:
          - integer
          - 'null'
        cancellation_discount:
          type:
          - string
          - 'null'
        success_url:
          type:
          - string
          - 'null'
      required:
      - object
      - allowed_countries
      - collect_tax
      - tax_behavior
      - tax_code
      - allow_discount_codes
      - show_tax_id_input
      - show_phone_number_input
      - collect_call_consent
      - collect_shipping_address
      - abandoned_checkout_emails
      - abandoned_checkout_email_delay_hours
      - allow_multiple_quantity
      - cancellation_reasons
      - cancellation_message
      - cancellation_pause_max_intervals
      - cancellation_discount
      - success_url
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key in the format: Bearer {api_token}'
externalDocs:
  description: Crevio developer documentation
  url: https://crevio.co/docs/developer
x-mint:
  mcp:
    enabled: true
x-api-lifecycle:
  current_major_version: v1
  versioning_scheme: URL path
  deprecation_policy_url: https://crevio.co/docs/developer/guides/versioning
  minimum_notice_days: 183
  deprecation_headers:
  - Deprecation
  - Sunset
  - Link