{
"id": "si_m7N9rAWJS9dWDKEe",
"object": "subscription_intent",
"business_profile": {
"name": "Merchant Name"
},
"created_at": "2021-11-11T02:29:16Z",
"customer_email": "customer@example.com",
"mode": "live",
"public_error": null,
"reference_id": null,
"status": "created",
"subscription": null,
"widget_token": "si_m7N9rAWJS9dWDKEe_sec_1y7o6DYLY299p7ePP7zevTEj"
}
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Subscription Intent. |
object | string | Identifier for the type of object. Its value for Subscription Intent is always subscription_intent. |
business_profile | hash | Object describing the enrolled merchant displayed to the user during the subscription flow. |
business_profile.name | string | Enrolled merchant name, displayed as “Recipient Company” on the widget screens. |
created_at | string | Subscription Intent’s creation date, using ISO 8601. |
customer_email | string or null | Email of the customer associated with the Subscription Intent. null when no email is set. |
mode | string | Indicates whether the Subscription Intent is in live mode or in test mode (for the sandbox). |
public_error | string | Error indicator when status is failed. Its values can be account_type_not_permitted, authorization_timeout, bank_connection_error, bank_not_available, internal_error, login_credentials_locked, login_invalid_credentials, mfa_authorization_timeout, mfa_unavailable, password_change_required, request_timeout, subscription_intent_expired, or user_left. It can be null. |
reference_id | string | Optional ID provided by the merchant that determines how the bank identifies the subscription on its portal. It must have between 1 and 15 characters. It can be null. |
status | string | Subscription Intent status. Can be created, in_progress, succeeded, failed, or rejected. |
subscription | object | Object pointing to the created subscription upon success; otherwise null. |
widget_token | string | Temporary token to configure the widget. This attribute is only returned when creating the Subscription Intent. After that, it is always null. |