Update bill

Update an existing bill.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Update a draft bill. Only bills in Draft status can be updated. When line items are provided, they replace all existing line items entirely.

Example: Correct a line item amount on a draft bill before finalizing it.

Constraints

  • Only draft bills can be updated — finalized and paid bills return 400
  • period_start and period_end are required
  • When line_items are provided, all existing line items are replaced
  • Subtotal and total are recalculated from line items
Path Params
int32
required

The bill ID.

Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
integer

Change the vendor.

string
length between 3 and 3

Three-letter ISO currency code (e.g. usd, cad).

line_items
array of objects
length ≥ 1

Replacement line items. Replaces all existing line items when provided.

line_items
string
required
length ≤ 255

Line item description.

number
required
≥ 0.01

Quantity. Must be greater than 0.

number
required
≥ 0

Price per unit. Must be >= 0.

date
required

Billing period start date (YYYY-MM-DD).

date
required

Billing period end date (YYYY-MM-DD). Must be >= period_start.

string
length ≤ 1000
string
length ≤ 20

Purchase order number (max 20 chars).

metadata
object

Custom key-value metadata.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json