Vigilbase One APIBilling

List subscriptions

The customer’s Stripe subscriptions with priced items. A customer billed through a partner sees only the subscriptions of its own contracts.

Deprecated aliases: GET https://one.vigilbase.com/api/customers/{id}/stripe/subscriptions. They answer with the same bodies, with a Deprecation header and a successor-version link to this URL.

GET/customers/{customerId}/subscriptions

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Scope: one:api.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Read-only keys work. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

Vigilbase Identity access token issued to an MCP client (mcp.vigilbase.com). Scope: one:read.

Permissions checkedread:billing

Path Parameters

customerIdstringuuidrequired

Query Parameters

A cursor-paginated list: the response holds items, and while it has a nextCursor, pass it as cursor for the next page. See pagination.

cursorstring

The nextCursor of the previous page. Leave it out for the first page.

max length 512

limitinteger

How many items to return per page.

Default:50maximum 200

Response

application/json

Success

itemsobject[]required

9 child attributes

idstringrequired

statusstringrequired

descriptionstringrequired

Product names of the items, comma separated.

currentPeriodStartanyrequired

currentPeriodEndanyrequired

cancelAtPeriodEndbooleanrequired

canceledAtanyrequired

createdAtstringdate-timerequired

itemsobject[]required

4 child attributes

idstringrequired

quantityanyrequired

priceobjectrequired

9 child attributes

idstringrequired

nicknamestring | nullrequired

unitAmountanyrequired

currencystring | nullrequired

billingSchemeanyrequired

intervalanyrequired

intervalCountanyrequired

usageTypeanyrequired

transformQuantityanyrequired

productobjectrequired

3 child attributes

idstring | nullrequired

namestringrequired

descriptionstring | nullrequired

nextCursorstring

2 response headers

X-Request-Idstring

The request ID: yours when it was well-formed, otherwise a new one. Quote it to support.

API-Versionstring

The major API version (informational; the version is in the path).

More about this endpoint in the guide.

# Token from `vigilbase login`, or an API key (vb_one_…)
curl --request GET \
  --url 'https://api.vigilbase.com/one/v1/customers/{customerId}/subscriptions' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key first, or use Try it.

{
  "items": [
    {
      "id": "<string>",
      "status": "<string>",
      "description": "<string>",
      "currentPeriodStart": "<any>",
      "currentPeriodEnd": "<any>",
      "cancelAtPeriodEnd": true,
      "canceledAt": "<any>",
      "createdAt": "<string>",
      "items": [
        {
          "id": "<string>",
          "quantity": "<any>",
          "price": {},
          "product": {}
        }
      ]
    }
  ],
  "nextCursor": "<string>"
}

Was this page helpful?