Update a client company

patch

https://public-api.leexi.ai/v1/reseller/companies/{uuid}

Update a client company attached to your reseller account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Example payload

Only the attributes you send are changed.

{
    "name": "Client Uno",
    "industry": "consulting",
    "trial_end": 1769900400,
    "company_setting": { "license_category": "starter" },
    "setting": { "locale": "en-US" }
}

Pushing trial_end to a future date restarts the Leexi trial of a company whose trial has ended. trial_end is locked while the company has an open Stripe subscription (active, trialing, incomplete, past_due, unpaid or paused) and answers 422; subscription_currency and the license constraints are locked while it has an active one.

An unknown subscription_interval, subscription_currency, setting.locale or setting.time_zone answers 422.

The subscription status cannot be set here: use Start a client subscription and Cancel a client subscription.

Setting active to false deactivates the company exactly like Deactivate a client company: read that page first. Setting it back to true only reopens the company record, its users and subscription are not restored.

📘
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

uuid

string

required

UUID of one of your client companies.

Body Params

active

boolean

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.

company_setting

object

industry

string

Industry of the client company.

name

string

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

reseller_external_id

string

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

setting

object

subscription_currency

string

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

subscription_interval

string

enum

Billing interval, month or year.

Allowed:

trial_end

integer

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).

Responses

401

402

429

Update a client company

Example payload

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`.

Example payload

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.

200200

400400

403403

404404

409409

422422

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`.