POpolar
subscriptions
public

List Subscriptions

Changed on

List subscriptions.

Scopes: subscriptions:read subscriptions:write

get/v1/subscriptions/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/subscriptions/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: subscriptions:read, subscriptions:write)
    • 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[]
string uuid4

The customer ID.

OR
string[]
string

The customer external ID.

OR
string[]
string uuid4

The discount ID.

OR
string[]
activeboolean nullable

Filter by active or inactive subscription.

'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused'
OR
SubscriptionStatus[]
cancel_at_period_endboolean nullable

Filter by subscriptions that are set to cancel at period end.

'customer_service' | 'low_quality' | 'missing_features' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused' | 'other'
OR
CustomerCancellationReason[]
canceled_at_afterstring date-time nullable

Filter by cancellation date (after or equal to).

canceled_at_beforestring date-time nullable

Filter by cancellation date (before or equal to).

started_afterstring date-time nullable

Only include subscriptions started after this date.

started_beforestring date-time nullable

Only include subscriptions started before this date.

pageinteger

Page number, defaults to 1.

limitinteger

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

sortingSubscriptionSortProperty[] 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

itemsSubscription[] required(unresolved $ref)

Changes

  • f9688fd328d6Revision changes
    • info

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

  • 8ae937367e87Revision changes
    • info

      added the new optional query request parameter started_after

    • info

      added the new optional query request parameter started_before

    • info

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

    • info

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

    • info

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

    • info

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