API Reference
System Status

Replace a recurring bill

put
https://gateway.stage.bill.com/connect/v3/recurringbills/

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.

Path Params
string
required
length ≥ 1

BILL-generated ID of the recurring bill. The value begins with btp.

Body Params
string
required
length ≥ 1

BILL-generated ID of the vendor. The value begins with 009.

string
length ≤ 4000

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

schedule
object
required

Recurring bill scheduling information

recurringBillLineItems
array of objects
required

Recurring bill line item information

recurringBillLineItems*
processingOptions
object

Payment processing options.

Note: Enabling recurring bill autoPayment requires an MFA-trusted API session. See MFA setup for information about the BILL MFA process.

paymentInformation
object

Payment information

Headers
string | null

API session ID generated with /v3/login

string | null

Developer key generated with your BILL developer account

Responses

Updated 29 days ago

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

Updated 29 days ago