Read billing, trial allowance and linked Cloud credits

Reads the current organisation only. Requires billing.read. Unknown capacity or Cloud credit observations remain null and saving a card does not authorise paid usage. Once a card is saved, the read grants the welcome credit if the setup webhook has not.

GET /api/v1/org/billing/activation

Read billing, trial allowance and linked Cloud credits

Python

import requests

url = "https://platform.ankra.app/api/v1/org/billing/activation"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan_name": "<string>",
  "paid_usage_enabled": true,
  "trial_limit_vcpu": 1,
  "current_vcpu": 1,
  "observed_at": "2023-11-07T05:31:56Z",
  "can_unlock": true,
  "payment_method_ready": true,
  "terms": {
    "version": "<string>",
    "currency": "eur",
    "vcpu_rate_hourly": 1,
    "free_vcpu_allowance": 1,
    "flat_monthly_cents": 1
  },
  "cloud": {
    "state": "linked",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billing_url": "<string>",
    "credits_state": "ready",
    "credits_remaining_cents": 1,
    "credits_expire_at": "2023-11-07T05:31:56Z",
    "approval_sync_state": "not_requested",
    "billing_arrangement": "card"
  },
  "welcome_credit": {
    "amount_cents": 1,
    "days": 1,
    "granted": true,
    "granted_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organisation_id · string<uuid>

Expected current organisation; mismatch is rejected, never used to switch scope.

Response

200

application/json

Successful Response

organisation_id · string<uuid> · required

plan_name · string · required

paid_usage_enabled · boolean · required

trial_limit_vcpu · integer | null · required

Required range: x >= 0

current_vcpu · integer | null · required

Required range: x >= 0

observed_at · string<date-time> | null · required

can_unlock · boolean · required

payment_method_ready · boolean · required

terms · object · required

The reviewed owner agreement. paid-usage-2026-10-03 approves Startup and Cloud usage. cloud-usage-2026-10-04 approves Cloud usage only; its zero Platform amounts do not replace an existing paid Platform agreement.

Show child attributes

cloud · object · required

Show child attributes

welcome_credit · object · required

The welcome credit a pay-as-you-go organisation unlocks by saving a payment method. It is granted once, when the setup checkout completes or on the first activation read that sees payment_method_ready, and at most once per card and once per owner across organisations. amount_cents is 0 when no credit is on offer, including when an owner of the organisation already took a welcome credit elsewhere; a credit refused only because every saved card already took one stays on offer for a card of the organisation's own.

Show child attributes