Vigilbase One APIBilling

List invoices

The customer’s most recent Stripe invoices (up to 100), newest first. A customer billed through a partner sees only the invoices of its own contracts.

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

GET/customers/{customerId}/invoices

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

statusstring

One of:draftopenpaiduncollectiblevoid

Response

application/json

Success

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

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}/invoices' \
  --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>",
      "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>"
    }
  ],
  "nextCursor": "<string>"
}

Was this page helpful?