Get Customer Invoice

Retrieve detailed information for a specific customer invoice by its ID. Customers can only access invoices from their own orders — requesting another customer's invoice returns a 404, preventing enumeration attacks.

Endpoint

GET /api/shop/customer-invoices/{id}

Request Headers

Header	Required	Description
Content-Type	Yes	application/json
X-STOREFRONT-KEY	Yes	Your storefront API key
Authorization	Yes	Bearer token (customer login required)

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	Customer invoice ID

Response Fields (200 OK)

Field	Type	Description
id	integer	Invoice ID
incrementId	string	Human-readable invoice number (e.g. INV-001)
state	string	Invoice state
totalQty	integer	Total quantity of items in the invoice
emailSent	boolean	Whether the invoice email was sent
subTotal	float	Sub total
baseSubTotal	float	Base sub total
grandTotal	float	Grand total
baseGrandTotal	float	Base grand total
shippingAmount	float	Shipping amount
baseShippingAmount	float	Base shipping amount
taxAmount	float	Tax amount
baseTaxAmount	float	Base tax amount
discountAmount	float	Discount amount
baseDiscountAmount	float	Base discount amount
shippingTaxAmount	float	Shipping tax amount
baseShippingTaxAmount	float	Base shipping tax amount
subTotalInclTax	float	Sub total including tax
baseSubTotalInclTax	float	Base sub total including tax
shippingAmountInclTax	float	Shipping amount including tax
baseShippingAmountInclTax	float	Base shipping amount including tax
baseCurrencyCode	string	Base currency code (e.g. USD)
channelCurrencyCode	string	Channel currency code
orderCurrencyCode	string	Order currency code
transactionId	string	Payment transaction ID
reminders	integer	Number of reminders sent
nextReminderAt	string	Next reminder scheduled date
order	string	Associated order IRI (e.g. /api/shop/customer-orders/1)
items	array	Invoice line item IRIs
createdAt	string	ISO 8601 creation timestamp
updatedAt	string	ISO 8601 last update timestamp

Error Responses

Not Found (404):

{
  "message": "Customer invoice with ID \"999\" not found."
}

Unauthenticated (401):

{
  "message": "Customer is not logged in."
}

Accessing Another Customer's Invoice (404):

Requesting an invoice that belongs to a different customer's order returns the same 404 response, preventing enumeration attacks:

{
  "message": "Customer invoice with ID \"5\" not found."
}

Use Cases

• Display detailed invoice page in customer account
• Show full financial breakdown of an invoice
• Track payment state and transaction ID
• View tax, shipping, and discount details
• Check if invoice email was sent

Related Resources

• Get All Customer Invoices
• Download Invoice PDF
• Get Customer Orders
• Get Customer Profile