Get user subscription

GET

/v1/user/subscription

GET

/v1/user/subscription

$ curl https://api.elevenlabs.io/v1/user/subscription

1 {
2   "tier": "starter",
3   "character_count": 1000,
4   "character_limit": 10000,
5   "max_character_limit_extension": 10000,
6   "max_credit_limit_extension": 10000,
7   "can_extend_character_limit": true,
8   "allowed_to_extend_character_limit": true,
9   "voice_slots_used": 1,
10   "professional_voice_slots_used": 0,
11   "professional_voice_slots_used_in_workspace": 0,
12   "voice_limit": 10,
13   "voice_add_edit_counter": 0,
14   "professional_voice_limit": 1,
15   "can_extend_voice_limit": true,
16   "can_use_instant_voice_cloning": true,
17   "can_use_professional_voice_cloning": true,
18   "current_overage": {
19     "amount": "0",
20     "currency": "usd"
21   },
22   "status": "active",
23   "open_invoices": [
24     {
25       "amount_due_cents": 1000,
26       "discounts": [
27         {
28           "discount_percent_off": 20
29         }
30       ],
31       "next_payment_attempt_unix": 1738356858,
32       "payment_intent_status": "processing",
33       "payment_intent_statusses": [
34         "processing",
35         "succeeded"
36       ],
37       "subtotal_cents": 900,
38       "tax_cents": 100
39     }
40   ],
41   "has_open_invoices": true,
42   "next_character_count_reset_unix": 1738356858,
43   "currency": "usd",
44   "billing_period": "monthly_period",
45   "character_refresh_period": "monthly_period",
46   "next_invoice": {
47     "amount_due_cents": 1000,
48     "discounts": [
49       {
50         "discount_percent_off": 20
51       }
52     ],
53     "next_payment_attempt_unix": 1738356858,
54     "payment_intent_status": "processing",
55     "payment_intent_statusses": [
56       "processing",
57       "succeeded"
58     ],
59     "subtotal_cents": 900,
60     "tax_cents": 100
61   },
62   "has_used_starter_coupon_on_account": false,
63   "has_used_creator_coupon_on_account": false
64 }

Gets extended information about the users subscription

Response

Successful Response

tierstring

The tier of the user's subscription.

character_countinteger

The number of characters used by the user.

character_limitinteger

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

max_character_limit_extensioninteger or null

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_extensioninteger or "unlimited"

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.

can_extend_character_limitboolean

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

allowed_to_extend_character_limitboolean

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

voice_slots_usedinteger

The number of voice slots used by the user.

professional_voice_slots_usedinteger

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

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

The maximum number of voice slots allowed for the user.

voice_add_edit_counterinteger

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

professional_voice_limitinteger

The maximum number of professional voices allowed for the user.

can_extend_voice_limitboolean

Whether the user can extend their voice limit.

can_use_instant_voice_cloningboolean

Whether the user can use instant voice cloning.

can_use_professional_voice_cloningboolean

Whether the user can use professional voice cloning.

current_overageobject

The current usage-based overage cost.

statusenum

The status of the user's subscription.

open_invoiceslist of objects

The open invoices for the user.

has_open_invoicesboolean

Whether the user has open invoices.

next_character_count_reset_unixinteger or null

The Unix timestamp of the next character count reset.

max_voice_add_editsinteger or null

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

currencyenum or null

The currency of the user's subscription.

billing_periodenum or null

The billing period of the user's subscription.

character_refresh_periodenum or null

The character refresh period of the user's subscription.

next_invoiceobject or null

The next invoice for the user.

pending_changeobject or null

The pending change for the user.

has_used_starter_coupon_on_accountbooleanDefaults to false

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

has_used_creator_coupon_on_accountbooleanDefaults to false

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

Errors

422

Unprocessable Entity Error

Headers

Response

Errors