---
title: "Get User Subscription Info"
method: GET
path: "/v1/user/subscription"
---

# Get User Subscription Info

`GET /v1/user/subscription`

Gets extended information about the users subscription

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- ExtendedSubscriptionResponseModel
  - `tier` string, required — The tier of the user's subscription.
  - `character_count` integer, required — The number of characters used by the user.
  - `character_limit` integer, required — The maximum number of characters allowed in the current billing period.
  - `max_character_limit_extension` integer, nullable, required — Deprecated: use `max_credit_limit_extension`. Maximum number of characters that the character limit can be exceeded by. Managed by the workspace admin.
  - `max_credit_limit_extension` union, required — Maximum number of credits that the credit limit can be exceeded by. Managed by the workspace admin. `"unlimited"` means no cap, `0` means usage-based billing is disabled.
    - integer
    - 'unlimited'
  - `can_extend_character_limit` boolean, required — Whether the workspace is entitled to enter overages (usage-based billing).
  - `allowed_to_extend_character_limit` boolean, required — Deprecated: use `max_credit_limit_extension != 0`. Whether the user is allowed to extend their character limit.
  - `next_character_count_reset_unix` integer, nullable — The Unix timestamp of the next character count reset.
  - `voice_slots_used` integer, required — The number of voice slots used by the user.
  - `professional_voice_slots_used` integer, required — The number of professional voice slots used. For consolidated billing this is the group-wide count across all workspaces in the group; see professional_voice_slots_used_in_workspace for the current workspace only.
  - `professional_voice_slots_used_in_workspace` integer, required — The number of professional voice slots used in the current workspace. For consolidated billing, professional_voice_slots_used counts across all workspaces in the group, while this counts only the current workspace.
  - `voice_limit` integer, required — The maximum number of voice slots allowed for the user.
  - `max_voice_add_edits` integer, nullable — The maximum number of voice add/edits allowed for the user.
  - `voice_add_edit_counter` integer, required — The number of voice add/edits used by the user.
  - `professional_voice_limit` integer, required — The maximum number of professional voices allowed for the user.
  - `can_extend_voice_limit` boolean, required — Whether the user can extend their voice limit.
  - `can_use_instant_voice_cloning` boolean, required — Whether the user can use instant voice cloning.
  - `can_use_professional_voice_cloning` boolean, required — Whether the user can use professional voice cloning.
  - `currency` 'usd' | 'eur' | 'inr' | 'pln'
  - `current_overage` Price, required — Currency/amount pair.
    - `amount` string, required
    - `currency` 'usd' | 'eur' | 'inr' | 'pln', required
  - `status` 'trialing' | 'active' | 'incomplete' | 'past_due' | 'free' | 'free_disabled', required
  - `billing_period` 'monthly_period' | '3_month_period' | '6_month_period' | 'annual_period'
  - `character_refresh_period` 'monthly_period' | '3_month_period' | '6_month_period' | 'annual_period'
  - `next_invoice` InvoiceResponseModel
    - `amount_due_cents` integer, required — The amount due in cents.
    - `subtotal_cents` integer, nullable — The subtotal amount in cents before tax (exclusive of tax and discounts).
    - `tax_cents` integer, nullable — The tax amount in cents.
    - `discount_percent_off` number, nullable — Deprecated. Use [discounts] instead. The discount applied to the invoice. E.g. [20.0f] for 20% off.
    - `discount_amount_off` number, nullable — Deprecated. Use [discounts] instead. The discount applied to the invoice. E.g. [20.0f] for 20 cents off.
    - `discounts` DiscountResponseModel[], required — The discounts applied to the invoice.
      - `discount_percent_off` number, nullable — The discount applied to the invoice. E.g. [20.0f] for 20% off.
      - `discount_amount_off` number, nullable — The discount applied to the invoice. E.g. [20.0f] for 20 cents off.
    - `next_payment_attempt_unix` integer, required — The Unix timestamp of the next payment attempt. -1 when there is no next payment attempt.
    - `payment_intent_status` 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded', nullable, required — Deprecated. Use [payment_intent_statusses] instead. The status of this invoice's first payment intent. None when there is no payment intent.
    - `payment_intent_statusses` string[], required — The statuses of this invoice's payment intents. Empty list when there are no payment intents.
  - `open_invoices` InvoiceResponseModel[], required — The open invoices for the user.
    - `amount_due_cents` integer, required — The amount due in cents.
    - `subtotal_cents` integer, nullable — The subtotal amount in cents before tax (exclusive of tax and discounts).
    - `tax_cents` integer, nullable — The tax amount in cents.
    - `discount_percent_off` number, nullable — Deprecated. Use [discounts] instead. The discount applied to the invoice. E.g. [20.0f] for 20% off.
    - `discount_amount_off` number, nullable — Deprecated. Use [discounts] instead. The discount applied to the invoice. E.g. [20.0f] for 20 cents off.
    - `discounts` DiscountResponseModel[], required — The discounts applied to the invoice.
      - `discount_percent_off` number, nullable — The discount applied to the invoice. E.g. [20.0f] for 20% off.
      - `discount_amount_off` number, nullable — The discount applied to the invoice. E.g. [20.0f] for 20 cents off.
    - `next_payment_attempt_unix` integer, required — The Unix timestamp of the next payment attempt. -1 when there is no next payment attempt.
    - `payment_intent_status` 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded', nullable, required — Deprecated. Use [payment_intent_statusses] instead. The status of this invoice's first payment intent. None when there is no payment intent.
    - `payment_intent_statusses` string[], required — The statuses of this invoice's payment intents. Empty list when there are no payment intents.
  - `has_open_invoices` boolean, required — Whether the user has open invoices.
  - `pending_change` union — The pending change for the user.
    - PendingSubscriptionSwitchResponseModel
      - `kind` 'change'
      - `next_tier` 'free' | 'starter' | 'creator' | 'pro' | 'growing_business' | 'scale_2024_08_10' | 'grant_tier_1_2025_07_23' | 'grant_tier_2_2025_07_23' | 'trial' | 'enterprise', required — The tier to change to.
      - `next_billing_period` 'monthly_period' | '3_month_period' | '6_month_period' | 'annual_period', required
      - `timestamp_seconds` integer, required — The timestamp of the change.
    - PendingCancellationResponseModel
      - `kind` 'cancellation'
      - `timestamp_seconds` integer, required — The timestamp of the cancellation.
  - `has_used_starter_coupon_on_account` boolean — True if any workspace owned by this user's auth account has redeemed the starter first-month discount coupon.
  - `has_used_creator_coupon_on_account` boolean — True if any workspace owned by this user's auth account has redeemed the creator first-month discount coupon.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/revisions/e77a0a530a82/schema)