UUpward API
v1
POST/api/public/v1/billing/subscription
Requires x-auth-token

Set a plan

Record the plan someone bought in your own payment system.

Only available when the company turned on Sign Up / Payment Link in White Label settings. Identify the member with the `x-auth-user` header (their pagename or username) alongside your API key — this is whose subscription is set. The company owner's plan cannot be changed via the API; manage it from the company billing settings. Call List plans to see which plan_id values your company offers.

Body fields

plan_idstringrequired

Use a plan_id from List plans, e.g. starter.

billing_modemonthly | annualoptional

Defaults to monthly.

effective_fromstring (ISO 8601)optional

When the plan starts. Defaults to now.

referencestringoptional

Your own order or invoice number, stored on the history record.

Responses

200OKThe plan is active and the change is recorded.
{
  "success": true,
  "pagename": "johndoe",
  "planKey": "starter",
  "planName": "Starter",
  "startedAt": "2026-01-05T10:00:00.000Z",
  "renewsAt": "2026-02-05T10:00:00.000Z"
}
409External billing offThe company has not enabled its own payment links.
{ "success": false, "error": "Turn on Sign Up / Payment Link in White Label settings before using the billing API." }
409Company ownerThe company owner's plan cannot be changed via the API.
{ "success": false, "error": "The company owner's plan cannot be changed via the API; manage it from the company billing settings." }
POST/api/public/v1/billing/subscription

Use a plan_id from List plans, e.g. starter.

Defaults to monthly.

When the plan starts. Defaults to now.

Your own order or invoice number, stored on the history record.

ResponseNot sent yet