Catalogue

Plans and prices

The plan catalogue. Needs a valid API key like every other route here; is_current marks the plan that key's account is on.

Every price is quoted in currency, which is always USD: this endpoint does not take a currency and does not convert. billable_currencies is the separate question of which currencies a subscription can be created in, and credit_package_currencies the same question for one-off credit packs. Those two lists differ, so offering a currency from the wrong one produces a checkout the customer cannot complete.

A white-label sub-account has no plan of its own. The route is open to sub-accounts (it is the public price list), but such an account spends a credit pool its parent allocated and holds no subscription. It gets current_plan: "sub_account" (agreeing with GET /v1/account), is_current: false on every plan, and a plan_note saying where the subscription lives. Do not present a plan as that account's, and expect 403 SUB_ACCOUNT_MANAGED from every subscription write.

get/v1/billing/plans

Request

  • Base URL: https://api.kawaa.com
  • URL: https://api.kawaa.com/v1/billing/plans
  • Auth: one of:
    • API key in header X-Api-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.kawaa.com/oauth/authorize, token URL https://api.kawaa.com/oauth/token, scopes: billing:read)

Response

The plans.

successunknown required

Example response

{
  "data": {
    "plans": [
      {
        "name": "Professional"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.