Mark invoice paid
POST
/v1/invoices/{invoice_id}/pay
Mark an invoice as paid.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” invoice_id
required
Invoice Id
string format: uuid
Responses
Section titled “ Responses ”Successful Response
InvoiceResponse
object
id
required
Id
string format: uuid
invoice_number
required
Invoice Number
string
customer_id
required
Customer Id
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
tax_amount_cents
required
Tax Amount Cents
string
total_cents
required
Total Cents
string
prepaid_credit_amount_cents
required
Prepaid Credit Amount Cents
string
coupons_amount_cents
required
Coupons Amount Cents
string
progressive_billing_credit_amount_cents
required
Progressive Billing Credit Amount Cents
string
currency
required
Currency
string
line_items
required
Line Items
Array<object>
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Invoice cannot be marked paid in current state
Unauthorized – invalid or missing API key
Invoice not found
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context