Client API: Features

The dashboard areas this storefront shows, and whether account plans apply to your account. Also what a visitor reads before signing in: the plans with their prices and limits, what can be ordered right now, and the figures the terms state. Needs no auth.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Client API reference.

GET /api/v1/availability

What can be ordered right now. No sign in needed.

products has an entry for each product GET /api/v1/products lists, by its slug: orderable is whether we would accept an order today, and reason says why not. It reads the same checks an order does: a plan that is not open, a server plan with no room, mail with no capacity, a region with no storage and a floating IP with no stock. deploy-usage stands for App Deployment. locations lists each place a server can be sold, with the hardware tiers that have room there now. storage_regions lists the regions with Object Storage and whether each is open. mail and relay say whether a mail cluster can take a new service, and whether we sell the product at all. performance.stock is whether any Performance plan can be ordered, and ips whether floating IP addresses are in stock, for each family. Answers are reused for 30 seconds.

Fields of a 200 response:

GET /api/v1/features

The dashboard areas this storefront shows, and whether account plans apply. No sign in needed.

The answer is {flags: {name: true or false}, plans_v2, gates}. flags names each area of the dashboard (vps, mail, storage and the rest) and whether it shows. plans_v2 is true when the Free, Pro and Business plans, their limits and their prompts apply: to your account when the request carries your session, and otherwise to someone who signs up now. A token that is not valid reads as no session.

gates says whether what a page may promise is there now: mail_enabled (we sell Mail Hosting and SMTP Relay), mail_cluster_active and relay_cluster_active (a mail cluster can take a new service), storage_regions (the codes of regions where Object Storage is open), ips_stock (a floating IP address is in stock), referrals (accounts get a referral link), github_app (App Deployment can connect GitHub), snapshots (Snapshot Storage is on) and leads (we email each new enquiry). A gate we cannot read is false. GET /api/v1/availability has the detail for each product.

On an organization's storefront the answer is {"flags": {}, "plans_v2": false}: those storefronts keep their own switches.

GET /api/v1/plans

The account plans, their prices and what each allows. No sign in needed.

Free, Pro, Business and Enterprise, in that order, with the same limits as the signed-in GET /api/v1/account/plan. stage is who plans apply to (off, staff, new or all), and open whether they apply to someone who signs up now. While open is false, no plan has orderable true and no plan limit is checked. Prices are numbers in currency. A plan we sell through our sales team has no price. The answer is the same for everyone, so shared caches may keep it for a minute.

Fields of a 200 response:

GET /api/v1/terms-facts

The figures our terms and pricing pages state. No sign in needed.

Each is read from the setting or record that decides it, so a page that quotes it cannot disagree with how the platform behaves. hourly_unlock_deposit is the one deposit a prepaid account makes before it starts anything billed by the hour or by use. payment_methods and currencies list what we take now. support.first_response_targets is the reply target in minutes for each plan. tax_statement says whether invoices carry tax. domain_renewal_window_days is how early auto-renew renews a domain. retention holds how many days visit records are kept, and is left out when we cannot say.

Fields of a 200 response: