List subscriptions
Returns subscriptions.
Editor interactivo de filter
Utiliza este editor para generar un valor que puedes usar en el parámetro filter del query string.
Para relaciones, grupos lógicos y más ejemplos, consulta la guía de filtros.
Authorizations
Organization API key using Authorization: Bearer sk_....
Query Parameters
Filter fields encoded with qs bracket notation.
Pagination offset.
x >= 00
Pagination limit.
1 <= x <= 10020
Sort fields encoded with qs bracket notation.
Response
Subscriptions list
Unique identifier of the subscription.
"sub_1234567890abcdefghij"
Date and time when the subscription was created.
"2025-01-01T06:00:00.000Z"
Date and time when the subscription was last updated.
"2025-01-01T06:00:00.000Z"
Human-readable description of the subscription.
"Colegiatura mensual"
Identifier of the customer this subscription belongs to.
"cus_1234567890abcdefghij"
How payment is collected: AUTOMATIC, SEND_REMINDER, or NONE.
AUTOMATIC, SEND_REMINDER, NONE "AUTOMATIC"
Identifier of the payment method used for automatic collection.
"pm_1234567890abcdefghij"
Identifier of the tax profile used for invoice generation.
null
Date and time of the next scheduled collection.
"2025-02-01T06:00:00.000Z"
Date and time of the first collection.
"2025-01-01T06:00:00.000Z"
Date and time of the last collection, if set.
"2025-12-01T06:00:00.000Z"
Whether invoices are generated manually or automatically.
MANUAL, AUTO "AUTO"
Whether only automatic collection is allowed.
false
Custom cancellation reason provided by the user.
null
Date and time when the subscription was canceled.
null
Identifier of the user who canceled the subscription.
null
Whether the subscription is currently active.
true
Whether the subscription has completed all scheduled collections.
false
Current status: INACTIVE, ACTIVE, CANCELED, or COMPLETED.
INACTIVE, ACTIVE, CANCELED, COMPLETED, null "ACTIVE"
Flattened metadata map where each key maps to a string value.
Flattened metadata map where each key maps to a string value.