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

Create adjustment invoice

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

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.

POST
/invoices

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerId*string
1 <= length
amount*integer
description*string
1 <= length
metadata?
Length
Length

Response Body

application/json

curl -X POST "https://commet.co/api/v1/invoices" \  -H "Content-Type: application/json" \  -d '{    "customerId": "string",    "amount": 0,    "description": "string"  }'

application/json

application/json

Customer public ID

Amount in settlement scale (100 = $1.00). Negative for credit.

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

{
  "success": true,
  "data": {
    "object": "invoice",
    "livemode": true,
    "id": "string",
    "customerId": "string",
    "invoiceNumber": "string",
    "status": "string",
    "invoiceType": "string",
    "currency"














{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
:
"string"
,
"subtotal": 0,
"taxAmount": 0,
"total": 0,
"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"
}
}