Subscription object

The Subscription object

A Subscription represents an end user’s enrolled bank account that authorizes direct debit collections, exposing the linked account and a status. Fintoc creates the Subscription when a SubscriptionIntent succeeds. To create charges through Fintoc, the Subscription must have status active.

If your existing integration only enrolls bank accounts under your own bank agreement, the status does not determine the mandate’s validity at your bank. Follow Enrollment under your own bank agreement instead of waiting for activation through Fintoc.

Subscription Object

{
  "id": "sub_m7N9rAWJS9dWDKEe",
  "object": "subscription",
  "account": {
    "id": "acc_nMNejK7BT8oGbvO4",
    "object": "account",
    "balance": {
      "available": 530000,
      "current": 530000,
      "limit": 1530000
    },
    "currency": "CLP",
    "holder_id": "111111111",
    "holder_name": "Test Customer 1",
    "institution": {
      "id": "cl_banco_santander",
      "country": "cl",
      "name": "Banco Santander"
    },
    "name": "Cuenta Corriente",
    "number": "0000000000",
    "official_name": "Cuenta Corriente Moneda Local",
    "type": "checking_account"
  },
  "created_at": "2021-11-11T02:29:16Z",
  "mode": "live",
  "reference_id": null,
  "status": "active"
}

Attribute	Type	Description
`id`	`string`	Unique identifier for the Subscription
`object`	`string`	Identifier for the type of object. Its value for `Subscriptions` will always correspond to `subscription`
`account`	`object`	Object that points to the bank account that can be charged with this subscription.
`created_at`	`string`	`Subscription`’s creation date, using ISO 8601
`mode`	`string`	Indicates whether the `Subscription` is in `live` mode or in `test` mode (for the sandbox)
`reference_id`	`string`	Merchant-provided ID that determines how the bank identifies the subscription in its portal. If omitted, Fintoc uses the end user’s `holder_id`. Must be 1 to 15 characters. Available only for subscription clients.
`status`	`string`	`Subscription` status in Fintoc. One of `pending`, `active`, `canceled`, or `expired`. You can charge only `active` subscriptions through Fintoc. For enrollment under your own bank agreement, confirm mandate validity with your bank instead.

Subscription account balanceThe account.balance field is only present when you receive a subscription through a subscription_intent.succeeded event.At other moments the account balance is null.

Enrollment under your own bank agreement

If you use Fintoc’s legacy Subscriptions product only to enroll bank accounts, your bank handles subsequent collections under your agreement. Fintoc’s enrollment flow ends when you receive subscription_intent.succeeded. Handle enrollment results on your backend:

Listen for subscription_intent.succeeded to confirm that your customer completed enrollment. Store the returned subscription.id, subscription.account, and subscription.reference_id.
Handle subscription_intent.failed and subscription_intent.rejected to notify your customer that Fintoc could not confirm successful enrollment.

After successful enrollment, confirm mandate activation and collection readiness with your bank before creating debits under your agreement. A successful SubscriptionIntent does not confirm bank activation or a successful debit. The returned Subscription can remain pending after your bank activates the mandate. Do not use subscription.activated, subscription.canceled, or the Subscription.status to activate or deactivate mandates in your own-bank integration. A subscription.canceled event with status expired reports expiration of the Subscription in Fintoc, not confirmation of bank-side cancellation. Confirm the mandate’s current state with your bank.

​The Subscription object

​Enrollment under your own bank agreement

The Subscription object

Enrollment under your own bank agreement