A valid request URL is required to generate request examples{
"invoices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "BRL",
"amount_minor": 123,
"status": "open",
"issued_at": "2023-11-07T05:31:56Z",
"paid_at": "2023-11-07T05:31:56Z",
"hosted_url": "<string>",
"provider": "stripe",
"provider_invoice_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List one customer's invoices
Requires billing:read. One customer’s invoices from the mirror, newest first by the gateway’s calendar — the dossier screen’s money column, on the same permission line as their credits and their entitlements.
A valid request URL is required to generate request examples{
"invoices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "BRL",
"amount_minor": 123,
"status": "open",
"issued_at": "2023-11-07T05:31:56Z",
"paid_at": "2023-11-07T05:31:56Z",
"hosted_url": "<string>",
"provider": "stripe",
"provider_invoice_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de caminho
The customer, resolved inside the environment above. An id from the other environment answers 404.
Parâmetros de consulta
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Page size. Values outside 1–200 fall back to 50.
1 <= x <= 200x >= 0Resposta
One page of the customer's invoices.
Show child attributes
Show child attributes