Cancel a client subscription

End a client company's trial or cancel its paid subscription

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

What happens depends on the client's current subscription:

  • On a Leexi trial: the trial ends immediately (subscription.status: leexi_trial_ended). Push trial_end back to a future date with Update a client company to restart it.
  • Open Stripe subscription (active, trialing, incomplete, past_due, unpaid or paused), billed by you (independent reseller): the subscription is canceled with proration (subscription.status: canceled), even when it is still chasing an unpaid invoice.
  • Open Stripe subscription, billed through Leexi: answers 422; contact your Leexi account manager.
  • Nothing to cancel (leexi_trial_ended, canceled, incomplete_expired or not_started): nothing changes, the endpoint answers 200 with the message No subscription to cancel.

The request body is ignored. Canceling the subscription does not deactivate the company or its users: see Deactivate a client company for that.

📘

Requires the write_clients permission scope on the API key of a reseller account.

❗️

A company that is not one of your clients, including your own reseller company, answers 404.

Path Params
string
required

UUID of one of your client companies.

Responses

401

401

402

402

429

429

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