v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

Get User Subscription Info

Gets extended information about the users subscription

get/v1/user/subscription

Headers

xi-api-keystring 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

Successful Response

tierstring required

The tier of the user's subscription.

character_countinteger required

The number of characters used by the user.

character_limitinteger required

The maximum number of characters allowed in the current billing period.

max_character_limit_extensioninteger 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.

can_extend_character_limitboolean required

Whether the workspace is entitled to enter overages (usage-based billing).

allowed_to_extend_character_limitboolean required

Deprecated: use max_credit_limit_extension != 0. Whether the user is allowed to extend their character limit.

next_character_count_reset_unixinteger nullable

The Unix timestamp of the next character count reset.

voice_slots_usedinteger required

The number of voice slots used by the user.

professional_voice_slots_usedinteger 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_workspaceinteger 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_limitinteger required

The maximum number of voice slots allowed for the user.

max_voice_add_editsinteger nullable

The maximum number of voice add/edits allowed for the user.

voice_add_edit_counterinteger required

The number of voice add/edits used by the user.

professional_voice_limitinteger required

The maximum number of professional voices allowed for the user.

can_extend_voice_limitboolean required

Whether the user can extend their voice limit.

can_use_instant_voice_cloningboolean required

Whether the user can use instant voice cloning.

can_use_professional_voice_cloningboolean required

Whether the user can use professional voice cloning.

currency'usd' | 'eur' | 'inr' | 'pln'

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'

has_open_invoicesboolean required

Whether the user has open invoices.

has_used_starter_coupon_on_accountboolean

True if any workspace owned by this user's auth account has redeemed the starter first-month discount coupon.

has_used_creator_coupon_on_accountboolean

True if any workspace owned by this user's auth account has redeemed the creator first-month discount coupon.

Example response

{
  "allowed_to_extend_character_limit": true,
  "billing_period": "monthly_period",
  "can_extend_character_limit": true,
  "can_extend_voice_limit": true,
  "can_use_instant_voice_cloning": true,
  "can_use_professional_voice_cloning": true,
  "character_count": 1000,
  "character_limit": 10000,
  "character_refresh_period": "monthly_period",
  "currency": "usd",
  "current_overage": {
    "amount": "0",
    "currency": "usd"
  },
  "has_open_invoices": true,
  "has_used_creator_coupon_on_account": false,
  "has_used_starter_coupon_on_account": false,
  "max_character_limit_extension": 10000,
  "max_credit_limit_extension": 10000,
  "next_character_count_reset_unix": 1738356858,
  "next_invoice": {
    "amount_due_cents": 1000,
    "discounts": [
      {
        "discount_percent_off": 20
      }
    ],
    "next_payment_attempt_unix": 1738356858,
    "payment_intent_status": "processing",
    "payment_intent_statusses": [
      "processing",
      "succeeded"
    ],
    "subtotal_cents": 900,
    "tax_cents": 100
  },
  "open_invoices": [
    {
      "amount_due_cents": 1000,
      "discounts": [
        {
          "discount_percent_off": 20
        }
      ],
      "next_payment_attempt_unix": 1738356858,
      "payment_intent_status": "processing",
      "payment_intent_statusses": [
        "processing",
        "succeeded"
      ],
      "subtotal_cents": 900,
      "tax_cents": 100
    }
  ],
  "professional_voice_limit": 1,
  "professional_voice_slots_used": 0,
  "professional_voice_slots_used_in_workspace": 0,
  "status": "active",
  "tier": "starter",
  "voice_add_edit_counter": 0,
  "voice_limit": 10,
  "voice_slots_used": 1
}