Cancel a client subscription

Cancel the subscription of a client company. A client on a Leexi trial has its trial ended immediately; an open Stripe subscription (active, trialing, incomplete, past_due, unpaid or paused) is canceled with proration when you bill your clients yourself (independent reseller), and answers 422 when billing goes through Leexi. A client with nothing to cancel is left untouched and answers 200 with the message No subscription to cancel. The request body is ignored.

delete/reseller/companies/{company_uuid}/subscription

Request

Base URL: https://public-api.leexi.ai/v1
URL: https://public-api.leexi.ai/v1/reseller/companies/{company_uuid}/subscription
Auth: API key in header Authorization

Path parameters

company_uuidstring required

UUID of one of your client companies.

Response

200

messagestring

successboolean

Example response

{
  "data": {
    "active": true,
    "created_at": "2024-06-14T11:00:33.534Z",
    "industry": "consulting",
    "name": "Client One",
    "reseller_external_id": "CLIENT-1",
    "updated_at": "2024-06-14T11:00:33.534Z",
    "uuid": "c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12",
    "subscription": {
      "status": "leexi_trialing",
      "active": true,
      "license": "business",
      "interval": "year",
      "currency": "eur",
      "trial_end": 1767222000,
      "seats": {
        "billed": 4,
        "max": 10,
        "min": 2
      },
      "subscription_required": true
    }
  },
  "message": "Company successfully updated",
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.