Subscriptions
The subscriptions endpoint
Subscriptions
The subscriptions endpoint
The Entity Subscriptions endpoint controls the state of all Subscriptions for an Entity.
Subscriptions are Products that can provide continuous updates via Webhooks. (e.g. Credit Score Subscription provides updates on an Entity’s credit score)
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 Entity can be enrolled in:
| Name | Use-Case | Resource Doc |
|---|---|---|
connect | Comprehensive view of an Entity’s outstanding liabilities and continuous near real-time updates on new liabilities. | Connect |
credit_score | Continuous near real-time updates on an Entity’s credit score. | Credit Scores |
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": "/entities/<ent_id>/subscriptions/<sub_id>",
}