Skip to content
BuildBase
HTTP API menu

Change the signed-in user's own plan, or start a checkout for it

With a Stripe subscription, changes it to planVersionId prorated (optionally at the preview's prorationDate) and may answer paymentRequired with the invoice...

Warning

Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

PATCH/api/v1/public/me/subscription

Sign-in
A signed-in user's session: send the session id in the x-session-id header.
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

With a Stripe subscription, changes it to planVersionId prorated (optionally at the preview's prorationDate) and may answer paymentRequired with the invoice to pay; with none yet, answers a checkout session instead. Answers 403 when the org turned the interval switch off, 409 when another change is pending or being made, Stripe ended the subscription instead (SUBSCRIPTION_ENDED_ON_PLAN_CHANGE), the app has no Stripe account or the idempotency key was reused, and 503 when the tax setting could not be read. Behind the money gate (403 EMAIL_NOT_VERIFIED in the management tenant).

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
planVersionIdstringYesformat ObjectID-
billingIntervalstringNoone of "monthly", "yearly", "quarterly"-
currencystringNo3 to 3 characters-
successUrlstringNoformat uri-
cancelUrlstringNoformat uri-
promotionCodestringNo1 to 64 characters-
prorationDatestringNoformat date-time-
uiModestringNoone of "hosted", "embedded"-
returnUrlstringNoformat uri-
localestringNo2 to 35 characters, matches ^[A-Za-z]{2,3}([-_][A-Za-z0-9]{1,8})*$-

Example request

Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.

curl -X PATCH "https://api.console.buildbase.app/api/v1/public/me/subscription" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "planVersionId": "YOUR_PLAN_VERSION_ID"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/me/subscription',
  {
    method: 'PATCH',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      planVersionId: 'YOUR_PLAN_VERSION_ID',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
import os

import requests

response = requests.patch(
    "https://api.console.buildbase.app/api/v1/public/me/subscription",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "planVersionId": "YOUR_PLAN_VERSION_ID",
    },
    timeout=30,
)
response.raise_for_status()
data = response.text

Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

Errors

Each refusal, what it means, and what to do. The request changed nothing.

400 Bad Request

What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.

What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.

Example
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}

Events

A successful call can send these webhook events to the endpoints that subscribe to them: