Delete an Invoice Schedule

Deletes a recurring invoice schedule. This operation requires merchant authentication.

"Soft" deletes a scheduled invoice from a merchant's account. The scheduled invoice will exist in the database, but will not be accessible by the merchant or customers. It sets the deleted_at field to the time of deletion, stopping the scheduled future charges. Deleting an invoice doesn't change its active state, but it sets next_run_at to null and sets future_occurrences to an empty set. Scheduled invoices with a value other than null in the deleted_at field are inaccessible to the merchant or customers.

Path Params
string
required
Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json