Commet
  • Pricing
Log InTry out
Create adjustment invoice POSTDownload invoice PDF GETGet invoice GETList invoices GETSend invoice email POSTUpdate invoice status PUT
System status
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Create adjustment invoice

Create a one-off adjustment invoice. Use a negative amount for a credit.

POST
/invoices

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
Length1 <= length
amount*integer
Range-9007199254740991 <= value <= 9007199254740991
description*string
Length1 <= length
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"  }}

Update feature PUT

Update a feature's name, description, or unit name. At least one field must be provided.

Download invoice PDF GET

Generate a signed URL to download the invoice as a PDF. The URL expires after 7 days.