Replace a recurring invoice

Update the number of line items in a recurring invoice. You can also update other recurring invoice details.

You can use the PUT operation to add, remove, or replace the number of line items in a recurring invoice. A set of rules apply with the PUT operation.

  • When you add a new line item, a new line item id is generated in the invoice.
  • When you omit an existing line item id, the line item is removed from the invoice.

When a recurring invoice is modified, all future invoices are automatically changed.

Path Params
string
required
length ≥ 1

BILL-generated ID of the recurring invoice. The value begins with rit.

Body Params
string
required
length ≥ 1

BILL-generated ID of the customer. The value begins with 0cu.

string
length ≤ 4000

User-generated invoice number. This value can be your chosen number scheme or invoice due date.

schedule
object
required

Recurring invoice scheduling information

recurringInvoiceLineItems
array of objects
required

Recurring invoice line item information

recurringInvoiceLineItems*
boolean

Set as true to send an email to the customer when an invoice is created.

Headers
string | null

API session ID generated with /v3/login

string | null

Developer key generated with your BILL developer account

Responses

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