Skip to main content
PATCH
cURL
Mark an outstanding invoice as “paid” or “void” and return the updated invoice. Cannot change the status of already paid or voided invoices.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

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
predeterminado:2026-08-27

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

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
status
enum<string>
requerido
Opciones disponibles:
paid,
void

Respuesta

Success

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