Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
integrator
/
on-demand
/
cancel
Cancelling an instance
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/cancel \
  --header 'Client-Token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Method used to cancel an instance subscription.
When an instance is canceled, it will remain active until the end of the current billing cycle, which corresponds to the last day of the month. After the cycle ends, the instance will be automatically deactivated. Billing will continue normally until the end of this period.
To use Partner endpoints, provide the Partner Token in the Authorization field using the following format: Bearer <Partner-Token>It is not necessary to send the Client-Token in these requests.

Response

201

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.