API ReferenceInvoices
Get By Id
Authorization
AppApiKey AppApiSecret X-Api-Key<token>
Per-app API key. Sent together with the X-Api-Secret header. The key's mode (TEST or LIVE) selects the data partition — it is never taken from the request body.
In: header
X-Api-Secret<token>
Per-app API secret that pairs with X-Api-Key. Both headers are required on every app-facing call.
In: header
Path Parameters
id*integer
Response Body
*/*
curl -X GET "https://example.com/api/v1/invoices/0"{
"data": {
"id": 0,
"number": "string",
"status": "string",
"mode": "string",
"applicationId": 0,
"applicationName": "string",
"subscriptionId": 0,
"priceId": 0,
"customerReference": "string",
"customerName": "string",
"customerEmail": "string",
"customerPhone": "string",
"totalMinor": 0,
"amountPaidMinor": 0,
"amountDueMinor": 0,
"currency": "string",
"dueDate": "2019-08-24",
"issuedAt": "2019-08-24T14:15:22Z",
"lineItems": [
{
"id": 0,
"description": "string",
"qty": 0,
"unitAmountMinor": 0,
"lineTotalMinor": 0
}
],
"payments": [
{
"id": 0,
"reference": "string",
"status": "string",
"applicationId": 0,
"mode": "string",
"amountMinor": 0,
"currency": "string",
"gateway": "string",
"gatewayTxnId": "string",
"checkoutUrl": "string",
"redirectUrl": "string",
"invoiceId": 0,
"metadata": {},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"payableUrl": "string",
"metadata": {},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"meta": {
"success": true,
"message": "string",
"errorCode": "RESOURCE_NOT_FOUND",
"timestamp": "2019-08-24T14:15:22Z"
},
"pagination": {
"page": 0,
"size": 0,
"totalElements": 0,
"totalPages": 0
}
}