API reference · Invoices
Get an invoice
GET/v1/invoices/{invoiceId}
Retrieve information about an invoice.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
invoiceId#stringin pathrequired
Response
200 · InvoiceNo field is described in the spec.
invoiceId#stringalways returnedfiscalId#stringalways returnedstatus#InvoiceStatusPENDINGPOSTEDPAYMENT_DUEPAIDNOT_PAIDVOIDEDtotal#integer (int64)date#string (date-time)plan#stringdonationVolume#integer (int64)donationFee#integer (int64)subscriptionFee#integer (int64)chargesFee#integer (int64)addonsFee#integer (int64)tax#integer (int64)taxItems#objectaccountId#stringalways returnedcampaignId#stringcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returned
Errors
401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }404Not Found
{ "statusCode": 404, "message": "Not Found" }
curl -X GET https://api.sandbox.charitips.com/v1/invoices/<invoiceId> \ -H "Authorization: Bearer $CHARITIPS_TOKEN"Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.