Get a subscription
Retrieves a subscription by its id, with its subscription items included. Only subscriptions of your organization matching the live or test mode of the API key used are visible.
Autorizaciones
Parámetros de ruta
The id of the subscription to retrieve.
Respuesta
The subscription, with its items included.
Unique identifier of the subscription.
"sub_2c4mDcMaVxDx7nT3o5GbPMQbS2v"
Type of the object. Always subscription.
ISO 8601 timestamp that anchors the billing cycle. Fintoc sets this anchor to the subscription's creation time, or to trial_end when a trial applies. Fintoc measures every billing period from this anchor.
"2026-06-01T15:00:00Z"
Method Fintoc uses to collect the invoices the subscription generates. One of charge_automatically (Fintoc charges the saved payment method) or send_invoice (Fintoc leaves each invoice open for you to collect).
charge_automatically, send_invoice "charge_automatically"
ISO 8601 timestamp of when the subscription was created.
"2026-06-01T15:00:00Z"
ID of the customer the subscription bills.
"cus_2c4mDe9NJyGmMzvCqLkXqAtjnRu"
Items the subscription bills for on every billing cycle.
Set of key-value pairs attached to the subscription.
Mode of the object. One of live or test. test subscriptions use fake data for integration testing and do not collect real money.
live, test "live"
ID of the payment method associated with the subscription, or null if it has none. Fintoc charges it on every billing cycle when collection_method is charge_automatically.
"pm_2c4mDhAbCdEfGhIjKlMnOpQrStu"
Current status of the subscription. One of active, incomplete (the first invoice payment has not yet succeeded), trialing (the trial period has not ended), or canceled (the subscription stopped generating invoices).
active, canceled, incomplete, trialing "active"
ISO 8601 timestamp at which the trial period ends, or null if the subscription has no trial.
null