POpolar
customer_portal
subscriptions
public

List Subscriptions

List subscriptions of the authenticated customer.

Scopes: customer_portal:read customer_portal:write

get/v1/customer-portal/subscriptions/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customer-portal/subscriptions/
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The product ID.

OR
string[]
activeboolean nullable

Filter by active or cancelled subscription.

querystring nullable

Search by product or organization name.

pageinteger

Page number, defaults to 1.

limitinteger

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

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

Response

Successful Response

Changes

No recorded changes to this operation across all 11 revisions of this API.