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

subscriptions

List Subscriptions

get
/v1/subscriptions/
List subscriptions.
sortingquery Parameter
"user" | "-user" | "status" | "-status" | "started_at" | "-started_at" | "current_period_end" | "-current_period_end" | "amount" | "-amount" | "product" | "-product" | "discount" | "-discount"[]
|null
Default: -started_atOptional
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/subscriptions/' \
    -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",
      "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",
      "metadata": {},
      "custom_field_data": {},
      "user": {
        "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",
        "metadata": {},
        "prices": [
          {
            "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"
          }
        ],
        "benefits": [
          {
            "created_at": "2024-12-02T00:00:00.000Z",
            "modified_at": "2024-12-02T00:00:00.000Z",
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "articles",
            "description": "string",
            "selectable": false,
            "deletable": false,
            "organization_id": "00000000-0000-0000-0000-000000000000",
            "properties": {
              "paid_articles": false
            }
          }
        ],
        "medias": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "organization_id": "00000000-0000-0000-0000-000000000000",
            "name": "string",
            "path": "string",
            "mime_type": "string",
            "size": 0,
            "storage_version": "string",
            "checksum_etag": "string",
            "checksum_sha256_base64": "string",
            "checksum_sha256_hex": "string",
            "last_modified_at": "2024-12-02T00:00:00.000Z",
            "version": "string",
            "service": "product_media",
            "is_uploaded": false,
            "created_at": "2024-12-02T00:00:00.000Z",
            "size_readable": "string",
            "public_url": "string"
          }
        ],
        "attached_custom_fields": [
          {
            "custom_field_id": "00000000-0000-0000-0000-000000000000",
            "custom_field": {
              "created_at": "2024-12-02T00:00:00.000Z",
              "modified_at": "2024-12-02T00:00:00.000Z",
              "id": "00000000-0000-0000-0000-000000000000",
              "metadata": {},
              "type": "text",
              "slug": "string",
              "name": "string",
              "organization_id": "00000000-0000-0000-0000-000000000000",
              "properties": {
                "form_label": "string",
                "form_help_text": "string",
                "form_placeholder": "string",
                "textarea": false,
                "min_length": 0,
                "max_length": 0
              }
            },
            "order": 0,
            "required": false
          }
        ]
      },
      "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"
      }
    }
  ],
  "pagination": {
    "total_count": 0,
    "max_page": 0
  }
}