Crevio Order Items API

openapi: 3.2.0
info:
  title: Crevio API V1 Order Items 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: Order Items
  description: Order line items
paths:
  /order_items/{id}:
    get:
      summary: Get order item
      description: Returns details of a specific order item
      operationId: getOrderItem
      x-crevio-sdk-method: get
      tags:
      - Order Items
      security:
      - ApiKey: []
      parameters:
      - name: id
        in: path
        required: true
        description: The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")
        schema:
          type: string
      - name: expand
        in: query
        description: 'Comma-separated relations to expand: order, price_variant, product'
        schema:
          type: string
      responses:
        '200':
          description: Order item details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '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.orderItems.get({\n    id: \"<id>\",\n  });\n\n  console.log(result);\n}\n\nrun();"
  /orders/{order_id}/order_items:
    get:
      summary: List order items
      description: Returns order items for a specific order
      operationId: listOrderItems
      x-crevio-sdk-method: list
      tags:
      - Order Items
      security:
      - ApiKey: []
      parameters:
      - name: order_id
        in: path
        required: true
        description: The order ID
        schema:
          type: string
      - name: starting_after
        in: query
        description: Cursor for pagination — the ID of the last item in the previous page
        schema:
          type: string
      - name: limit
        in: query
        description: Items per page
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      responses:
        '200':
          description: List of order items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse_OrderItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '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.orderItems.list({\n    orderId: \"<id>\",\n  });\n\n  console.log(result);\n}\n\nrun();"
