Documentation

Developers

Featured Endpoints

Checkouts

Discounts

License Keys

Oauth2

Organizations

Products

Users

Issue Funding Endpoints

External Organizations

Repositories

Other Endpoints

Advertisements

Articles

Benefits

Checkout-Links

Checkouts

Custom-Fields

Files

Metrics

Oauth2

Orders

Subscriptions

Users

orders

List Orders

get
/v1/orders/
List orders.
Filter by product price type. recurring will return orders corresponding to subscriptions creations or renewals. one_time will return orders corresponding to one-time purchases.
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.
curl -X GET \
    'https://api.polar.sh/v1/orders/' \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
    
Responses
{
  "items": [
    {
      "created_at": "2024-12-02T00:00:00.000Z",
      "modified_at": "2024-12-02T00:00:00.000Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "metadata": {},
      "custom_field_data": {},
      "amount": 0,
      "tax_amount": 0,
      "currency": "string",
      "billing_reason": "purchase",
      "billing_address": {
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "city": "string",
        "state": "string",
        "country": "string"
      },
      "user_id": "00000000-0000-0000-0000-000000000000",
      "product_id": "00000000-0000-0000-0000-000000000000",
      "product_price_id": "00000000-0000-0000-0000-000000000000",
      "discount_id": "00000000-0000-0000-0000-000000000000",
      "subscription_id": "00000000-0000-0000-0000-000000000000",
      "checkout_id": "00000000-0000-0000-0000-000000000000",
      "user": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "string",
        "public_name": "string",
        "github_username": "string",
        "avatar_url": "string"
      },
      "product": {
        "created_at": "2024-12-02T00:00:00.000Z",
        "modified_at": "2024-12-02T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "description": "string",
        "is_recurring": false,
        "is_archived": false,
        "organization_id": "00000000-0000-0000-0000-000000000000"
      },
      "product_price": {
        "created_at": "2024-12-02T00:00:00.000Z",
        "modified_at": "2024-12-02T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "amount_type": "fixed",
        "is_archived": false,
        "product_id": "00000000-0000-0000-0000-000000000000",
        "price_currency": "string",
        "price_amount": 0,
        "type": "recurring",
        "recurring_interval": "month"
      },
      "discount": {
        "duration": "once",
        "type": "fixed",
        "amount": 0,
        "currency": "string",
        "created_at": "2024-12-02T00:00:00.000Z",
        "modified_at": "2024-12-02T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "metadata": {},
        "name": "string",
        "code": "string",
        "starts_at": "2024-12-02T00:00:00.000Z",
        "ends_at": "2024-12-02T00:00:00.000Z",
        "max_redemptions": 0,
        "redemptions_count": 0,
        "organization_id": "00000000-0000-0000-0000-000000000000"
      },
      "subscription": {
        "metadata": {},
        "created_at": "2024-12-02T00:00:00.000Z",
        "modified_at": "2024-12-02T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "amount": 0,
        "currency": "string",
        "recurring_interval": "month",
        "status": "incomplete",
        "current_period_start": "2024-12-02T00:00:00.000Z",
        "current_period_end": "2024-12-02T00:00:00.000Z",
        "cancel_at_period_end": false,
        "started_at": "2024-12-02T00:00:00.000Z",
        "ended_at": "2024-12-02T00:00:00.000Z",
        "user_id": "00000000-0000-0000-0000-000000000000",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "price_id": "00000000-0000-0000-0000-000000000000",
        "discount_id": "00000000-0000-0000-0000-000000000000",
        "checkout_id": "00000000-0000-0000-0000-000000000000"
      }
    }
  ],
  "pagination": {
    "total_count": 0,
    "max_page": 0
  }
}