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

Get invoice

Retrieve a single invoice by its public ID, including line items.

GET
/invoices/{id}

Retrieve a single invoice by its public ID, including line items.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/invoices/string"
{  "success": true,  "data": {    "id": "string",    "customerId": "string",    "subscriptionId": "string",    "invoiceNumber": "string",    "status": "draft",    "invoiceType": "recurring",    "currency": "string",    "subtotal": -9007199254740991,    "discountAmount": -9007199254740991,    "creditApplied": -9007199254740991,    "taxAmount": -9007199254740991,    "total": -9007199254740991,    "periodStart": "2019-08-24T14:15:22Z",    "periodEnd": "2019-08-24T14:15:22Z",    "issueDate": "2019-08-24T14:15:22Z",    "dueDate": "2019-08-24T14:15:22Z",    "planName": "string",    "memo": "string",    "poNumber": "string",    "reference": "string",    "metadata": {      "property1": null,      "property2": null    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "lineItems": [      {        "lineType": "plan_base",        "featureName": "string",        "description": "string",        "quantity": -9007199254740991,        "unitAmount": -9007199254740991,        "amount": -9007199254740991,        "includedAmount": -9007199254740991,        "usedAmount": -9007199254740991,        "overageAmount": -9007199254740991,        "discountType": "string",        "discountValue": -9007199254740991,        "discountName": "string",        "chargeType": "standard"      }    ],    "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"  }}

Download invoice PDF GET

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

List invoices GET

List invoices with cursor-based pagination. Filter by customer, status, or subscription.