{
  "transaction": {
    "id": "sub_P8c4bjj6xajxF",
    "name": "transaction",
    "status": "active",
    "payload": null,
    "latest_request_id": "txn_GBCW694AEgfAh",
    "created_at": "2024-04-10T22:14:21.951Z",
    "updated_at": "2024-04-10T22:14:21.951Z"
  },
  "update": {
    "id": "sub_P8c4bjj6xajxF",
    "name": "update",
    "status": "active",
    "payload": null,
    "latest_request_id": "upt_TXDTR7Amyz7Az",
    "created_at": "2024-04-10T22:14:21.951Z",
    "updated_at": "2024-04-10T22:14:21.951Z"
  }
}

The Account Subscriptions endpoint controls the state of all Subscriptions for an Account.

Subscriptions are Products that can provide continuous updates via Webhooks. (e.g. Transaction Subscription provides real-time updates on a Credit Card’s transactions)

Most subscriptions are accessible by default. However, some subscriptions have restricted access requiring team-by-team enablement and elevated account verification.

​
Subscription Names

Subscriptions that an Account can be enrolled in:

NameUse-CaseSupported TypesResource Doc
transactionNear real-time transaction notifications for Credit / Debit Card AccountsCredit CardsTransactions
updateNear real-time account update (balance, due dates, etc) from the Account’s financial institutionAll liabilitiesUpdates
update.snapshotMonthly snapshot update (balance, due dates, etc) from the Account’s financial institutionAll liabilitiesUpdates
card_brandNear real-time information regarding credit card metadata (Product / Brand Name, Art, etc)Credit CardsCard Brands
payment_instrumentNear real-time information regarding Credit / Debit Card credentials to be used for checkoutCredit CardsPayment Instruments

​
Subscriptions Objects

​
id
string

Unique identifier for the Subscription.

​
name
string

The name of the Subscription. See Subscription Names.

​
status
enum

Status of the Subscription.

​
payload
object | null

Payload used to create the Subscription.

​
latest_request_id
string | null

ID of the most recently created Product resource under this Subscription.

​
created_at
string

Timestamp of when the Subscription was created.

​
updated_at
string

Timestamp of when the Subscription was last updated.

​
Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "subscription.create" | "subscription.update",
  "path": "/accounts/<acc_id>/subscriptions/<sub_id>",
}

{
  "transaction": {
    "id": "sub_P8c4bjj6xajxF",
    "name": "transaction",
    "status": "active",
    "payload": null,
    "latest_request_id": "txn_GBCW694AEgfAh",
    "created_at": "2024-04-10T22:14:21.951Z",
    "updated_at": "2024-04-10T22:14:21.951Z"
  },
  "update": {
    "id": "sub_P8c4bjj6xajxF",
    "name": "update",
    "status": "active",
    "payload": null,
    "latest_request_id": "upt_TXDTR7Amyz7Az",
    "created_at": "2024-04-10T22:14:21.951Z",
    "updated_at": "2024-04-10T22:14:21.951Z"
  }
}