Create adjustment invoice
Create a one-off adjustment invoice. Use a negative amount for a credit.
Create a one-off adjustment invoice. Use a negative amount for a credit.
Authorization
ApiKeyAuth x-api-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
customerId*string
amount*integer
description*string
metadata?
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/invoices" \ -H "Content-Type: application/json" \ -d '{ "customerId": "string", "amount": -9007199254740991, "description": "string" }'{ "success": true, "data": { "id": "string", "customerId": "string", "invoiceNumber": "string", "status": "draft", "invoiceType": "recurring", "currency": "string", "subtotal": -9007199254740991, "taxAmount": -9007199254740991, "total": -9007199254740991, "issueDate": "2019-08-24T14:15:22Z", "dueDate": "2019-08-24T14:15:22Z", "memo": "string", "metadata": { "property1": null, "property2": null }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "object": "invoice", "livemode": true }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}