Invoices

Get invoices

get

Retrieves all invoices for the specified store.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve invoices for.

Example: 411486491630370816

Query parameters

typestring · enumOptionalPossible values:

customer_idstring · flake-idOptionalExample: 411486491630370816

order_idstring · flake-idOptionalExample: 411486491630370816

referencestringOptional

billing_emailstringOptional

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

numberinteger · int64Required

Sequential number of the invoice within its store

referencestringRequired

Human readable reference of the invoice

typestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

order_idstring · flake-idRequiredExample: 411486491630370816

refund_idstring · flake-idOptionalExample: 411486491630370816

parent_invoice_idstring · flake-idOptionalExample: 411486491630370816

currencystringRequired

Three-letter currency code of the invoice

discount_amountinteger · int64Required

Total discount in smallest currency unit (e.g., cents)

subtotal_amountinteger · int64Required

Total before tax in smallest currency unit

tax_amountinteger · int64Required

Total tax in smallest currency unit

giftcard_usage_amountinteger · int64Required

Amount paid using gift cards in smallest currency unit

total_amountinteger · int64Required

Total of the invoice in smallest currency unit

file_keystring · nullableOptional

Optional storage key of the generated invoice document

file_sizeinteger · nullableOptional

Optional size of the generated invoice document in bytes

created_atstring · date-timeRequired

Date and time when the invoice was created

issued_atstring · date-timeRequired

Date and time when the invoice was issued

default

Error response

application/json

get/v1/stores/{storeId}/invoices

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/invoices HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "number": 1,
    "reference": "text",
    "type": "invalid",
    "status": "invalid",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "order_id": "411486491630370816",
    "refund_id": "411486491630370816",
    "parent_invoice_id": "411486491630370816",
    "currency": "text",
    "discount_amount": 1,
    "subtotal_amount": 1,
    "tax_amount": 1,
    "giftcard_usage_amount": 1,
    "total_amount": 1,
    "file_key": null,
    "file_size": null,
    "created_at": "2026-08-09T04:32:29.534Z",
    "issued_at": "2026-08-09T04:32:29.534Z"
  }
]

Download invoice

get

Retrieves a temporary download URL for the invoice PDF.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store the invoice belongs to.

Example: 411486491630370816

invoiceIdstring · flake-idRequired

The ID of the invoice to download.

Example: 411486491630370816

Responses

200

OK

application/json

download_urlstringRequired

Temporary URL the invoice document can be downloaded from

default

Error response

application/json

get/v1/stores/{storeId}/invoices/{invoiceId}/download

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/invoices/{invoiceId}/download HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "download_url": "text"
}