API Reference

Cancel a contract

post
https://app.shuttleglobal.com/c/api/instances/{instance_key}/contracts//cancel

Cancelling a contract will prevent future charges being created on a contract and stop all automated payments. A contract may still have an outstanding balance at time of cancellation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Contract ID

Body Params
boolean

If any outstanding amount should be written off. If not and there's an outstanding amount, the contract will transition to CANCELLING status

boolean

If automatic retries should be stopped for any outstanding amount. This will set next_payment to blank

Responses

Updated about 2 months ago

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

Updated about 2 months ago