List bank subscriptions
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
subaccountId
uuid
state
string
enum
Filter subscriptions by state
activeerrorauth_requireddisconnected
Allowed:
active``error``auth_required``disconnected
connectionId
string
Filter subscriptions by provider connection identifier
limit
integer
1 to 1000
Defaults to 250
Maximum number of items to return
cursor
string
The cursor to use for pagination. Identifies your place on the list
accept
string
enum
Defaults to application/json
Generated from available response content types
application/jsonapplication/problem+json
Allowed:
application/json``application/problem+json
``200 Successful operation
object
items
array of objects
required
items*
object
id
uuid
required
The unique identifier of the bank subscription.
accountId
uuid
required
The unique identifier of the account that owns this subscription.
subaccountId
uuid
required
The unique identifier of the subaccount associated with this subscription.
connectionId
string
required
The provider's unique connection identifier (e.g. Plaid item ID).
provider
string
enum
required
The banking data provider for this subscription.
PLAID
institutionName
string
required
The name of the connected financial institution.
state
string
enum
required
Current state of the subscription.
active: The connection is functioning normally.error: The connection has encountered an error.auth_required: The connection requires user re-authentication.disconnected: The connection has been disconnected.
active``error``auth_required``disconnected
webhook
object
required
Webhook configuration for this subscription.
webhook object
syncCursor
string | null
required
The current transaction sync cursor for this subscription.
createdAt
date-time
required
Date and time when this resource was created, in UTC, following ISO 8601 format.
updatedAt
date-time
required
Date and time when this resource was last updated, in UTC, following ISO 8601 format.
pagination
object
required
cursor
string
Cursor to use for the next page of results.
hasMore
boolean
required
Whether there are more results available.
``400 The server cannot or will not process the request due to something that is perceived to be a client error
``401 Authentication credentials were either missing or incorrect
``403 Authentication credentials used do not have have permissions to perform the request
``500 The server encountered an unexpected condition that prevented it from fulfilling the request
Updated 12 days ago
ShellNodeRubyPHPPython
Bearer
xxxxxxxxxx
curl --request GET \
--url 'https://api.astrada.co/bank-subscriptions?limit=250' \
--header 'accept: application/json'
xxxxxxxxxx
{
"items": [
{
"id": "e4b7c9a2-1d3f-4e8a-9c6b-5f2d7a0e8b1c",
"accountId": "8f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"subaccountId": "1fcb895e-9217-4a6f-9d10-5a7dcef86c11",
"connectionId": "conn_abc123def456",
"provider": "PLAID",
"institutionName": "Chase",
"state": "active",
"webhook": {
"url": "https://example.com/webhooks/banking",
"status": "confirmed"
},
"syncCursor": null,
"createdAt": "2025-10-03T10:55:42.000Z",
"updatedAt": "2025-10-03T10:55:42.000Z"
}
],
"pagination": {
"hasMore": false
}
}