Skip to content

Update invoice

PUT
/v1/invoices/{invoice_id}

Update an invoice.

invoice_id
required
Invoice Id
string format: uuid
InvoiceUpdate
object
status
Any of:
InvoiceStatus
string
Allowed values: draft finalized paid voided
due_date
Any of:
string format: date-time
issued_at
Any of:
string format: date-time
paid_at
Any of:
string format: date-time

Successful Response

InvoiceResponse
object
id
required
Id
string format: uuid
invoice_number
required
Invoice Number
string
customer_id
required
Customer Id
string format: uuid
subscription_id
required
Any of:
string format: uuid
status
required
Status
string
invoice_type
required
Invoice Type
string
billing_period_start
required
Billing Period Start
string format: date-time
billing_period_end
required
Billing Period End
string format: date-time
subtotal_cents
required
Subtotal Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
tax_amount_cents
required
Tax Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_cents
required
Total Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
prepaid_credit_amount_cents
required
Prepaid Credit Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
coupons_amount_cents
required
Coupons Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
progressive_billing_credit_amount_cents
required
Progressive Billing Credit Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
line_items
required
Line Items
Array<object>
object
key
additional properties
any
due_date
required
Any of:
string format: date-time
issued_at
required
Any of:
string format: date-time
paid_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized – invalid or missing API key

Invoice not found

Validation error