The invoice to update is selected by the
id field in the request body, not
by the {uuId} segment in the URL path. The path segment is cosmetic and is
ignored by the API — always send the target invoice id in the body.Authorization
Example:
Authorization | Bearer Paste-Your-API-Key-HereRequest Body
A unique identifier obtained when creating an invoice. This selects the invoice
to update (the
{uuId} URL segment is ignored).Example:6f8c19ff-5b97-4792-aa89-d2a12797b356List of invoice items.
Quantity of the item.
Price per item.
Description of the item.
Description or notes related to the invoice.
Invoice expiration time in ISO 8601 format (UTC).
Additional notes for the invoice.
Tax amount applied to the invoice.
Restrict the invoice to a specific payment method.
Cashtag associated with the invoice.
Additional custom data attached to the invoice.
Response
Successful ResponseMain Structure (Root)
Status code form API.
Status message that describes the status code.
The updated invoice data.
data Structure (Object)
Unique invoice ID.
The URL that customers can access to open the invoice.
Errors
Returned when the API key is missing or invalid:
{ "statusCode": 401, "messages": "Unauthorized" }.Returned when no invoice matches the provided
id:
{ "statusCode": 404, "messages": "Invoice not found" }.Returned when the invoice has already been paid and can no longer be edited:
{ "statusCode": 409, "messages": "Transaction already paid. Cannot edit invoice." }.