v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

recurringbills

Create a recurring bill

Create a recurring bill.

See Recurring bills in the Guides section for more information, sample requests, and responses.

post/v3/recurringbills

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"
    }
  ],
  "processingOptions": {
    "autoPayment": true
  },
  "paymentInformation": {
    "bankAccountId": "{{org_bank_account_id}}"
  }
}

Response

Create 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