Billing
A workspace is on one plan. Paid plans are monthly subscriptions through LinkPay, which only the workspace’s owners can start or cancel. What each plan includes is on Plans and limits.
List the plans
Section titled “List the plans”The plans on sale, Free, Pro and Scale, with their prices and limits. It needs no authentication.
{ "plans": [ { "id": "pro", "name": "Pro", "price_cents": 2900, "currency": "EUR", "interval": "month", "limits": { "mau": 10000, "mau_pause": 15000, "groups": 5, "apps_per_group": 10, "members": 10, "custom_domains": 2, "custom_providers": true, "webhook_endpoints": 10, "analytics": true, "development_mau": 1000, "captcha_every_signup": false, "daily_signups": null, "development_daily_signups": null, "retention_days": null } } ]}| Limit | Meaning |
|---|---|
mau |
Monthly active users the plan includes, across the workspace’s production environments. |
mau_pause |
Where new sign-ups pause until the month ends. Logins never stop. |
groups, apps_per_group |
App groups (apps with accounts of their own), and apps sharing one group. |
members |
Members of the workspace, pending invitations included. |
custom_domains |
Across the workspace. |
custom_providers, analytics |
Whether the plan has them. |
webhook_endpoints |
Per environment. |
development_mau |
Monthly active users of each development environment, on its own. |
captcha_every_signup |
Whether every sign-up solves a captcha. |
daily_signups, development_daily_signups |
New accounts a day in each production and development environment, or null for no cap. |
retention_days |
Days of audit log and daily activity kept, or null for a year of audit log. |
null means no limit.
Read the workspace’s billing
Section titled “Read the workspace’s billing”| Field | Meaning |
|---|---|
plan |
The workspace’s plan, shaped as above. |
plan_ends_at |
When the plan ends, if it is due to. |
pinned |
The plan is set by the operator and is not billed here. |
enabled |
Whether payments are set up on this installation. |
subscription |
{ plan, status, current_period_end, cancel_at_period_end, grace_ends_at, customer_email, portal_url }, or null. An API key gets it without customer_email, and a development key gets 403 for the whole page. |
usage |
{ month, mau, development[], groups, members, invitations, custom_domains }: what the plan’s limits count. |
signups_paused |
Whether the month’s active users have paused sign-ups. |
plans |
The plans on sale. |
When a payment fails, the plan holds for 7 days (grace_ends_at), then the workspace falls back to Free: nothing is deleted, but Free’s limits apply.
Start a checkout
Section titled “Start a checkout”| Field | Type | Meaning |
|---|---|---|
plan |
string | pro or scale. |
POST /v1/workspaces/{ws}/billing/checkout{ "plan": "pro" }
200{ "url": "…" }Send the owner’s browser to url, LinkPay’s payment page. It returns to the workspace’s Billing page with ?checkout=paid&plan=pro, or ?checkout=canceled. That address proves nothing: the payment counts once SeekAuth has heard of it from LinkPay (confirm).
Another plan is another subscription: the older one is cancelled at the end of the period it paid for.
Asking again within 15 minutes, before the checkout is paid, answers the same url: no second checkout is made. A new checkout counts against a budget of 10 an hour per workspace and 20 per developer across their workspaces (429 past that, with Retry-After).
| Status | code |
When |
|---|---|---|
| 400 | bad_request |
“this plan cannot be subscribed to” (Free, or an id that is not on sale) |
| 429 | rate_limited |
More than 10 new checkouts in an hour for the workspace, or 20 by the developer. |
| 409 | conflict |
“Billing is not set up on this installation.”, “This workspace’s plan is set by the operator and is not billed here.”, “The workspace is already on this plan.” |
| 502 | upstream_error |
“The payment service did not answer. Try again in a moment.” |
Check a payment
Section titled “Check a payment”Asks LinkPay for the workspace’s subscriptions now, rather than waiting for its notice or the next reconciliation, which runs every ten minutes. The answer is the same as reading the billing. At most 30 an hour per workspace (429 past that).
Cancel the subscription
Section titled “Cancel the subscription”Stops the subscription from renewing. The plan holds until the end of the period that was paid for, then the workspace returns to Free with nothing deleted. Answers 204.
| Status | code |
When |
|---|---|---|
| 409 | conflict |
“There is no subscription to cancel.”, “Billing is not set up on this installation.” |
| 429 | rate_limited |
More than 10 cancellations in an hour for the workspace, or 20 by the developer (each one asks LinkPay). |
| 502 | upstream_error |
LinkPay did not answer. |
At a plan’s limits
Section titled “At a plan’s limits”Creating something past the plan answers 402 plan_limit, with a message that names the plan and the next one: “The Free plan includes 1 app with accounts of its own. The Pro plan includes more.” Scale has no larger plan on sale, so the same answers 409 conflict, with a message of the form “A workspace can have {what} and no more. Write to us if that is not enough.”
The monthly active users never stop a login. At mau_pause, new sign-ups pause in production until the month ends or the workspace moves to a larger plan; owners get an email at 80% and at 100% of mau.