Skip to main content
POST
cURL
Create a one-off adjustment invoice and return the created invoice. Use a negative amount for a credit.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Body

application/json
customerId
string
required
Minimum string length: 1
amount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
description
string
required
Minimum string length: 1
metadata
object

Response

Success

id
string
required
customerId
string
required
subscriptionId
string | null
required
invoiceNumber
string
required
status
enum<string>
required
Available options:
draft,
outstanding,
paid,
void,
uncollectible
invoiceType
enum<string>
required
Available options:
recurring,
overage,
plan_change,
adjustment,
credit_purchase,
balance_topup,
addon_activation,
one_time_payment,
reactivation,
resume,
prepayment
currency
string
required
subtotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
discountAmount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
taxAmount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
periodStart
string<date-time>
required
periodEnd
string<date-time>
required
issueDate
string<date-time>
required
dueDate
string<date-time>
required
memo
string | null
required
metadata
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
creditApplied
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
planName
string | null
required
poNumber
string | null
required
reference
string | null
required
lineItems
object[]
required
object
string
required
Allowed value: "invoice"
livemode
boolean
required