v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
recurring-invoices

Archive a recurring invoice

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

You can restore an archived recurring invoice with POST /v3/recurring-invoices/{recurringinvoiceId}/restore. There is no change when you archive an archived recurring invoice.

When a recurring invoice is modified, all future invoices are automatically changed.

post/v3/recurring-invoices/{recurringInvoiceId}/archive

Path parameters

recurringInvoiceIdstring required

BILL-generated ID of the recurring invoice. The value begins with rit.

Example:{{recurring_invoice_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 invoice response

idstring required

BILL-generated ID of the recurring invoice. The value begins with rit.

customerIdstring

BILL-generated ID of the customer. The value begins with 0cu.

paymentTermIdstring
descriptionstring

Recurring invoice line item description

archivedboolean

Set as true if the recurring invoice is archived

sendEmailboolean

Set as true to send an email to the customer when an invoice is created.

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time