Skip to main content
PATCH
Update an Invoice

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id
string | null

Optional external entity identifier that performed the action

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

invoice_id
string<inv_string>
required

The id of the invoice

Example:

"inv_WQMDNUHpBThYSNh4AprDBo"

Body

application/json
status
enum<string> | null

The new status of the invoice

Available options:
open,
paid,
uncollectible,
voided,
refunded,
partially_refunded
Example:

"open"

line_changes
InvoiceLineChanges · object | null

The changes to the lines of the invoice

tags
Tags · object | null

Inline tag input to merge into the invoice's tags. Each key is a tag field name that must already exist. A string upserts a single value and replaces all current values for that field. A list of {value, amount} objects replaces all current values for the field with the supplied set. A null (or empty list) removes all of the invoice's values for that field. Fields not mentioned are left untouched. Per-field amounts follow the default rules (single value -> invoice total; N values without amounts -> invoice total / N; mixed is rejected) and the per-field sum must not exceed the invoice total.

Example:

Response

Successful Response

data
InvoicePublic · object
required