Create billing plan

POST/workspaces/{organizationId}/billing/plan

Path parameters

organizationIdstringrequired

Request body

application/json

planstringrequired

Allowed:freepaid

statusstring

Allowed:activepast_duecanceled

Responses

200

Updated billing account

organizationIdstringrequired

planstringrequired

Allowed:freepaid

statusstringrequired

Allowed:activepast_duecanceled

vortexCustomerIdstring | nullrequired

currentPeriodEndstring | nullrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

planstring*statusstring

Request

curl -X POST '/workspaces/string/billing/plan' \
  -H 'Content-Type: application/json' \
  -d '{
  "plan": "free",
  "status": "active"
}'

const response = await fetch("/workspaces/string/billing/plan", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"plan\": \"free\",\n  \"status\": \"active\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/billing/plan",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"plan\": \"free\",\n  \"status\": \"active\"\n}",
)

Response

{
  "organizationId": "string",
  "plan": "free",
  "status": "active",
  "vortexCustomerId": "string",
  "currentPeriodEnd": "string"
}