Additional safety during subscription modifications
Subscription modification endpoints now support an optional boolean parameter: allow_invoice_credit_note_or_void
.
• Defaults to True
(maintains existing behavior).
• Set to False
to prevent modifications that would create a credit note or void an invoice. Instead, such requests will fail with a validation error.
When to use this
Certain modifications, like canceling a subscription mid-period with an in-advance fixed fee, typically generate credit notes. If you’re confident your modifications shouldn’t create these, set allow_invoice_credit_note_or_void=False
as a safeguard.
Equivalent to a Dry-Run
This functions similarly to sending a dry-run request and previewing changes first, which allows for more precise validation of side effects.
Supported Endpoints