Update a recurring bill

patch

https://gateway.stage.bill.com/connect/v3/recurringbills/{recurringBillId}

Update details about a recurring bill line item. You can also update other recurring bill details.

You can use the PATCH operation to modify line item details, such as amount and description. The recurring bill line item id does not change with a PATCH operation.

When a recurring bill is modified, all future bills are automatically changed.

Path Params

recurringBillId

string

required

length ≥ 1

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

Body Params

vendorId

string

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

description

string

length ≤ 4000

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

schedule

object

Recurring bill scheduling information

recurringBillLineItems

array of objects

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

sessionId

string | null

API session ID generated with /v3/login

devKey

string | null

Developer key generated with your BILL developer account

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update a recurring bill response

4XXList of errors.

5XXList of errors.