Billing

The plans on offer

GEThttps://api.vaakyo.com/api/v1/billing/plans

Public active plans, with the workspace’s current one marked, priced in the workspace’s currency (price_per_minute_paise, and monthly_fee_paise, taken from credits every 30 days). can_switch says whether this caller (a workspace owner) can move to a plan at once with POST /api/billing/plan; custom plans go to sales (cta_url, else contact_email). A plan with a fee may include call minutes in each paid month (included_minutes); plan_minutes_left_seconds, plan_minutes_total_seconds and plan_minutes_cycle_end say where the current cycle stands.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the billing.view permission.

X-API-KeyAuthorization: Bearerbilling.viewworks 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.

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.

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request GET \
  --url 'https://api.vaakyo.com/api/v1/billing/plans?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.vaakyo.com/api/v1/billing/plans"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}

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

const response = await fetch("https://api.vaakyo.com/api/v1/billing/plans?timezone=Asia/Kolkata", {
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

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

{
  "detail": "rate limit exceeded; slow down"
}