Subscription intent object

The Subscription Intent object

A SubscriptionIntent represents an in-progress attempt by an end user to enroll a bank account for direct debit, tracked through its status field. It is created when you start an enrollment, and on success it produces the Subscription referenced by its subscription field.

{
  "id": "si_m7N9rAWJS9dWDKEe",
  "object": "subscription_intent",
  "business_profile": {
    "name": "Merchant Name"
  },
  "created_at": "2021-11-11T02:29:16Z",
  "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`	Type of the object. Always `subscription_intent`.
`business_profile`	`object` or `null`	Profile of the enrolled merchant. Shown as the “Recipient Company” on the widget screens. It is `null` when no merchant name is set. See the Business Profile object table below for its fields.
`created_at`	`string`	Creation date as an ISO 8601 datetime in UTC.
`mode`	`string`	One of `live` or `test`. The `test` mode targets the sandbox.
`public_error`	`string`	Indicates the error of the subscription intent when it’s status is `failed`. The errors can be: `login_invalid_credentials`, `login_credentials_locked`, `authorization_failed`, `authorization_timeout`, `request_timeout`, `subscription_intent_expired`, `internal_error`.
`reference_id`	`string`	Identifier provided by the merchant that determines how the bank identifies the subscription on its portal. Defaults to the account `holder_id` if not provided. Up to 15 characters. Only available for Subscriptions’ clients.
`status`	`string`	Subscription Intent status. Can be `created`, `in_progress`, `succeeded`, `failed` or `rejected`.
`subscription`	`object` or `null`	Object that points to the subscription that is created in case the intent is successful. Otherwise it is null.
`widget_token`	`string` or `null`	Temporary token to configure the widget. This attribute is only returned when creating the Subscription Intent. After that, it will always be `null`.

The Business Profile object (within the Subscription Intent object)

The Business Profile object describes the enrolled merchant, returned in the business_profile field of the Subscription Intent.

Attribute	Type	Description
`name`	`string`	Name of the enrolled merchant. Shown as the “Recipient Company” on the widget screens.

Fintoc API

Main Resources

Payments API

Transfers API

Movements API

Direct Debit (Legacy)

Fiscal API

Subscription intent object

The Subscription Intent object

The Business Profile object (within the Subscription Intent object)

​The Subscription Intent object

​The Business Profile object (within the Subscription Intent object)

The Subscription Intent object

The Business Profile object (within the Subscription Intent object)