List workspace invoices

GET/api/v2/billing/invoices

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Query parameters

limitinteger

min 1 · max 100 · default: 10

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Workspace invoices returned.

successbooleanrequired

Allowed:true

dataobjectrequired

Show properties

invoicesBillingInvoice[]required

Show properties

Array of BillingInvoice

idstring<uuid>required

stripeInvoiceIdstringrequired

matches ^in_

amountDuenumberrequired

Major currency units.

min 0

amountPaidnumberrequired

Major currency units.

min 0

currencystringrequired

statusstringrequired

Allowed:draftopenpaidvoiduncollectible

periodobjectrequired

Show properties

startstring<date-time>required

endstring<date-time>required

urlsobjectrequired

Show properties

invoicestring<uri> | nullrequired

pdfstring<uri> | nullrequired

paidAtstring<date-time> | nullrequired

createdAtstring<date-time>required

totalintegerrequired

Number returned, not a count of all stored invoices.

min 0

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.limitquery

Request

curl -X GET 'https://api.anlyon.com/api/v2/billing/invoices' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/billing/invoices", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/billing/invoices",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "invoices": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "stripeInvoiceId": "string",
        "amountDue": 0,
        "amountPaid": 0,
        "currency": "string",
        "status": "draft",
        "period": {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        },
        "urls": {
          "invoice": "http://example.com",
          "pdf": "http://example.com"
        },
        "paidAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ],
    "total": 0
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}