v1
latestOpenAPI 3.0.12026-07-24310590875.6 KBrecurring-invoices
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.
put/v3/recurring-invoices/{recurringInvoiceId}
Path parameters
recurringInvoiceIdstring required
BILL-generated ID of the recurring invoice. The value begins with rit.
Example:{{recurring_invoice_id}}
Headers
sessionIdstring nullable
API session ID generated with /v3/login
Example:{{session_id}}
devKeystring nullable
Developer key generated with your BILL developer account
Example:{{developer_key}}
Request body
Example request
{
"customerId": "{{customer_id}}",
"schedule": {
"period": "MONTHLY",
"frequency": 1,
"nextDueDate": "2026-12-31",
"endDate": "2027-11-01",
"daysInAdvance": 5
},
"recurringInvoiceLineItems": [
{
"id": "{{recurring_invoice_line_item_id01}}",
"amount": 19.99,
"description": "Monthly subscription",
"quantity": 1
},
{
"amount": 4.99,
"description": "Decaf black tea (10 bags)",
"quantity": 1
}
]
}Response
Replace a recurring invoice response