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

Get invoice

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

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.

GET
/invoices/{id}

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://commet.co/api/v1/invoices/string"

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

Invoice public ID

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







































{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
:
"string"
,
"currency": "string",
"subtotal": 0,
"discountAmount": 0,
"creditApplied": 0,
"taxAmount": 0,
"total": 0,
"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": "string",
"featureName": "string",
"description": "string",
"quantity": 0,
"unitAmount": 0,
"amount": 0,
"includedAmount": 0,
"usedAmount": 0,
"overageAmount": 0,
"discountType": "string",
"discountValue": 0,
"discountName": "string",
"chargeType": "string"
}
]
}
}