v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

recurring-invoices

Update a recurring invoice

Update details about a recurring invoice line item. You can also update other recurring invoice details.

You can use the PATCH operation to modify line item details, such as amount and description. The recurring invoice line item id does not change with a PATCH operation.

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

patch/v3/recurring-invoices/{recurringInvoiceId}

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

Request body

customerIdstring

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

paymentTermIdstring

descriptionstring

User-generated invoice number. This value can be your chosen number scheme or invoice due date.

sendEmailboolean

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

Example request

{
  "recurringInvoiceLineItems": [
    {
      "id": "{{recurring_invoice_line_item_id01}}",
      "amount": 22.99,
      "description": "Monthly subscription (amount updated)",
      "quantity": 1
    }
  ]
}

Response

Update 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