Skip to main content
GET
/
v1
/
client-invoices
/
{id}
Get Client Invoice
curl --request GET \
  --url https://api.spairehq.com/v1/client-invoices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ]
}

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.

Path Parameters

​
id
string<uuid4>
required

Response

Successful Response

​
id
string<uuid4>
required

The ID of the object.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
organization_id
string<uuid4>
required
​
customer_id
string<uuid4>
required
​
stripe_invoice_id
string | null
required
​
status
enum<string>
required
Available options:
draft,
open,
paid,
void,
uncollectible
​
currency
string
required
​
subtotal_amount
integer
required
​
discount_amount
integer
required
​
tax_amount
integer
required
​
total_amount
integer
required
​
memo
string | null
required
​
po_number
string | null
required
​
due_date
string<date> | null
required
​
on_behalf_of_label
string | null
required
​
discount_label
string | null
required
​
include_payment_link
boolean
required
​
show_mor_attribution
boolean
required
​
stripe_hosted_invoice_url
string | null
required
​
invoice_pdf_url
string | null
required
​
checkout_link
string | null
required
​
user_metadata
User Metadata · object
required
​
order_id
string<uuid4> | null
required
​
line_items
ClientInvoiceLineItemSchema · object[]