POpolar
orders
public

List Orders

Changed on

List orders.

Scopes: orders:read

get/v1/orders/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/orders/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: orders:read)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737
string uuid4

The product ID.

OR
string[]
'one_time' | 'recurring'
OR
ProductBillingType[]
string uuid4
OR
string[]
string uuid4

The customer ID.

OR
string[]
string

The customer external ID.

OR
string[]
string uuid4
OR
string[]
string uuid4

The subscription ID.

OR
string[]
'draft' | 'pending' | 'paid' | 'refunded' | 'partially_refunded' | 'void'
OR
OrderStatus[]
created_afterstring date-time nullable

Only include orders created after this date

created_beforestring date-time nullable

Only include orders created before this date

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingOrderSortProperty[] 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.

metadataMetadataQuery nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response

itemsOrder[] required(unresolved $ref)

Changes

  • 77e4ef94fcc3Revision changes
    • warning

      added the new subscription_meter_cycle enum value to the // response property for the response status

  • f9688fd328d6Revision changes
    • info

      added the required property /// to the response with the status