List and Retrieve Subscription Invoices
List invoices for a subscription or retrieve a single invoice by its UUID.
List Invoices for a Subscription
GET /subscription/{id}/invoice returns all invoices for a given subscription in reverse-chronological order, as a bare array — see the response panel above for the full Invoice shape (status is open/paid/failed/void; the retry count field is paymentAttemptCount).
lines[] is present only when the plan prices one or more usage meters: one line for the base plan fee (no meterId) plus one line per metered add-on. Absent or empty for a flat-fee invoice — the top-level amount is then the whole charge, and each line’s own amount sums to it.
Example
Retrieve a Specific Invoice
GET /subscription/invoice/{id} retrieves a single invoice by its UUID, regardless of which subscription it belongs to. Authenticates the same way as every other endpoint (Authorization: Bearer prv_production_xxx / prv_sandbox_xxx).
Path Parameters
Query Parameters
Response
Returns a single invoice object with the same fields as described above.Errors
Example
Authorizations
Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).
Path Parameters
Subscription UUID.
Query Parameters
Your merchant account identifier.
Response
List of invoices
Invoice UUID.
The subscription this invoice belongs to.
open - awaiting payment; paid - settled; failed - all payment attempts failed; void - cancelled, no longer collectible.
open, paid, failed, void Invoice total in the currency minor units.
ISO 4217 currency code.
Decimal places for amount.
Start of the service period this invoice covers.
End of the service period this invoice covers.
Charge attempts made against this invoice, including dunning retries.
Per-attempt gateway results. Present on the single-invoice endpoint (GET /subscription/invoice/{id}).
Itemisation - present only when the plan prices usage meters: one base-fee line (no meterId) plus one per metered add-on. Absent/empty for a flat-fee invoice.