POST
Cancel invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoice_id
string<uuid>
required

Invoice ID

Body

application/json

Invoice lifecycle or line-item fields used to update invoice totals and status.

Request payload for cancel invoice.

reason
string | null

Operator-provided reason for a lifecycle action.

Maximum string length: 500

Response

Cancelled invoice

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.