Skip to content
API referenceGet the organization's subscription

Get the organization's subscription

GET/v1/billing/subscription

Get the organization's subscription.

Returns the organization's plan and subscription status. An organization that has never subscribed is on the free plan, which this call records the first time it is read.

Requires a member of the organization (any role), or an organization-scoped va_ key with the admin or member role. A workspace-scoped key is refused with 403.

Authorization

  • AuthorizationBearer va_

    A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Query parameters

  • organizationstringrequired

    the organization's slug

Responses

200application/json
  • idstring<uuid>

    The subscription's id (UUID).

  • organizationstring

    The slug of the organization.

  • planobject

    A plan: its price and the limits and features it includes. A null limit means no limit.

    Child attributes
    • idstring<uuid>

      The plan's id (UUID).

    • namestring

      The plan's name, e.g. free, pro or enterprise.

    • monthly_price_usdnumber<double>

      The plan's monthly price in USD, before any regional pricing; null when the plan has no list price.

    • currencystring

      The currency of monthly_price (ISO 4217, e.g. USD); null when the plan has no price.

    • monthly_pricenumber<double>

      The monthly price in the caller's pricing region, in currency.

    • max_workspacesinteger<int32>

      The most workspaces an organization can have. Null means no limit.

    • max_virtual_keys_per_workspaceinteger<int32>

      The most virtual keys each workspace can have. Null means no limit.

    • max_consumer_keys_per_workspaceinteger<int32>

      Not used; always null.

    • max_rpm_per_workspaceinteger<int32>

      The most requests per minute each workspace can send through the gateway; more are refused with 429. Null means no limit.

    • max_monthly_budget_usdnumber<double>

      The plan's stated monthly spend ceiling, in USD. For information: requests are not refused when it is reached. Null means no limit.

    • monthly_included_credits_usdnumber<double>

      Credits the plan grants each month, in USD. No longer granted: usage on platform (PLATFORM) keys is paid from purchased credits.

    • max_logs_per_monthinteger<int32>

      The most request logs stored per month; requests over it are still served but not logged. Null means no limit.

    • log_retention_daysinteger<int32>

      How many days request logs are kept before they are deleted. Null means no limit.

    • max_prompt_templates_per_workspaceinteger<int32>

      The most prompts each workspace can have. Null means no limit.

    • max_guardrails_per_workspaceinteger<int32>

      The most guardrails each workspace can have. Null means no limit.

    • max_api_keys_per_orginteger<int32>

      The most platform API keys (va_...) an organization can have. Null means no limit.

    • semantic_caching_enabledboolean

      Whether the plan includes the semantic cache (x-cache-mode: semantic).

    • ai_guardrails_enabledboolean

      Whether the plan includes the AI guardrail checks (toxic language, jailbreak, prompt injection, ...).

    • mcp_gateway_enabledboolean

      Whether the plan includes the MCP Gateway.

    • tool_inventory_enabledboolean

      Whether the plan includes the tool inventory.

    • trust_pack_enabledboolean

      Whether the plan includes the AI Trust Pack reports.

    • trust_controls_enabledboolean

      Whether the plan includes the AI Trust Pack controls: the approved sub-processor policy, change alerts and evidence bundles.

  • statusenum<string>

    The subscription's status: active, trialing, past_due (a payment failed) or canceled.

    One of "active", "past_due", "canceled", "trialing"

  • current_period_endstring<date-time>

    When the current billing period ends (ISO 8601 date-time); absent on the free plan.

  • payment_gatewaystring

    The payment provider that bills the subscription, e.g. STRIPE.

  • gateway_subscription_idstring

    The subscription's id at the payment provider; absent on the free plan.

  • created_atstring<date-time>

    When the subscription was created (ISO 8601 date-time).

  • updated_atstring<date-time>

    When the subscription last changed (ISO 8601 date-time).

NVIDIA Inception Program member

VectorAxis is built by GK Labs, a member of NVIDIA Inception.