v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

recurringbills

Update a recurring bill

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.

patch/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

vendorIdstring

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

descriptionstring

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

Example request

{
  "recurringBillLineItems": [
    {
      "id": "{{recurring_bill_line_item_id01}}",
      "amount": 22.99,
      "description": "Monthly subscription (amount updated)",
      "quantity": 1
    }
  ]
}

Response

Update a recurring bill response

idstring required

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

archivedboolean required

Set as true if the recurring bill is archived

vendorIdstring required

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

descriptionstring

Recurring bill description

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time