List card subscriptions

Returns all card subscriptions under the account, ordered by createdAt descending (most recently created first).

The subaccountId, cardId, bankAccountId, state, networkBulkFeedId, companyId, legalEntityId and legalEntityName filters are independent and combine additively — supplying more than one narrows the result set to subscriptions matching all of them.

companyId, legalEntityId and legalEntityName filter on the card's cardholder as it is now: corporate.id, corporate.legalEntity.id and corporate.legalEntity.name (see the Glossary). Each is an exact match; legalEntityName is case-sensitive, and each of legalEntityId and legalEntityName never matches a cardholder whose legal entity lacks that field, so copy it from the cardholder (expand=cardholder shows each cardholder's company and legal entity in the same response). For example, this returns the active subscriptions of one legal entity on one feed:

GET /card-subscriptions?networkBulkFeedId=<feed>&legalEntityId=<id>&state=active

These three filters read cardholder data, so they need the cardholder:read scope, like expand=cardholder. Without it the request returns 403.

Filtering by state accepts any of the states a card subscription reports in its response payload:

  • pending — enrolled from a network roster while the card is still inactive at the network. The subscription is fully enrolled and billable, but has not yet transacted.
  • active — also returns subscriptions still completing activation, which already report their own state as active.
  • deactivated, expired, reqSCA, failed-to-create — matched exactly.

This endpoint supports offset-based pagination. Pagination links preserve any filters applied to the original request.

Use expand to embed each subscription's card and cardholder in the same response (?expand=card,cardholder) instead of calling GET /cards/{cardId} and GET /cards/{cardId}/cardholder per item. Each embedded resource appears under the item's _embedded with the exact body its own endpoint serves, and requires that endpoint's scope (cards:read for card, cardholder:read for cardholder). Pagination links preserve expand like any other parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
uuid
uuid

Filter to subscriptions whose card materialized from this bank account (bank-derived subscriptions).

string
enum
Allowed:
uuid
string
length between 1 and 255

Only subscriptions whose card's cardholder currently has this company ID (corporate.id), not the value it had when the subscription was created. Exact match. Requires the cardholder:read scope.

string
length between 1 and 255

Only subscriptions whose card's cardholder currently belongs to this legal entity (corporate.legalEntity.id), not the one it belonged to when the subscription was created. Exact match. A cardholder whose legal entity has no id never matches this filter; filter by legalEntityName instead. Requires the cardholder:read scope.

string
length between 1 and 255

Only subscriptions whose card's cardholder currently belongs to a legal entity with this name (corporate.legalEntity.name), not the one it belonged to when the subscription was created. Exact, case-sensitive match. A cardholder whose legal entity has no name never matches this filter; filter by legalEntityId instead. URL-encode the value: a space is %20 (or +), for example legalEntityName=Astrada%20Life. Requires the cardholder:read scope.

integer
1 to 100
Defaults to 25

Maximum number of items to return

number
Defaults to 0

The offset to use for pagination. Identifies the position of the first item returned in the collection

expand
array of strings

Comma-separated list of related resources to embed on each card subscription under _embedded, so one call returns the subscription together with its card and cardholder instead of a GET /cards/{cardId} and a GET /cards/{cardId}/cardholder per item.

  • card embeds the card exactly as GET /cards/{cardId} serves it and requires the cards:read scope.
  • cardholder embeds the cardholder exactly as GET /cards/{cardId}/cardholder serves it and requires the cardholder:read scope.

A request naming a resource its credentials cannot read is refused with 403. When a related resource does not exist (for example a card without cardholder data), its key is absent from _embedded; _links are unchanged.

Send one comma-separated value (expand=card,cardholder). A repeated expand key, an empty value or an unknown value is refused with 400.

expand
Allowed:
Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json