Get billing

The customer’s Stripe subscriptions, recent invoices, cards on file and monthly recurring revenue.

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

GET/customers/{customerId}/billing

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

Response

application/json

Success

isPartnerBilledbooleanrequired

Billed through the partner: subscriptions and invoices are the partner’s, for this customer’s contracts.

partneranyrequired

billingContactanyrequired

Name and email on the Stripe customer; null when billed through a partner or not set up.

monthlyRecurringRevenueanyrequired

Recurring revenue per month in minor units, from subscriptions (or contracts when partner-billed).

currencystring | nullrequired

subscriptionsobject[]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

invoicesobject[]required

15 child attributes

idstringrequired

numberstring | nullrequired

statusanyrequired

amountDueintegerrequired

Amount in the currency’s minor units (e.g. cents).

minimum -9007199254740991maximum 9007199254740991

amountPaidintegerrequired

Amount in the currency’s minor units (e.g. cents).

minimum -9007199254740991maximum 9007199254740991

amountRemainingintegerrequired

Amount in the currency’s minor units (e.g. cents).

minimum -9007199254740991maximum 9007199254740991

currencystringrequired

descriptionstring | nullrequired

subscriptionIdstring | nullrequired

lineCountintegerrequired

minimum -9007199254740991maximum 9007199254740991

createdAtstringdate-timerequired

dueDateanyrequired

paidAtanyrequired

hostedInvoiceUrlstring | nullrequired

invoicePdfUrlstring | nullrequired

paymentMethodsobject[]required

5 child attributes

idstringrequired

brandstring | nullrequired

last4string | nullrequired

expMonthanyrequired

expYearanyrequired

contractCountanyrequired

Contracts behind partner billing; null otherwise.

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}/billing' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "isPartnerBilled": true,
  "partner": "<any>",
  "billingContact": "<any>",
  "monthlyRecurringRevenue": "<any>",
  "currency": "<string>",
  "subscriptions": [
    {
      "id": "<string>",
      "status": "<string>",
      "description": "<string>",
      "currentPeriodStart": "<any>",
      "currentPeriodEnd": "<any>",
      "cancelAtPeriodEnd": true,
      "canceledAt": "<any>",
      "createdAt": "<string>",
      "items": [
        {
          "id": "<string>",
          "quantity": "<any>",
          "price": {},
          "product": {}
        }
      ]
    }
  ],
  "invoices": [
    {
      "id": "<string>",
      "number": "<string>",
      "status": "<any>",
      "amountDue": 123,
      "amountPaid": 123,
      "amountRemaining": 123,
      "currency": "<string>",
      "description": "<string>",
      "subscriptionId": "<string>",
      "lineCount": 123,
      "createdAt": "<string>",
      "dueDate": "<any>",
      "paidAt": "<any>",
      "hostedInvoiceUrl": "<string>",
      "invoicePdfUrl": "<string>"
    }
  ],
  "paymentMethods": [
    {
      "id": "<string>",
      "brand": "<string>",
      "last4": "<string>",
      "expMonth": "<any>",
      "expYear": "<any>"
    }
  ],
  "contractCount": "<any>"
}

Was this page helpful?