Skip to main content
GET
/
v1
/
client-invoices
List Client Invoices
curl --request GET \
  --url https://api.spairehq.com/v1/client-invoices/ \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "organization_id": "<string>",
      "customer_id": "<string>",
      "stripe_invoice_id": "<string>",
      "currency": "<string>",
      "subtotal_amount": 123,
      "discount_amount": 123,
      "tax_amount": 123,
      "total_amount": 123,
      "memo": "<string>",
      "po_number": "<string>",
      "due_date": "2023-12-25",
      "on_behalf_of_label": "<string>",
      "discount_label": "<string>",
      "include_payment_link": true,
      "show_logo": true,
      "show_mor_attribution": true,
      "stripe_hosted_invoice_url": "<string>",
      "invoice_pdf_url": "<string>",
      "checkout_link": "<string>",
      "user_metadata": {},
      "order_id": "<string>",
      "line_items": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "client_invoice_id": "<string>",
          "stripe_invoice_item_id": "<string>",
          "description": "<string>",
          "quantity": 123,
          "unit_amount": 123,
          "currency": "<string>",
          "amount": 123,
          "tax_amount": 123
        }
      ]
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

You can generate a Personal Access Token from your settings.

Query Parameters

​
page
integer
default:1

Page number, defaults to 1.

​
limit
integer
default:10

Size of a page, defaults to 10. Maximum is 100.

​
sorting
enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options:
created_at,
-created_at,
status,
-status,
total_amount,
-total_amount,
due_date,
-due_date

Response

Successful Response

​
items
ClientInvoiceSchema · object[]
required
​
pagination
Pagination · object
required