Edit an Invoice Schedule

Update an existing invoice schedule, allowing changes to metadata, recurrence rules, or the schedule's active status.

Key Features

• Modify invoice details, including subtotal, tax, and lineItems.
• Pause or resume a schedule by toggling the active status.
• Change the recurrence rule (rule) to update the schedule's frequency and timing.
• Clear or manually set the next_run_at field for resumed schedules.

Usage Notes

Pausing a Schedule

• Set active=false to pause the schedule.
• When paused, the next_run_at field will automatically be set to null.
• No new invoices will be generated while the schedule is paused.

Resuming a Schedule

• Set active=true to resume a paused schedule.
• A valid next_run_at date in the future must be provided when resuming.
• Past dates for next_run_at will result in a validation error.

Updating Recurrence Rules

• Use the rule parameter to adjust the schedule's recurrence pattern.
• Ensure the new rule includes a valid DTSTART value in the future.

Invoice Metadata

• Update fields such as subtotal, tax, and lineItems to reflect new invoice details.
• Changes will apply only to future invoices generated by the schedule.

Response Structure

Important Considerations

Active Status:

• Pausing the schedule (active=false) prevents further invoices from being generated.
• To resume the schedule, provide a new next_run_at date in the future.

Recurrence Rules:

• Follow the iCalendar RRule format for the rule parameter.
• A properly formatted DTSTART in 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.