Update Draft Ad Hoc Invoice

Updates an ad hoc invoice while it is in the draft state.

Important: only invoices with the adhoc role and draft status can be updated. Any other invoice — issued, or with a different role (e.g. renewal, signup) — cannot be updated through this endpoint and the request returns a 422 error. If the invoice does not belong to the provided subscription, a 404 error is returned.

Only the attributes submitted in the request are changed — omitted attributes keep their current values.

Line Items

The line_items array describes changes to the invoice's line items. Line items not referenced in the array remain unchanged.

Adding a line item

A line item without a uid is added to the invoice. The same line item types and options as on invoice creation are supported (custom items, product_id, component_id, price points, period date ranges, taxes).

Updating a line item

A line item with the uid of an existing line item updates that line item with the submitted attributes. Amounts and taxes are recalculated.

Removing a line item

A line item with a uid and "_destroy": true is removed from the invoice. Other line items remain unchanged.

Referencing a uid which does not exist on the invoice returns a 422 error.

Coupons

When the coupons key is present, the submitted coupons replace all discounts currently applied to the invoice. Send an empty array to remove all discounts. Coupon options are the same as on invoice creation.

Invoice Options

Issue Date and Net Terms

The issue_date parameter can be sent to change the invoice's issue date. Only today or dates in the past are accepted. The date is interpreted and validated in your site's time zone, using the YYYY-MM-DD format. The net_terms parameter indicates the number of days after the issue date on which the invoice is due. The due date is recalculated whenever the issue date or net terms change.

Addresses

The seller, shipping and billing addresses can be sent to replace the addresses on the invoice. Each address requires to send a first_name at a minimum in order to work. Taxes are recalculated after an address change.

Memo and Payment Instructions

A custom memo can be sent with the memo parameter. Likewise, custom payment instructions can be sent with the payment_instructions parameter.