subscriptions
public

List Subscriptions

List subscriptions.

Scopes: subscriptions:read subscriptions:write

get/v1/subscriptions/

Query parameters

string uuid4

The organization ID.

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

Filter by organization ID.

string uuid4

The product ID.

OR
string[]

Filter by product ID.

string uuid4

The customer ID.

OR
string[]

Filter by customer ID.

string

The customer external ID.

OR
string[]

Filter by customer external ID.

string uuid4

The product ID.

OR
string[]

Filter by discount ID.

activeboolean nullable

Filter by active or inactive subscription.

Filter by active or inactive subscription.

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

Filter by subscription status.

cancel_at_period_endboolean nullable

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

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

Filter by customer cancellation reason.

canceled_at_afterstring date-time nullable

Filter by cancellation date (after or equal to).

Filter by cancellation date (after or equal to).

canceled_at_beforestring date-time nullable

Filter by cancellation date (before or equal to).

Filter by cancellation date (before or equal to).

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

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

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.

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