Update a client company

Update a client company attached to your reseller account. Only the attributes you send are changed. Setting active to false deactivates the company, see Deactivate a client company.

patch/reseller/companies/{uuid}

Request

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

Path parameters

uuidstring required

UUID of one of your client companies.

Request body

activeboolean

Set to false to deactivate the client company. Deactivation cancels its subscription and deactivates every user. Setting it back to true only reopens the company record: users and subscription are not restored.

industrystring

Industry of the client company.

namestring

Name of the client company. Must not contain # or _.

reseller_external_idstring

Your own reference for this client company. Must be unique among your client companies.

subscription_currencystring

Billing currency, for example eur. Locked while a Stripe subscription is active.

subscription_interval'month' | 'year'

Billing interval, month or year.

trial_endinteger

End of the Leexi trial as a Unix timestamp (seconds). A date in the past marks the trial as ended, a date in the future (re)starts it. Locked while the client has an open Stripe subscription (active, trialing, incomplete, past_due, unpaid or paused).

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.