Subscription Object

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

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

status

string

Subscription status. Can be pending, active, canceled.
Only active subscription can be charged.

mode

string

Indicates whether the Subscription is in live mode or in test mode (for the sandbox)

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

reference_id

string

  • *Optional ID**provided by the merchant which will determine how the bank identifies the subscription on its portal. If not provided, user'sholder_idwill be used. **Length must be between 1-15 characters**, and its only available for Subscriptions' clients.
🚧

Subscription account balance

Currently, subscriptions' account balance is only present when subscriptions are created. Specifically, when subscriptions are received via subscription_intent.successful events.

At other moments the account balance will be shown as null.

Only subscriptions created by Direct Debit merchants can be charged and have status active.

Subscriptions created by Subscriptions merchants will always have status pending.