| Field | Type | Required | Description |
|---|---|---|---|
organizationId |
string|array|null | ➖ | Filter by organization ID. |
productId |
string|array|null | ➖ | Filter by product ID. |
customerId |
string|array|null | ➖ | Filter by customer ID. |
externalCustomerId |
string|array|null | ➖ | Filter by customer external ID. |
discountId |
string|array|null | ➖ | Filter by discount ID. |
active |
?bool | ➖ | Filter by active or inactive subscription. |
cancelAtPeriodEnd |
?bool | ➖ | Filter by subscriptions that are set to cancel at period end. |
customerCancellationReason |
Components\CustomerCancellationReason|array|null | ➖ | Filter by customer cancellation reason. |
canceledAtAfter |
\DateTime | ➖ | Filter by cancellation date (after or equal to). |
canceledAtBefore |
\DateTime | ➖ | Filter by cancellation date (before or equal to). |
page |
?int | ➖ | Page number, defaults to 1. |
limit |
?int | ➖ | Size of a page, defaults to 10. Maximum is 100. |
sorting |
array<Components\SubscriptionSortProperty> | ➖ | 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. |
metadata |
array<string, string|int|bool|array> | ➖ | Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value. |