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

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

The id of the subscription to retrieve.

Respuesta

The subscription.

Represents a payer's authorization to charge a bank account. Fintoc creates a Subscription when a SubscriptionIntent succeeds, and an active subscription accepts charges.

id
string
requerido

Unique identifier of the subscription.

Ejemplo:

"sub_m7N9rAWJS9dWDKEe"

object
any
requerido

Type of the object. Always subscription.

account
object
requerido

Represents the bank account a payer authorized for a subscription.

created_at
string<date-time>
requerido

ISO 8601 timestamp, in UTC, of when the subscription was created.

Ejemplo:

"2023-03-08T15:24:11Z"

mode
enum<string>
requerido

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

Opciones disponibles:
test,
live
Ejemplo:

"live"

reference_id
string
requerido

Identifier the payer's bank uses to display the subscription on the bank's portal. Defaults to the account holder's ID when not provided on creation.

Ejemplo:

"ABC12345"

status
enum<string>
requerido

Status of the subscription. One of pending (the bank has not confirmed the subscription yet), active (the subscription accepts charges), or canceled (the subscription no longer accepts charges).

Opciones disponibles:
pending,
active,
canceled
Ejemplo:

"active"