BIbill
recurringbills

Replace a recurring bill

Changed on

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}

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/recurringbills/{recurringBillId}
  • Auth
    none declared

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 required

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

{
  "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

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

billsCountinteger required

Number of bills generated from this recurring bill

amountnumber

Recurring bill total amount

expiredboolean required

Set as true if the recurring bill is expired

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time

Changes

  • 54edddceb0a5Revision changes
    • info

      added the new optional request property /////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status