UUpward API
v1
GET/api/public/v1/billing/plans
Requires x-auth-token

List plans

The plans your company offers, with the plan_id to use in Set a plan.

Response notes

  • name is the name the company set in its pricing.
  • plan_id is the fixed platform id you pass to Set a plan.
  • Plans the company switched off are not listed.
  • billing_api_enabled shows whether Sign Up / Payment Link is on (required by Set a plan).

Query parameters

This endpoint takes no parameters.

Responses

200OKPlans the company offers.
{
  "success": true,
  "billing_api_enabled": true,
  "currency": "USD",
  "plans": [
    { "plan_id": "free", "name": "Basic", "monthly_price_cents": 0, "annual_price_cents": 0, "is_free": true },
    { "plan_id": "starter", "name": "Growth", "monthly_price_cents": 1900, "annual_price_cents": 19000, "is_free": false }
  ]
}
401UnauthorizedMissing or invalid API key.
{ "success": false, "error": "Invalid API key" }
GET/api/public/v1/billing/plans

Kept in this tab only — never stored, and never written into the copied code samples.

ResponseNot sent yet