Get subscription
Returns a subscription by id.
Authorizations
Organization API key using Authorization: Bearer sk_....
Path Parameters
Identifier of the subscription.
Response
Subscription details
Subscription details response. Returns null if the subscription does not exist.
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.