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

Update invoice status

Mark an outstanding invoice as "paid" or "void". Cannot change the status of already paid or voided invoices.

PUT
/invoices/{id}/status

Mark an outstanding invoice as "paid" or "void". Cannot change the status of already paid or voided invoices.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Value in

  • "paid"
  • "void"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/invoices/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "paid"  }'
{  "success": true,  "data": {    "id": "string",    "status": "draft",    "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"  }}

Send invoice email POST

Send the invoice to the customer via email.

Cancel a payment link POST

Cancel a pending payment link so it can no longer be paid. Only a link that has not been paid or started processing can be canceled; canceling an already canceled link is a no-op. Charges cannot be canceled.