Subscriptions
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 |
---|---|---|---|
transactions | Real-time transaction (authorization, purchases, etc) notifications for Credit Card Accounts | Credit Cards | Transactions |
update | Near real-time account update (balance, due dates, etc) from the Account’s financial institution | All liabilities | Updates |
update.snapshot | Monthly snapshot update (balance, due dates, etc) from the Account’s financial institution | All liabilities | Updates |
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.
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>",
}