The subscriptions endpoint

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.card`	Near real-time notifications for card credential updates (e.g., PAN or expiration changes).	Credit Cards	Payment Instruments
`payment_instrument.network_token`	Near real-time notifications for network token updates (e.g., token provisioned or status changed).	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.

Enrollment requirements

Some subscriptions have prerequisites the Account must meet before it can be enrolled:

Name	Requirements
`transaction`	The Account must be active and the card on a supported network. Your team must have transaction configuration in place, and enrollment happens through Opal unless API enrollment is enabled for your team. Verification may be required: a `network` Account Verification Session when your team requires it, and whenever the full card number is not yet on file.
`card_brand`	The Account must be active and have at least one completed Card Brand request, and a network token must be available for the card.
`payment_instrument.card`	The Account must be active and have a completed `network` Account Verification Session.
`payment_instrument.network_token`	Same as `payment_instrument.card`, plus the Account must have a completed `network_token` Payment Instrument and a network token must be available for the card.
`update`	The Account must be an active, consented liability of a supported type with the Update product available to your team. Verification may be required when the liability’s data is unavailable but recoverable.
`update.snapshot`	The Account must have the `data:retrieve` capability.

Enrollment requests that do not meet a requirement fail with an INVALID_REQUEST error whose sub-type describes the missing requirement (for example, SUBSCRIPTION_RESTRICTED_MISSING_PRODUCT_REQUEST). See Subscription Errors for the full list.

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

API Reference

Entities

Accounts

Wallet

Payments

Files

Opal

Elements

Events

Supporting Endpoints

Subscription Names

Enrollment requirements

Subscriptions Objects

Webhook Payload

​Subscription Names

​Enrollment requirements

​Subscriptions Objects

​Webhook Payload

Subscription Names

Enrollment requirements

Subscriptions Objects

Webhook Payload