Skip to content
Coritan Docs

Create an organization

Create an organization from your Coritan account, choose its slug and billing mode, and open its dashboard.

View as Markdown

Create an organization when you want to sell Coritan products under your own brand. The account that creates it becomes its owner, and the organization opens in the dashboard ready for products, customers and members.

  • Sign in to the Coritan account that should own the organization. The resources behind the products you link to Coritan's run on this account, and only this account can delete the organization later.
  • Choose a slug. It appears in every Organization API path and cannot be changed after the organization is created.
  • Decide how your customers will pay. How organizations work compares the three billing modes, and you can change the mode later in Settings.
  1. Go to Organizations in the dashboard and select New organization…. Once account plans open on your account, the page is called Reseller program and the account menu opens it. When you already have an organization, you can also choose New organization… in the sidebar's organization block, in its Switch organization menu or at its foot.
  2. Enter a Name of 2–255 characters. Customers see it on your storefront.
  3. Check the Slug. The dashboard fills it in from the name until you edit it. It takes 2–100 lowercase letters, numbers and hyphens, and starts and ends with a letter or a number, such as acme.
  4. Choose a Billing mode: Platform merchant of record, Own gateway or Hybrid.
  5. Select Create organization.

The dashboard confirms that the organization was created and opens its Overview tab. You are its owner. The organization is active, and Coritan has set its tier and limits, which the list of organizations and the Overview tab show. It pays the platform cut, tiered by its monthly volume, on the money its customers pay it, and it pays for compute on the Usage billing basis: the wholesale rate for what its customers' servers use (The reseller program's terms, and See what your customers' use costs you).

Next, set it up:

  1. Add your name, logo, colours, storefront domain and support details in Settings.
  2. Set up products and pricing.
  3. Invite members to help you run it.
Slug already taken
Another organization uses that slug. Choose a different one.
Enter a slug of at least two characters: lowercase letters, digits and hyphens.
The slug is shorter than two characters once the dashboard has removed what a slug cannot hold. Type a longer one.
422 from the API
The slug breaks the pattern, for example by ending in a hyphen, the name is shorter than two characters, or billing_mode is not one of platform_mor, own_gateway and hybrid. A body that still sends platform_fee_percent is refused too: the platform cut replaced the per-organization fee.

Create the organization with your Coritan access token. The body takes name, slug and, optionally, billing_mode (platform_mor when you leave it out, or own_gateway or hybrid).

Shell
curl -X POST https://api.coritan.com/api/v1/orgs \
  -H "Authorization: Bearer $CORITAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Hosting", "slug": "acme", "billing_mode": "platform_mor"}'

The answer is 201 with the organization:

JSON
{
  "id": 42,
  "slug": "acme",
  "name": "Acme Hosting",
  "tier": "starter",
  "status": "active",
  "billing_mode": "platform_mor",
  "platform_owned": false,
  "max_customers": 100,
  "max_services": 500,
  "max_custom_products": 50,
  "my_role": "owner"
}

The values of tier and the max_ limits are the ones Coritan set for your organization. platform_owned is true only for Coritan's own organizations, which pay no platform cut and no usage charge. Read the organization again at any time with GET /api/v1/orgs/acme, and list every organization you belong to with GET /api/v1/orgs, newest first, each with your role in my_role.

API operations on this page

MethodPathWhat it does
POST/api/v1/orgsCreate an organization you own
GET/api/v1/orgs/{org_slug}Get organization