v1
latestOpenAPI 3.0.12026-07-24310590875.6 KBrecurringbills
Replace a recurring bill
Update the number of line items in a recurring bill. You can also update other recurring bill details.
You can use the PUT operation to add, remove, or replace the number of line items in a recurring bill. 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 bill.
- When you omit an existing line item id, the line item is removed from the bill.
When a recurring bill is modified, all future bills are automatically changed.
put/v3/recurringbills/{recurringBillId}
Path parameters
recurringBillIdstring required
BILL-generated ID of the recurring bill. The value begins with btp.
Example:{{recurring_bill_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
{
"vendorId": "{{vendor_id}}",
"schedule": {
"period": "MONTHLY",
"frequency": 1,
"nextDueDate": "2026-12-31",
"endDate": "2027-11-01",
"daysInAdvance": 5
},
"recurringBillLineItems": [
{
"amount": 19.99,
"description": "Monthly subscription"
},
{
"amount": 4.99,
"description": "Decaf black tea (10 bags)"
}
],
"paymentInformation": {
"bankAccountId": "{{org_bank_account_id}}"
}
}Response
Replace a recurring bill response