---
title: "List orders"
method: GET
path: "/orders"
tags: ["Orders"]
---

# List orders

`GET /orders`

## Request

- Base URL: `https://api.crevio.co/v1`
- URL: `https://api.crevio.co/v1/orders`
- Auth: API key in header `Authorization`

Returns a list of orders for the current account

## Query parameters

- `status` 'succeeded' | 'pending' | 'failed' | 'refunded' | 'partially_refunded'
- `customer` string
- `processor` string
- `expand` string
- `starting_after` string
- `limit` integer
- `metadata` object

## Response `200`

List of orders

- ListResponseOrder
  - `object` 'list', required
  - `data` Order[], required
    - `id` string, required
    - `object` string, required
    - `status` 'succeeded' | 'pending' | 'failed' | 'refunded' | 'partially_refunded' | 'disputed', required
    - `livemode` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `metadata` object, nullable, required
    - `amount` integer, required: Amount charged after discounts, in the smallest currency unit (79 = $0.79).
    - `currency` string, required
    - `amount_refunded` integer, required: Amount refunded so far, in the smallest currency unit.
    - `customer` union, required: ID by default, full object when expanded
      - string
      - Customer
        - `id` string, required
        - `object` string, required
        - `email` string, required
        - `name` string, nullable, required
        - `first_name` string, nullable, required
        - `last_name` string, nullable, required
        - `phone_number` string, nullable, required
        - `customer_type` 'paid' | 'free' | 'lead', required
        - `notes` string, nullable, required
        - `confirmed_at` string, date-time, nullable, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
        - `deleted_at` string, date-time, nullable, required
        - `purge_at` string, nullable, required
        - `anonymized` boolean, required
        - `metadata` object, required
        - `orders_count` integer, required
        - `total_spend` number, required
        - `tags` unknown[], required
          - unknown
    - `line_items` OrderItem[]
      - `id` string, required
      - `object` string, required
      - `quantity` integer, required
      - `order` union: ID by default, full object when expanded
        - string
        - Order (recursive)
      - `price_variant` union, required: ID by default, full object when expanded
        - string
        - PriceVariant
          - `id` string, required
          - `object` string, required
          - `name` string, required
          - `amount` integer, nullable, required
          - `amount_type` 'free' | 'fixed' | 'custom', required
          - `billing_type` 'subscription' | 'one_time' | 'payment_plan', required
          - `recurring_interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable, required
          - `interval_count` integer, required
          - `installment_count` integer, nullable, required
          - `setup_fee_amount` integer, nullable, required
          - `trial_period_days` integer, nullable, required
          - `revoke_after_days` integer, nullable, required
          - `quantity_available` integer, nullable, required
          - `archived` boolean, nullable, required
          - `position` integer, required
          - `hidden` boolean, nullable, required
          - `created_at` string, date-time, required
          - `updated_at` string, date-time, required
          - `currency` string, nullable, required
          - `discounted_from_amount` integer, nullable, required
          - `minimum_amount` integer, nullable, required
          - `maximum_amount` integer, nullable, required
          - `preset_amount` integer, nullable, required
          - `waitlist` boolean, required
          - `benefits` string[]
          - `purchase_url` string, required
          - `product` string, required
      - `product` union, required: ID by default, full object when expanded
        - string
        - Product
          - `id` string, required
          - `object` string, required
          - `name` string, required
          - `slug` string, required
          - `status` 'draft' | 'active' | 'archived', required
          - `description` string, required
          - `created_at` string, date-time, required
          - `updated_at` string, date-time, required
          - `metadata` object, required
          - `body_html` string, required
          - `button_cta` string, nullable, required
          - `url` string, required
          - `available_from` string, date-time, nullable, required
          - `available_until` string, date-time, nullable, required
          - `published_at` string, date-time, nullable, required
          - `reviews_count` integer, required
          - `average_rating` number, nullable, required
          - `seo` union: ID by default, full object when expanded
            - string
            - Seo
              - …
          - `media_gallery` MediaGalleryItem[], required
            - `id` string, required
            - `type` string, required
            - `category` 'image' | 'video' | 'external', required
            - `url` string, required
          - `price_variants` PriceVariant[], required
            - `id` string, required
            - `object` string, required
            - `name` string, required
            - `amount` integer, nullable, required
            - `amount_type` 'free' | 'fixed' | 'custom', required
            - `billing_type` 'subscription' | 'one_time' | 'payment_plan', required
            - `recurring_interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable, required
            - `interval_count` integer, required
            - `installment_count` integer, nullable, required
            - `setup_fee_amount` integer, nullable, required
            - `trial_period_days` integer, nullable, required
            - `revoke_after_days` integer, nullable, required
            - `quantity_available` integer, nullable, required
            - `archived` boolean, nullable, required
            - `position` integer, required
            - `hidden` boolean, nullable, required
            - `created_at` string, date-time, required
            - `updated_at` string, date-time, required
            - `currency` string, nullable, required
            - `discounted_from_amount` integer, nullable, required
            - `minimum_amount` integer, nullable, required
            - `maximum_amount` integer, nullable, required
            - `preset_amount` integer, nullable, required
            - `waitlist` boolean, required
            - `benefits` string[]
            - `purchase_url` string, required
            - `product` string, required
          - `reviews` Review[]
            - `id` string, required
            - `object` string, required
            - `rating` integer, required
            - `customer_name` string, nullable, required
            - `content` string, nullable, required
            - `created_at` string, date-time, required
            - `customer_image_url` string, nullable, required
    - `checkout` string, required
    - `billing_address` Address, required
      - `name` string, nullable, required
      - `line1` string, nullable, required
      - `line2` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postal_code` string, nullable, required
      - `country` string, nullable, required
    - `shipping_address` Address, required
      - `name` string, nullable, required
      - `line1` string, nullable, required
      - `line2` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postal_code` string, nullable, required
      - `country` string, nullable, required
    - `charge` string, nullable, required
  - `has_more` boolean, required
  - `url` string, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `429`: Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`.
- `500`: Internal server error

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)