BIbill
recurringbills

Get recurring bill details

Changed on

Get details about an existing recurring bill.

get/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}}

Response

Get recurring bill details 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

vendorNamestring

Vendor name

Changes

  • 54edddceb0a5Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status