---
title: "GET /payment-plan"
method: GET
path: "/payment-plan"
tags: ["Payment Plans"]
---

# GET /payment-plan

`GET /payment-plan`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/payment-plan`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

## Query parameters

- `workspace_id` string

## Response `200`

- PaymentPlanSummaryResponse
  - `payment_plan_summary` PaymentPlanSummary, required
    - `workspace_id` string, nullable
    - `managed_by_workspace_id` string, nullable
    - `billing_managers` string[], required
    - `activated_date` string, date-time, required
    - `expires_date` string, date-time, nullable, required
    - `pricing_tier_id` string, required
    - `auto_renew_pricing_tier_id` string
    - `is_trial` boolean, required
    - `auto_renew` boolean, required
    - `feature_ids` string[], required
    - `allowed_audio_ms` number
    - `consumed_audio_ms` number, required
    - `max_message_length_ms` number
    - `total_credits` number, required
    - `credit_usage` CreditUsage[], required
      - `type` 'recording' | 'translation' | 'transcription' | 'ai' | 'tts' | 'agent', required
      - `amount` number, double, required
      - `audio_ms` number, required
    - `agent_usage` AgentUsageSummary
      - `credits` number, double, required
      - `messages` number, required
      - `remaining_credits` number, double
      - `bonus_credits` number, double
      - `bonus_expires_at` string, date-time
      - `purchased_credits` number, double
    - `payments` PaymentDate[], required
      - `date` string, date-time, required
      - `billing_cycle` 'annual' | 'monthly' | 'none', required
      - `amount` number, double, required
    - `level` 'starter' | 'starter_gv' | 'lite' | 'lite_gv' | 'standard' | 'standard_gv' | 'pro', required
    - `source` 'apple' | 'google' | 'stripe' | 'gift' | 'workspace' | 'default'
    - `app_store_transaction_id` string
  - `managed_plans` PaymentPlanSummary[], required
    - `workspace_id` string, nullable
    - `managed_by_workspace_id` string, nullable
    - `billing_managers` string[], required
    - `activated_date` string, date-time, required
    - `expires_date` string, date-time, nullable, required
    - `pricing_tier_id` string, required
    - `auto_renew_pricing_tier_id` string
    - `is_trial` boolean, required
    - `auto_renew` boolean, required
    - `feature_ids` string[], required
    - `allowed_audio_ms` number
    - `consumed_audio_ms` number, required
    - `max_message_length_ms` number
    - `total_credits` number, required
    - `credit_usage` CreditUsage[], required
      - `type` 'recording' | 'translation' | 'transcription' | 'ai' | 'tts' | 'agent', required
      - `amount` number, double, required
      - `audio_ms` number, required
    - `agent_usage` AgentUsageSummary
      - `credits` number, double, required
      - `messages` number, required
      - `remaining_credits` number, double
      - `bonus_credits` number, double
      - `bonus_expires_at` string, date-time
      - `purchased_credits` number, double
    - `payments` PaymentDate[], required
      - `date` string, date-time, required
      - `billing_cycle` 'annual' | 'monthly' | 'none', required
      - `amount` number, double, required
    - `level` 'starter' | 'starter_gv' | 'lite' | 'lite_gv' | 'standard' | 'standard_gv' | 'pro', required
    - `source` 'apple' | 'google' | 'stripe' | 'gift' | 'workspace' | 'default'
    - `app_store_transaction_id` string

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)