List Subscriptions
List Subscriptions
Authorizations
Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}
Headers
The unique identifier of the request
Query Parameters
Subscription ID array, filter subscription records whose IDs belong to this array
Subscription business status:
- init - Pending activation
- trial - Trial period
- active - Active
- canceled - Canceled
- incomplete - Incomplete
Cursor for pagination. starting_after is the object ID that defines your position in the list. For example, if you want to get the next page, you can use the last object's ID as the parameter value after getting the object list for the first time. Cannot be used together with ending_before
Cursor for pagination. ending_before is the object ID that defines your position in the list. For example, if you want to get the previous page, you can use the first object's ID as the parameter value after getting the object list for the first time. Cannot be used together with starting_after
Pagination parameter, number of items per page, default: 10, interface defaults to sorting by creation time in descending order. Limit: [1, 100]
Merchant unique identifier
The order_ids of you platform, filter the subscription records where the order_id belongs to this array.
The source_trade_id array, filter subscriptions where source_trade_id belongs to this array
Subscription business billing cycle unit:
- week
- month
- quarter
- year
- customer-initiated
- over_threshold
The search_type belongs to one of the fields such as subscription_id,trade_id,refund_id,invoice_id, and customer_id
The search_value is the value corresponding to search_type
Minimum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
Minimum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
Maximum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
Maximum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')