BIbill
recurringbills

Archive a recurring bill

Changed on

Archive a recurring bill. In the response, the archived field is set as true.

You can restore an archived recurring bill with POST /v3/recurringbills/{recurringbillId}/restore. There is no change when you archive an archived recurring bill.

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

post/v3/recurringbills/{recurringBillId}/archive

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/recurringbills/{recurringBillId}/archive
  • 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

Archive 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 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