Organization API: Billing & Payouts: Billing

Part of Billing & Payouts.

PUT /api/v1/orgs/{org_slug}/billing/basis

Switch what Coritan charges you for compute, from the 1st of next month.

Send usage to pay wholesale rates on what your customers' servers use, or plans to pay wholesale on each plan they pay for. The change takes effect on the 1st of next month at midnight UTC, so no month mixes the two, and running servers are not touched. The answer is the basis in force now and the switch still to come in pending. Sending the basis you are on cancels a switch that has not happened yet. Look at GET /billing/basis/preview first.

Only the organization's owner can do this, and it is recorded in the audit log. Any other member gets 403, and Coritan's own organizations 409. A basis other than plans or usage answers 422.

application/json (required)

Fields of a 200 response:

GET /api/v1/orgs/{org_slug}/billing/basis/preview

What switching the billing basis would have meant over the last three months.

On the plans basis you pay Coritan wholesale on each compute plan your customers pay for, however much they use. On the usage basis you pay wholesale rates on what their servers use instead, and nothing on the plan lines of compute plans. Each month shows both figures in US dollars: plan_wholesale is what Coritan charged on compute plans and usage_estimate what the same customers' use would have cost.

Until we have three months of readings, a month without any assumes every server runs all month and uses 10% of its CPU. assumed is then true and assumption says so. effective_at is when a switch asked for now would start: the 1st of next month, so no month mixes the two. pending shows a switch you already asked for. Billing, admins and the owner. Coritan's own organizations have no basis to switch and answer 409.

Fields of a 200 response:

GET /api/v1/orgs/{org_slug}/billing/cut

What the organization pays the platform: the tiers, this month so far, the closed months and what the next hosting payout would settle.

this_month is the dict the admin console shows for the organization (volume in USD so far, the rate it pays now). months are the last twelve closed months, newest first. settlement is the preview of the next payout's window up to the start of this month, as the admin console's settlement preview answers it (it carries usage_total, the compute use charged, and earlier_shortfall, what it pays toward an earlier unpaid settlement invoice), or null when it cannot be worked out. payout is where that payout goes (_payout_destination). Coritan's own organizations are exempt: rate 0 and no wholesale. Billing, admins and the owner.

GET /api/v1/orgs/{org_slug}/billing/paynow

PUT /api/v1/orgs/{org_slug}/billing/paynow

Save org-owned PayNow store credentials (own_gateway / hybrid).

platform_fee_bps is refused with 422: the store sets no platform fee, since the platform cut on its money is settled monthly with the hosting settlement.

application/json (required)

Type: Body.

GET /api/v1/orgs/{org_slug}/billing/paynow/affiliates

POST /api/v1/orgs/{org_slug}/billing/paynow/affiliates

application/json (required)

Type: Body.

GET /api/v1/orgs/{org_slug}/billing/paynow/giftcards

POST /api/v1/orgs/{org_slug}/billing/paynow/giftcards

application/json (required)

Type: Body.

GET /api/v1/orgs/{org_slug}/billing/paynow/subscriptions

POST /api/v1/orgs/{org_slug}/billing/paynow/subscriptions/{subscription_id}/cancel

PUT /api/v1/orgs/{org_slug}/billing/usage-budget

Set the most your customers' compute use may cost you in a month, or remove it.

Send amount in US dollars as text ("100.00"), or null to remove the budget. The budget does not limit what customers run. We tell you at 80% and at 100% of it with a billing.usage_budget webhook (threshold, spent, amount, month), once a month each, and at 100% we pause new orders until you raise the budget or the month turns. Servers that already run keep running. The answer shows the budget and this month's spend so far.

Billing, admins and the owner. An amount that is not more than zero answers 422.

application/json (required)

Fields of a 200 response:

GET /api/v1/orgs/{org_slug}/billing/usage-cost

What your customers' compute use cost you in a month, by product and by customer.

On the usage basis Coritan charges wholesale rates on what your customers' servers use. This report adds that up in US dollars: totals.usage_wholesale is what you pay, totals.list what the same use costs at Coritan's list rates, totals.retail_revenue what the customers' plans bring in for the days their servers ran, and totals.margin the revenue less the usage, before the platform cut. by_product and by_customer split them. by_customer lists the limit customers with the worst margin first, and loses_money marks one whose use costs more than it pays. customers counts them all. budget is your monthly budget with the spend for the month asked, or null, and hold says whether new orders are paused.

A customer on a flat plan sees none of this, because it is your cost, so there is no portal route for it. Billing, admins and the owner. An organization on the plans basis has no usage rows and answers zeros.