Update an existing invoice schedule, allowing changes to metadata, recurrence rules, or the schedule's active status.
Update an existing invoice schedule, allowing changes to metadata, recurrence rules, or the schedule's active status.
Key Features
Invoice Details
Modify invoice details, including subtotal, tax, and lineItems.
Schedule Control
Pause or resume a schedule by toggling the active status.
Recurrence Rules
Change the recurrence rule (rule) to update the schedule's frequency and timing.
Next Run Control
Clear or manually set the next_run_at field for resumed schedules.
Usage Guide
Pausing a Schedule
- Set
active=falseto pause the schedule. - When paused, the
next_run_atfield will automatically be set tonull. - No new invoices will be generated while the schedule is paused.
Resuming a Schedule
- Set
active=trueto resume a paused schedule. - A valid
next_run_atdate in the future must be provided when resuming. - Past dates for
next_run_atwill result in a validation error.
Response Structure
| Code | Response | Reason |
|---|---|---|
200 | Success | The schedule was successfully updated. |
400 | Bad Request | Invalid fields or missing required parameters. |
422 | Validation Error | DTSTART or next_run_at is in the past. |
500 | Internal Server Error | An unexpected server error occurred. |
Important Considerations
Active Status
- Pausing the schedule (
active=false) prevents further invoices from being generated. - To resume the schedule, provide a new
next_run_atdate in the future.
Recurrence Rules
- Follow the iCalendar RRule format for the
ruleparameter. - A properly formatted
DTSTARTin the future is mandatory.
Audit Trail
All changes to the schedule, including updates to metadata and status changes, are logged for tracking purposes.
Future Dates Only
Ensure all dates, such as next_run_at and DTSTART, are in the future to avoid validation errors.