API overview
List the customer's invoices
Choose an operation to see its request, response shape, access rules and implementation source.
ReadAuthenticated
GET/api/v1/invoices
List the customer's invoices
Sanctum session or bearer token. Required bearer ability: invoices.read
Request
| Field | In | Rule |
|---|---|---|
page | Query string | Optional page number; default 1. No per_page or sort override. |
No request body.
curl --request GET "https://shop.example.test/api/v1/invoices" \
--header 'Accept: application/json' \
--header "Authorization: Bearer $API_TOKEN" \
--get \
--data-urlencode 'page=1'Response200
Success: 200
Response shape (notation, not a captured response)
{ data: Invoice[], links, meta }Common errors
| HTTP status | Meaning |
|---|---|
401 | unauthenticated: missing or invalid authentication. |
403 | unauthorized, insufficient_scope or ip_not_allowed: check account context, required ability and token IP policy. |
429 | rate_limited: back off before retrying, especially writes. |