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

# List Orders

`GET /v1/orders/`

List orders.

**Scopes**: `orders:read`

## Query parameters

- `organization_id` union — Filter by organization ID.
  - string, uuid4 — The organization ID.
  - string[]
- `product_id` union — Filter by product ID.
  - string, uuid4 — The product ID.
  - string[]
- `product_billing_type` union — Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
  - 'one_time' | 'recurring'
  - ProductBillingType[]
- `discount_id` union — Filter by discount ID.
  - string, uuid4
  - string[]
- `customer_id` union — Filter by customer ID.
  - string, uuid4 — The customer ID.
  - string[]
- `external_customer_id` union — Filter by customer external ID.
  - string — The customer external ID.
  - string[]
- `checkout_id` union — Filter by checkout ID.
  - string, uuid4
  - string[]
- `subscription_id` union — Filter by subscription ID.
  - string, uuid4 — The subscription ID.
  - string[]
- `status` union — Filter by order status.
  - 'draft' | 'pending' | 'paid' | 'refunded' | 'partially_refunded' | 'void'
  - OrderStatus[]
- `created_after` string, date-time, nullable — Only include orders created after this date
- `created_before` string, date-time, nullable — Only include orders created before this date
- `page` integer — Page number, defaults to 1.
- `limit` integer — Size of a page, defaults to 10. Maximum is 100.
- `sorting` OrderSortProperty[], nullable — Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
- `metadata` MetadataQuery, nullable

## Response `200`

Successful Response

- ListResourceOrder
  - `items` Order[], required — unresolved $ref
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/polar/apis/polar-api.md) · [All operations](https://skmtc.net/polar/apis/polar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polar/polar-api/revisions/77e4ef94fcc3/schema)