Billing

Switch to another plan

POSThttps://api.vaakyo.com/api/v1/billing/plan

Move the workspace to a public, self-serve plan at once (workspace owners). A plan with a monthly fee takes the first month from credits now (402 when the credits don’t cover it) and then every 30 days, each with an invoice, and grants its included_minutes for each paid month (unused minutes don’t roll over); a plan without one ends the monthly charges. There is no proration and no refund of what was paid for the old plan. Custom plans are arranged with sales instead.

Authorization

A signed-in member with the billing.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearerbilling.manageworks before activation

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

plan_idstringrequired

1 to 64 characters

Response

200Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request POST \
  --url 'https://api.vaakyo.com/api/v1/billing/plan?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan_id": "plan"
}'

import requests

url = "https://api.vaakyo.com/api/v1/billing/plan"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}
payload = {
    "plan_id": "plan",
}

response = requests.post(url, params=params, headers=headers, json=payload)
print(response.status_code, response.json())

const response = await fetch("https://api.vaakyo.com/api/v1/billing/plan?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "plan_id": "plan"
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (billing.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}