Create a client company

Create a client company attached to your reseller account. The company is created with its settings and the license you choose, and starts a Leexi trial ending at trial_end.

post/reseller/companies

Request

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

Request body

industrystring

Industry of the client company.

namestring required

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 required

End of the Leexi trial as a Unix timestamp (seconds). Required. A date in the past creates the company with an ended trial.

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 created",
  "success": true
}

Changes

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