The subscriptions endpoint

{
  "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:

Name	Use-Case	Supported Types	Resource Doc
`transaction`	Near real-time transaction notifications for Credit / Debit Card Accounts.	Credit Cards	Transactions
`update`	Near real-time account update (balance, due dates, etc) from the Account’s financial institution. Includes `update.snapshot` updates.	All liabilities	Updates
`update.snapshot`	Monthly account snapshot update (balance, due dates, etc) from the credit bureau.	All liabilities	Updates
`card_brand`	Near real-time information regarding credit card metadata (Product / Brand Name, Art, etc).	Credit Cards	Card Brands
`payment_instrument`	Near real-time information regarding Credit / Debit Card credentials to be used for checkout.	Credit Cards	Payment Instruments

Update subscriptions will attempt to deliver both direct and snapshot updates when available.

An account can either have an update or update.snapshot subscription at any given time, not both.

Subscriptions Objects

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"
  }
}

⌘I

API Reference

Entities

Accounts

Wallet

Payments

Files

Opal

Elements

Events

Supporting Endpoints

Subscription Names

Subscriptions Objects

Webhook Payload

​Subscription Names

​Subscriptions Objects

​Webhook Payload

Subscription Names

Subscriptions Objects

Webhook Payload