Cancel recurring invoice schedule
Cancel a schedule permanently. No further invoices are generated; already-generated invoices are unaffected. Terminal — a cancelled schedule cannot be resumed.
Authentication. An API key (x-dolfin-api-key) together with the x-dolfin-organisation-id header identifying the organisation, or a JWT Bearer token that carries the organisation in its claims.
Authorizations
An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.
Headers
Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).
Path Parameters
Response
OK
ISO 4217 currency code (e.g. GBP, USD, EUR)
Payment terms in days applied to every generated invoice. Null means each occurrence uses the organisation's default at generation time.
Weekly, Monthly, Quarterly, Annually When the next invoice will be generated. Null on Paused, Completed, and Cancelled schedules.
Active, Paused, Completed, Cancelled