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

# List orders

> Returns a list of orders for the current account



## OpenAPI

````yaml /developer/api-reference/openapi.json get /orders
openapi: 3.1.1
info:
  title: Crevio API V1
  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").
  contact:
    email: support@crevio.co
    name: Crevio Support
    url: https://docs.crevio.co
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.crevio.co/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: Account
    description: Current account information
  - name: BlogCategories
    description: Blog post categories
  - name: BlogPosts
    description: Blog content management
  - name: Carts
    description: Shopping cart management
  - name: CheckoutLinks
    description: Shareable checkout links
  - name: Checkouts
    description: Checkout session management
  - name: Customers
    description: Customer relationship management
  - name: Discounts
    description: Discount code management
  - name: Emails
    description: Email sending
  - name: Experiences
    description: Digital experiences (courses, communities, downloads)
  - name: Files
    description: File uploads and external media management
  - name: FormSubmissions
    description: Form submission management
  - name: Forms
  - name: Invoices
    description: Invoice creation, payment, and lifecycle management
  - name: LegalPages
  - name: Me
    description: Current user profile
  - name: OrderItems
    description: Order line items
  - name: Orders
    description: Order history and details
  - name: PriceVariants
    description: Product pricing tiers
  - name: Products
    description: Digital product catalog
  - name: Refunds
    description: Refund management
  - name: Reviews
    description: Product reviews
  - name: Subscriptions
    description: Subscription lifecycle management (cancel, pause, resume)
  - name: Tags
    description: Customer tags
  - name: TaskRuns
    description: Individual execution records for AI tasks.
  - name: Tasks
    description: >-
      AI tasks — scheduled or event-triggered agentic work (cron, interval,
      once, immediate, event).
  - name: WebhookEndpoints
    description: Webhook endpoint management
  - name: WebhookEvents
    description: Webhook event delivery history
  - name: X402Configuration
    description: x402 payment protocol configuration
paths:
  /orders:
    get:
      tags:
        - Orders
      summary: List orders
      description: Returns a list of orders for the current account
      operationId: listOrders
      parameters:
        - name: status
          in: query
          description: Filter by order status
          schema:
            type: string
            enum:
              - succeeded
              - pending
              - failed
              - refunded
              - partially_refunded
        - name: customer
          in: query
          description: Filter by customer ID
          schema:
            type: string
        - name: processor
          in: query
          description: Filter by payment processor
          schema:
            type: string
        - name: expand
          in: query
          description: 'Comma-separated relations to expand: customer, line_items'
          schema:
            type: string
        - $ref: '#/components/parameters/StartingAfter'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: List of orders
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse_Order'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - ApiKey: []
      x-codeSamples:
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { Crevio } from "@crevio/sdk";

            const crevio = new Crevio({
              apiKey: process.env["CREVIO_API_KEY"] ?? "",
            });

            async function run() {
              const result = await crevio.orders.list({});

              console.log(result);
            }

            run();
components:
  parameters:
    StartingAfter:
      name: starting_after
      in: query
      description: Cursor for pagination — the ID of the last item in the previous page
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: Items per page
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    ListResponse_Order:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Order'
        has_more:
          type: boolean
        url:
          type: string
      required:
        - object
        - data
        - has_more
        - url
    Order:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        status:
          type: string
          enum:
            - succeeded
            - pending
            - failed
            - refunded
            - partially_refunded
            - disputed
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
        amount_refunded:
          type: number
        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
      required:
        - id
        - object
        - status
        - created_at
        - updated_at
        - amount
        - currency
        - amount_refunded
        - customer
        - checkout
    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
          required:
            - type
            - message
      required:
        - error
    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'
        customer_type:
          type: string
          enum:
            - paid
            - free
            - lead
        confirmed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        orders_count:
          type: integer
        total_spend:
          type: number
        tags:
          type: array
      required:
        - id
        - object
        - email
        - name
        - first_name
        - last_name
        - customer_type
        - confirmed_at
        - created_at
        - updated_at
        - orders_count
        - total_spend
        - tags
    OrderItem:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        quantity:
          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
        - price_variant
        - product
    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
        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
        - purchase_url
        - product
    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
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        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
        - created_at
        - updated_at
        - 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
    MediaGalleryItem:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        url:
          type: string
      required:
        - id
        - type
        - url
    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
  responses:
    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
    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.
    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
    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
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key in the format: Bearer {api_token}'

````