Invoices

List invoices

GET/v1/billing/invoices

Lists the organization's invoices, optionally only the unpaid ones.

curl --request GET \
  --url https://api.serverside.com/v1/billing/invoices \
  --header 'Authorization: Bearer <api-key>'

{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2026-01-15T09:30:00Z",
      "dueDate": "2026-01-15T09:30:00Z",
      "status": "UNPAID",
      "type": "STANDARD",
      "currency": "<string>",
      "invoiceNumber": 123,
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billedFrom": {
        "name": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "region": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>",
        "vatNumber": "<string>",
        "emailAddress": "<string>",
        "phoneNumber": "<string>"
      },
      "billedTo": {
        "name": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "region": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>",
        "vatNumber": "<string>",
        "emailAddress": "<string>",
        "phoneNumber": "<string>"
      },
      "taxBreakdown": [
        {
          "name": "<string>",
          "rate": 123,
          "amount": 123,
          "taxId": "<string>"
        }
      ],
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "periodStart": "2026-01-15T09:30:00Z",
          "periodEnd": "2026-01-15T09:30:00Z",
          "subtotal": 123,
          "discount": 123,
          "taxTreatment": "STANDARD",
          "taxRate": 123,
          "taxAmount": 123,
          "total": 123
        }
      ],
      "transactions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "transactionReference": "<string>",
          "amount": 123,
          "currency": "<string>",
          "createdAt": "2026-01-15T09:30:00Z",
          "paymentProvider": "STRIPE",
          "status": "PENDING"
        }
      ],
      "subtotal": 123,
      "discount": 123,
      "taxes": 123,
      "total": 123,
      "amountDue": 123
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "page": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisations

Authorizationstringheaderobligatoire
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Permission requise : organization.billing.read

Paramètres de requête

searchstring
filterobject
pageinteger<int32>
Limites :1 <= x <= 2147483
pageSizeinteger<int32>
Limites :1 <= x <= 1000
sortColumnstring
ascendingboolean
unpaidOnlyboolean
Par défaut :false

Réponse

200 · application/json

successbooleanobligatoire
Valeurs autorisées :true
dataobject[] | nullobligatoire
paginationobject

Autorisations

Paramètres de requête

Réponse

Pied de page