components:
  responses:
    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'
    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'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: resource_missing
              message: The requested resource was not found
      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'
    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.
    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'
  schemas:
    Product:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        name:
          type: string
        slug:
          type: string
        status:
          type: string
          enum:
          - draft
          - active
          - archived
        description:
          type: string
        confirmation_message:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        metadata:
          type: object
        body_html:
          type: string
        button_cta:
          type:
          - string
          - 'null'
        url:
          type: string
        available_from:
          type:
          - string
          - 'null'
          format: date-time
        available_until:
          type:
          - string
          - 'null'
          format: date-time
        published_at:
          type:
          - string
          - 'null'
          format: date-time
        reviews_count:
          type: integer
        average_rating:
          type:
          - number
          - 'null'
        seo:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Seo'
          - type: 'null'
          description: ID by default, full object when expanded
        media_gallery:
          type: array
          items:
            $ref: '#/components/schemas/MediaGalleryItem'
        price_variants:
          type: array
          items:
            $ref: '#/components/schemas/PriceVariant'
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/Review'
      required:
      - id
      - object
      - name
      - slug
      - status
      - description
      - confirmation_message
      - created_at
      - updated_at
      - metadata
      - body_html
      - button_cta
      - url
      - available_from
      - available_until
      - published_at
      - reviews_count
      - average_rating
      - media_gallery
      - price_variants
    Seo:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
      required:
      - title
      - description
    Customer:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        email:
          type: string
        name:
          type:
          - string
          - 'null'
        first_name:
          type:
          - string
          - 'null'
        last_name:
          type:
          - string
          - 'null'
        phone_number:
          type:
          - string
          - 'null'
        customer_type:
          type: string
          enum:
          - paid
          - free
          - lead
        notes:
          type:
          - string
          - 'null'
        confirmed_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        deleted_at:
          type:
          - string
          - 'null'
          format: date-time
        purge_at:
          type:
          - string
          - 'null'
        anonymized:
          type: boolean
        metadata:
          type: object
        orders_count:
          type: integer
        total_spend:
          type: number
        tags:
          type: array
      required:
      - id
      - object
      - email
      - name
      - first_name
      - last_name
      - phone_number
      - customer_type
      - notes
      - confirmed_at
      - created_at
      - updated_at
      - deleted_at
      - purge_at
      - anonymized
      - metadata
      - orders_count
      - total_spend
      - tags
    Review:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        rating:
          type: integer
        customer_name:
          type:
          - string
          - 'null'
        content:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        customer_image_url:
          type:
          - string
          - 'null'
      required:
      - id
      - object
      - rating
      - customer_name
      - content
      - created_at
      - customer_image_url
    PriceVariant:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        name:
          type: string
        amount:
          type:
          - integer
          - 'null'
        amount_type:
          type: string
          enum:
          - free
          - fixed
          - custom
        billing_type:
          type: string
          enum:
          - subscription
          - one_time
          - payment_plan
        recurring_interval:
          type:
          - string
          - 'null'
          enum:
          - day
          - week
          - month
          - year
          - null
        interval_count:
          type: integer
        installment_count:
          type:
          - integer
          - 'null'
        setup_fee_amount:
          type:
          - integer
          - 'null'
        trial_period_days:
          type:
          - integer
          - 'null'
        revoke_after_days:
          type:
          - integer
          - 'null'
        quantity_available:
          type:
          - integer
          - 'null'
        archived:
          type:
          - boolean
          - 'null'
        position:
          type: integer
        hidden:
          type:
          - boolean
          - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        currency:
          type:
          - string
          - 'null'
        discounted_from_amount:
          type:
          - integer
          - 'null'
        minimum_amount:
          type:
          - integer
          - 'null'
        maximum_amount:
          type:
          - integer
          - 'null'
        preset_amount:
          type:
          - integer
          - 'null'
        waitlist:
          type: boolean
        form_id:
          type:
          - string
          - 'null'
          description: The form (`form_...`) asked at every checkout of this variant, including waitlist applications. Its answers become a form submission on the order or waitlist entry.
        benefits:
          type: array
          items:
            type: string
        purchase_url:
          type: string
        product:
          type: string
      required:
      - id
      - object
      - name
      - amount
      - amount_type
      - billing_type
      - recurring_interval
      - interval_count
      - installment_count
      - setup_fee_amount
      - trial_period_days
      - revoke_after_days
      - quantity_available
      - archived
      - position
      - hidden
      - created_at
      - updated_at
      - currency
      - discounted_from_amount
      - minimum_amount
      - maximum_amount
      - preset_amount
      - waitlist
      - form_id
      - purchase_url
      - product
    Address:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        line1:
          type:
          - string
          - 'null'
        line2:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        postal_code:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
      required:
      - name
      - line1
      - line2
      - city
      - state
      - postal_code
      - country
    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
    MediaGalleryItem:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        category:
          type: string
          enum:
          - image
          - video
          - external
        url:
          type: string
      required:
      - id
      - type
      - category
      - url
    OrderItem:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        quantity:
          type: integer
        amount:
          type: integer
        order:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Order'
          - type: 'null'
          description: ID by default, full object when expanded
        price_variant:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/PriceVariant'
          - type: 'null'
          description: ID by default, full object when expanded
        product:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Product'
          - type: 'null'
          description: ID by default, full object when expanded
      required:
      - id
      - object
      - quantity
      - amount
      - price_variant
      - product
    Order:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        status:
          type: string
          enum:
          - succeeded
          - pending
          - failed
          - refunded
          - partially_refunded
          - disputed
        livemode:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        metadata:
          type:
          - object
          - 'null'
        amount:
          type: integer
          description: Amount charged after discounts, in the smallest currency unit (79 = $0.79).
        currency:
          type: string
        amount_refunded:
          type: integer
          description: Amount refunded so far, in the smallest currency unit.
        customer:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Customer'
          - type: 'null'
          description: ID by default, full object when expanded
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
        checkout:
          type:
          - string
          - 'null'
          description: Null for a renewal, which no checkout started.
        billing_reason:
          type:
          - string
          - 'null'
          description: 'As Stripe names the invoice: `subscription_create` for the purchase that started a subscription, `subscription_cycle` for each paid renewal after it. Null for a one-time purchase.'
          enum:
          - subscription_create
          - subscription_cycle
          - null
        subscription:
          type:
          - string
          - 'null'
          description: The subscription this order started or renewed.
        billing_address:
          oneOf:
          - $ref: '#/components/schemas/Address'
          - type: 'null'
        shipping_address:
          oneOf:
          - $ref: '#/components/schemas/Address'
          - type: 'null'
        charge:
          type:
          - string
          - 'null'
        form_submissions:
          type: array
          items:
            $ref: '#/components/schemas/FormSubmission'
          description: The buyer's answers to the price variant's form at checkout.
      required:
      - id
      - object
      - status
      - livemode
      - created_at
      - updated_at
      - metadata
      - amount
      - currency
      - amount_refunded
      - customer
      - checkout
      - billing_reason
      - subscription
      - billing_address
      - shipping_address
      - charge
      - form_submissions
    FormSubmission:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        answers:
          type: array
          items:
            type: object
            properties:
              field_type:
                type: string
              label:
                type: string
              required:
                type: boolean
              value:
                oneOf:
                - type: string
                - type: array
                  items:
                    type: string
                - type: boolean
                - type: 'null'
                description: A `consent` answer is `true` when the person ticked it.
              options:
                type: array
                items:
                  type: string
            required:
            - field_type
            - label
            - required
            - value
        respondent_type:
          type: string
        confirmation_requested_at:
          type:
          - string
          - 'null'
          format: date-time
        confirmed_at:
          type:
          - string
          - 'null'
          format: date-time
        delivered_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        respondent_id:
          type: string
        form_id:
          type: string
      required:
      - id
      - object
      - answers
      - respondent_type
      - confirmation_requested_at
      - confirmed_at
      - delivered_at
      - created_at
      - respondent_id
      - form_id
    ListResponse_OrderItem:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
        has_more:
          type: boolean
        url:
          type: string
      required:
      - object
      - data
      - has_more
      - url
  headers:
    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
    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"
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        examples:
        - 11
    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'
    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'
  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