Top-up Receipt (PDF)
The receipt for one prepaid-balance top-up of the active account, as a PDF. It shows the amount credited to the balance, the tax, the total charged, the date paid, the payment reference, the seller details and the account's billing details. It carries the same facts as the receipt email sent when the top-up was credited.
Receipts for subscription invoices are a separate route: GET /v1/billing/invoices/{id}/receipt.pdf.
Path parameters
uuid string (uuid) Req
The
uuid of a type: "topup" ledger row from GET /v1/billing/balance/transactions.Deprecated: the legacy integer id is still accepted in the path until the sunset, answered with Deprecation and Sunset headers. Use the uuid.
Query parameters
inline string
1 serves the PDF for viewing in the browser instead of as a download.Response (200 OK)
application/pdf, file name Receipt-<receipt number>.pdf. Requires billing:read on the account.
Errors
400 Bad Request
An integer id after the sunset (
integer_id_unsupported).403 Forbidden
The caller lacks
billing:read on the active account.404 Not Found
No such row, the row isn't a top-up, or it belongs to another account.
502 Bad Gateway
The payment couldn't be read from the payment provider. No partial receipt is returned; retry later.
Request
curl "https://api.ngris.com/v1/billing/balance/topups/019aacc2-b7b2-7c19-a465-f1466c06fce4/receipt.pdf" \
-H "X-API-KEY: <your_api_key>" \
-o receipt.pdf