Resource
Invoices
List, create, search, and manage invoices.
The invoice object
Attributes
invoiceobjectShow 19 child attributesHide child attributes
idintegerExample:48213slugstringExample:k7xq2m9d4rnumberstringExample:INV-1042invoice_typestringExample:invoicetotal_pricestringExample:100.94currencystringExample:USDfinancial_statusstringExample:paidfulfillment_statusstringExample:fulfilledorder_namestringExample:#1042order_numberintegerExample:1042processed_atstringExample:2026-01-15T09:30:00ZnotestringExample:Please leave at the front desk.created_atstringExample:2026-01-15T09:31:12Zupdated_atstringExample:2026-01-15T09:31:40ZcustomerobjectShow 4 child attributesHide child attributes
idintegerExample:9177emailstringExample:jane.doe@example.comfirst_namestringExample:Janelast_namestringExample:Doe
billing_addressobjectShow 10 child attributesHide child attributes
first_namestringExample:Janelast_namestringExample:DoecompanystringExample:Doe Studioaddress1stringExample:12 Example Streetaddress2stringExample:Suite 4citystringExample:SpringfieldprovincestringExample:IllinoiscountrystringExample:United StateszipstringExample:62701phonestringExample:+1 555 010 0199
shipping_addressobjectShow 10 child attributesHide child attributes
first_namestringExample:Janelast_namestringExample:Doecompanystringaddress1stringExample:12 Example Streetaddress2stringcitystringExample:SpringfieldprovincestringExample:IllinoiscountrystringExample:United StateszipstringExample:62701phonestringExample:+1 555 010 0199
line_itemsarray of objectsShow 5 child attributesHide child attributes
titlestringExample:Canvas tote bagvariant_titlestringExample:Natural / LargequantityintegerExample:2pricestringExample:45.00skustringExample:TOTE-NAT-L
tax_linesarray of objectsShow 3 child attributesHide child attributes
titlestringTax name (e.g. VAT, GST).
ratenumberDecimal rate (e.g. 0.2 for 20%).
pricestringExample:5.94
Endpoints
The invoice object
{
"invoice": {
"id": 48213,
"slug": "k7xq2m9d4r",
"number": "INV-1042",
"invoice_type": "invoice",
"total_price": "100.94",
"currency": "USD",
"financial_status": "paid",
"fulfillment_status": "fulfilled",
"order_name": "#1042",
"order_number": 1042,
"processed_at": "2026-01-15T09:30:00Z",
"note": "Please leave at the front desk.",
"created_at": "2026-01-15T09:31:12Z",
"updated_at": "2026-01-15T09:31:40Z",
"customer": {
"id": 9177,
"email": "jane.doe@example.com",
"first_name": "Jane",
"last_name": "Doe"
},
"billing_address": {
"first_name": "Jane",
"last_name": "Doe",
"company": "Doe Studio",
"address1": "12 Example Street",
"address2": "Suite 4",
"city": "Springfield",
"province": "Illinois",
"country": "United States",
"zip": "62701",
"phone": "+1 555 010 0199"
},
"shipping_address": {
"first_name": "Jane",
"last_name": "Doe",
"company": null,
"address1": "12 Example Street",
"address2": null,
"city": "Springfield",
"province": "Illinois",
"country": "United States",
"zip": "62701",
"phone": "+1 555 010 0199"
},
"line_items": [
{
"title": "Canvas tote bag",
"variant_title": "Natural / Large",
"quantity": 2,
"price": "45.00",
"sku": "TOTE-NAT-L"
},
{
"title": "Gift wrapping",
"variant_title": null,
"quantity": 1,
"price": "5.00",
"sku": null
}
],
"tax_lines": [
{
"title": "State tax",
"rate": 0.0625,
"price": "5.94"
}
]
}
}