List credit notes
Returns credit notes, newest first. Filter by invoice or customer.
Returns credit notes, newest first. Filter by invoice or customer.
Authorization
api-key API key for merchant integrations. Send as Authorization: Bearer <your key>.
In: header
Query Parameters
Page number (1-based)
1 <= value <= 21474836471Number of items per page
1 <= value <= 10020Only credit notes of this invoice
Only credit notes of this customer
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/credit-notes"{ "data": [ { "id": "cn_3Nf8a2kLmPq9", "object": "credit_note", "number": "INV-000012-CN1", "status": "issued", "type": "pre_payment", "invoiceId": "string", "customerId": "string", "currency": "EGP", "reason": "duplicate", "memo": "string", "effectiveAt": "string", "lines": [ null ], "amount": -9007199254740991, "amountShipping": -9007199254740991, "discountAmount": -9007199254740991, "subtotal": -9007199254740991, "subtotalExcludingTax": -9007199254740991, "total": -9007199254740991, "totalExcludingTax": -9007199254740991, "totalTaxes": [ null ], "prePaymentAmount": -9007199254740991, "postPaymentAmount": -9007199254740991, "outOfBandAmount": -9007199254740991, "refunds": [ null ], "customerBalanceTransactionId": "string", "voidedAt": "string", "metadata": {}, "merchantId": "string", "createdAt": "string", "updatedAt": "string" } ], "totalCount": 0}Adjust a customer's balance POST
Gives the customer credit or takes it back. A negative amount is credit, which the customer's next invoice uses up.
Issue a credit note POST
Lowers the amount of an issued invoice. The credit first reduces what the customer still owes. For any part that was already paid, say where it goes: refundAmount, creditAmount and outOfBandAmount must add up to it.