Error
A valid request URL is required to generate request examples{
"object": "list",
"data": [
{
"id": "<string>",
"object": "subscription",
"customer": "<string>",
"status": "incomplete",
"collection_method": "charge_automatically",
"items": [
{
"id": "<string>",
"price": "<string>",
"quantity": 123,
"metadata": {}
}
],
"current_period_start": 123,
"current_period_end": 123,
"billing_cycle_anchor": 123,
"cancel_at_period_end": true,
"metadata": {},
"livemode": true,
"test_clock": "<string>",
"created_at": 123,
"updated_at": 123,
"default_payment_method": "<string>",
"trial_start": 123,
"trial_end": 123,
"canceled_at": 123,
"ended_at": 123,
"latest_invoice": "<string>"
}
],
"has_more": true,
"total_count": 123,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "invalid collection_method"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Subscriptions
List subscriptions
GET
/
subscriptions
Error
A valid request URL is required to generate request examples{
"object": "list",
"data": [
{
"id": "<string>",
"object": "subscription",
"customer": "<string>",
"status": "incomplete",
"collection_method": "charge_automatically",
"items": [
{
"id": "<string>",
"price": "<string>",
"quantity": 123,
"metadata": {}
}
],
"current_period_start": 123,
"current_period_end": 123,
"billing_cycle_anchor": 123,
"cancel_at_period_end": true,
"metadata": {},
"livemode": true,
"test_clock": "<string>",
"created_at": 123,
"updated_at": 123,
"default_payment_method": "<string>",
"trial_start": 123,
"trial_end": 123,
"canceled_at": 123,
"ended_at": 123,
"latest_invoice": "<string>"
}
],
"has_more": true,
"total_count": 123,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "invalid collection_method"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.
Pattern:
^mer_[0-9A-Za-z]{14}$Query Parameters
Filter by customer id.
Filter by status.
Available options:
incomplete, trialing, active, past_due, unpaid, canceled Page size (default 20, max 100).
Required range:
1 <= x <= 100Number of records to skip.
Required range:
x >= 0Cursor: a subscription id (typically the previous response's next_cursor). Returns results strictly after it, newest first. Cannot be combined with offset.
Response
A paginated list of subscriptions.
Available options:
list The subscriptions on this page.
Show child attributes
Show child attributes
True when more records exist beyond this page.
Total number of subscriptions matching the query.
Present when has_more is true: the last returned subscription's id. Pass it as starting_after on the next request.

