Saltar al contenido principal
GET
Get a subscription
v2 · Base URL https://api.fintoc.com/v2

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

The id of the subscription to retrieve.

Respuesta

The subscription, with its items included.

id
string
requerido

Unique identifier of the subscription.

Ejemplo:

"sub_2c4mDcMaVxDx7nT3o5GbPMQbS2v"

object
any
requerido

Type of the object. Always subscription.

billing_cycle_anchor
string<date-time>
requerido

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.

Ejemplo:

"2026-06-01T15:00:00Z"

collection_method
enum<string>
requerido

Method Fintoc uses to collect the invoices the subscription generates. One of charge_automatically (Fintoc charges the saved payment method) or send_invoice (Fintoc sends the invoice for the customer to pay). Subscriptions created through the API always use send_invoice.

Opciones disponibles:
charge_automatically,
send_invoice
Ejemplo:

"send_invoice"

created_at
string<date-time>
requerido

ISO 8601 timestamp of when the subscription was created.

Ejemplo:

"2026-06-01T15:00:00Z"

customer
string
requerido

ID of the customer the subscription bills.

Ejemplo:

"cus_2c4mDe9NJyGmMzvCqLkXqAtjnRu"

items
object[]
requerido

Items the subscription bills for on every billing cycle.

metadata
object
requerido

Set of key-value pairs attached to the subscription.

Ejemplo:
mode
enum<string>
requerido

Mode of the object. One of live or test. test subscriptions use fake data for integration testing and do not collect real money.

Opciones disponibles:
live,
test
Ejemplo:

"live"

payment_method
string | null
requerido

ID of the payment method charged when collection_method is charge_automatically. Always null for subscriptions created through the API.

Ejemplo:

null

status
enum<string>
requerido

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).

Opciones disponibles:
active,
canceled,
incomplete,
trialing
Ejemplo:

"active"

trial_end
string<date-time> | null
requerido

ISO 8601 timestamp at which the trial period ends, or null if the subscription has no trial.

Ejemplo:

null