Client API: Partners

Every Client API operation tagged Partners.

View as Markdown

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.

Operations

Method	Path	Summary
GET	`/api/v1/partners/terms`	The reseller program's terms as they stand today

The reseller program's terms as they stand today

Section titled The reseller program's terms as they stand today

GET /api/v1/partners/terms

The reseller program's terms as they stand today. No sign in needed.

The cut, the wholesale discount and the usage rates are the same for every organization that sells, except Coritan's own, which pay no cut and buy no wholesale. Our staff can raise a limit for one organization. A figure the platform does not set is null. The answer is the same for everyone who asks, and a shared cache may keep it for up to a minute.

Responses

Section titled Responses

Status	Meaning
`200`	Success.

Fields of a 200 response:

Field	Type	Description
`platform_cut`	PlatformCut	Coritan's cut of the money an organization's customers pay it, store and hosting alike: the percent of the tier the month's volume falls in, on that whole volume. Coritan's own organizations pay nothing.
`platform_cut.tiers`	array of PlatformCutTier	The tiers, lowest volume first.
`platform_cut.currency`	string	The currency the tiers' bounds are in.
`platform_cut.basis`	string	One sentence saying what a month's volume is.
`wholesale_discount_percent`	number	How far below list price an organization buys the hosting it resells. It sets its own price at or above that wholesale price and keeps the difference, less the cut.
`payout_schedule`	string or null	How often we pay out what our gateways collected: `monthly`, or null when payouts have no regular schedule.
`payout_minimum`	number or null	The smallest payout we make, or null when we pay any amount above zero.
`currency`	string	The currency we pay out in.
`usage`	PartnerUsage	What an organization on the usage basis pays for compute. Each rate is the list rate less `wholesale_discount_percent`. Coritan's own organizations pay nothing.
`usage.new_organization_basis`	string	The billing basis a new organization starts on: `usage`.
`usage.currency`	string	The currency of the rates.
`usage.performance_multiplier`	number	Performance sizes of Cloud Compute and game servers cost this many times the memory, CPU and disk rates.
`usage.rates`	array of PartnerUsageRate	What an organization on the usage basis pays for the compute its customers use. It has no free amounts: the first unit is charged.
`limits`	PartnerLimits	What a new organization may have. Our staff can raise a limit for one organization.
`limits.customers`	integer or null	How many customers a new organization may have.
`limits.services`	integer or null	How many services its customers may have between them.
`limits.products`	integer or null	How many products of its own it may sell.