Accounts for your customers

Your app can create Exayard companies for customers who work only through your product. Your company owns them and pays for the AI work done in them. On the Developer page they are listed under Accounts for your customers.

These calls name no company. They act for your app's own company.

Create, list and release

• POST /v1/organizations with { "name": "Harbor Glass", "country": "DE", "currency": "EUR", "measurementSystem": "metric" } creates one. Only name (1 to 200 characters) is required; country is two letters. The answer (201) is the company plus installedApps: every active app of your company for the same product is installed in it with all of its scopes.
• GET /v1/organizations lists the open companies your company owns, with limit and cursor.
• DELETE /v1/organizations/{id} releases one: its installs are revoked and the company is closed. The answer is { "organizationId": "…", "installsRevoked": 1 }. A company yours does not own, or one already released, answers 404 not_found.

To act in one of them, send its organizationId as the Exayard-Organization-Id header with a key whose company scope is "every company that installed this app" (see Apps and keys).

Who may call

Your app, with one of its keys, or a person signed in through your app who is an admin of your company. Anyone else gets 403 forbidden. Your company can own 1,000 open companies unless Exayard sets another limit. Past it, creating one answers 403 partner_company_limit_reached.

How these companies work

• Your company pays. AI work in one of them is charged to your company and booked with the company it ran in, so usage reads back per company. When your company runs out, the answer is 402 usage_limit_reached with limit: "partner".
• They follow your plan. Each one gets your company's plan when it is made and on every plan change. It gets no Free monthly AI usage of its own.
• There are no discounts. Your company pays the standard price for work in the companies it owns.
• They have no people. Only your company's own apps work in them; no other app can be installed there.