> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Obter assinatura do usuário

GET https://api.elevenlabs.io/v1/user/subscription

Obtém informações detalhadas sobre a assinatura do usuário

Reference: https://elevenlabs.io/docs/api-reference/user/subscription/get

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Response

### 200

Resposta bem-sucedida

- `tier` (string, required) — O nível da assinatura do usuário.
- `character_count` (integer, required) — O número de caracteres usados pelo usuário.
- `character_limit` (integer, required) — O número máximo de caracteres permitidos no período de cobrança atual.
- `max_character_limit_extension` (integer, required, nullable) — Descontinuado: use `max_credit_limit_extension`. Número máximo de caracteres pelo qual o limite de caracteres pode ser excedido. Gerenciado pelo administrador do workspace.
- `max_credit_limit_extension` (ExtendedSubscriptionResponseModelMaxCreditLimitExtension, required) — Número máximo de créditos pelo qual o limite de crédito pode ser excedido. Gerenciado pelo administrador do espaço de trabalho. `"unlimited"` significa sem limite; `0` significa que a cobrança baseada no uso está desativada.
- `can_extend_character_limit` (boolean, required) — Indica se o espaço de trabalho pode exceder o limite de uso (cobrança baseada no uso).
- `allowed_to_extend_character_limit` (boolean, required) — Descontinuado: use `max_credit_limit_extension != 0`. Define se o usuário tem permissão para estender seu limite de caracteres.
- `voice_slots_used` (integer, required) — O número de slots de voz usados pelo usuário.
- `professional_voice_slots_used` (integer, required) — O número de slots de voz profissional usados. Para cobrança consolidada, esta é a contagem de todo o grupo em todos os workspaces; consulte professional_voice_slots_used_in_workspace apenas para o workspace atual.
- `professional_voice_slots_used_in_workspace` (integer, required) — O número de slots de voz profissional usados no workspace atual. Para cobrança consolidada, professional_voice_slots_used contabiliza todos os workspaces do grupo, enquanto este campo contabiliza apenas o workspace atual.
- `voice_limit` (integer, required) — O número máximo de slots de voz permitido para o usuário.
- `voice_add_edit_counter` (integer, required) — O número de adições/edições de voz usadas pelo usuário.
- `professional_voice_limit` (integer, required) — O número máximo de vozes profissionais permitido para o usuário.
- `can_extend_voice_limit` (boolean, required) — Indica se o usuário pode aumentar seu limite de vozes.
- `can_use_instant_voice_cloning` (boolean, required) — Indica se o usuário pode usar a clonagem instantânea de voz.
- `can_use_professional_voice_cloning` (boolean, required) — Indica se o usuário pode usar a clonagem profissional de voz.
- `current_overage` (Price, required) — O custo atual de excedente baseado no uso.
- `status` (enum, required) — O status da assinatura do usuário.
  - Allowed values: `trialing`, `active`, `incomplete`, `past_due`, `free`, `free_disabled`
- `open_invoices` (list of InvoiceResponseModel, required) — As faturas em aberto do usuário.
- `has_open_invoices` (boolean, required) — Indica se o usuário tem faturas em aberto.
- `next_character_count_reset_unix` (integer, optional, nullable) — O timestamp Unix da próxima redefinição da contagem de caracteres.
- `max_voice_add_edits` (integer, optional, nullable) — O número máximo de adições/edições de voz permitido para o usuário.
- `currency` (enum, optional, nullable) — A moeda da assinatura do usuário.
  - Allowed values: `usd`, `eur`, `inr`, `pln`, `gbp`
- `billing_period` (enum, optional, nullable) — O período de cobrança da assinatura do usuário.
  - Allowed values: `monthly_period`, `3_month_period`, `6_month_period`, `annual_period`
- `character_refresh_period` (enum, optional, nullable) — O período de renovação de caracteres da assinatura do usuário.
  - Allowed values: `monthly_period`, `3_month_period`, `6_month_period`, `annual_period`
- `next_invoice` (InvoiceResponseModel, optional, nullable) — A próxima fatura do usuário.
- `pending_change` (ExtendedSubscriptionResponseModelPendingChange, optional, nullable) — A alteração pendente para o usuário.
- `has_used_starter_coupon_on_account` (boolean, optional, default: false) — True se algum espaço de trabalho pertencente à conta de autenticação deste usuário tiver resgatado o cupom de desconto do primeiro mês do plano Starter.
- `has_used_creator_coupon_on_account` (boolean, optional, default: false) — True se algum espaço de trabalho pertencente à conta de autenticação deste usuário tiver resgatado o cupom de desconto do primeiro mês do plano Creator.
- `is_eligible_for_starter_promo` (boolean, optional, default: false) — True se a conta de autenticação deste usuário se qualificar para a promoção do primeiro mês do Starter, usando a mesma verificação do checkout. A flag de recurso starter_discount ainda determina se a promoção será oferecida.

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### ExtendedSubscriptionResponseModelMaxCreditLimitExtension

Número máximo de créditos pelo qual o limite de crédito pode ser excedido. Gerenciado pelo administrador do espaço de trabalho. `"unlimited"` significa sem limite; `0` significa que a cobrança baseada no uso está desativada.

### Price

Par de moeda/valor.

- `amount` (string, required)
- `currency` (enum, required)
  - Allowed values: `usd`, `eur`, `inr`, `pln`, `gbp`

### InvoiceResponseModel

- `amount_due_cents` (integer, required) — O valor devido em centavos.
- `discounts` (list of DiscountResponseModel, required) — Os descontos aplicados à fatura.
- `next_payment_attempt_unix` (integer, required) — O timestamp Unix da próxima tentativa de pagamento. -1 quando não houver uma próxima tentativa de pagamento.
- `payment_intent_status` (enum, required, nullable) — Descontinuado. Use [payment_intent_statusses]. O status da primeira intenção de pagamento desta fatura. None quando não houver intenção de pagamento.
  - Allowed values: `canceled`, `processing`, `requires_action`, `requires_capture`, `requires_confirmation`, `requires_payment_method`, `succeeded`
- `payment_intent_statusses` (list of enum, required) — Os status das intenções de pagamento desta fatura. A lista fica vazia quando não há intenções de pagamento.
  - Allowed values: `canceled`, `processing`, `requires_action`, `requires_capture`, `requires_confirmation`, `requires_payment_method`, `succeeded`
- `subtotal_cents` (integer, optional, nullable) — O valor do subtotal em centavos antes dos impostos, sem incluir impostos e descontos.
- `tax_cents` (integer, optional, nullable) — O valor dos impostos em centavos.
- `discount_percent_off` (double, optional, nullable) — Descontinuado. Use [discounts]. O desconto aplicado à fatura. Por exemplo, [20.0f] para 20% de desconto.
- `discount_amount_off` (double, optional, nullable) — Descontinuado. Use [discounts]. O desconto aplicado à fatura. Por exemplo, [20.0f] para um desconto de 20 centavos.

### ExtendedSubscriptionResponseModelPendingChange

A alteração pendente para o usuário.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### DiscountResponseModel

- `discount_percent_off` (double, optional, nullable) — O desconto aplicado à fatura. Por exemplo, [20.0f] para 20% de desconto.
- `discount_amount_off` (double, optional, nullable) — O desconto aplicado à fatura. Por exemplo, [20.0f] para 20 centavos de desconto.

### PendingSubscriptionSwitchResponseModel

- `next_tier` (enum, required) — O nível para o qual mudar.
  - Allowed values: `free`, `starter`, `go`, `creator`, `pro`, `growing_business`, `scale_2024_08_10`, `grant_tier_1_2025_07_23`, `grant_tier_2_2025_07_23`, `grant`, `trial`, `enterprise`
- `next_billing_period` (enum, required) — O período de cobrança para o qual mudar.
  - Allowed values: `monthly_period`, `3_month_period`, `6_month_period`, `annual_period`
- `timestamp_seconds` (integer, required) — O timestamp da alteração.
- `kind` ("change", optional, default: change)

### PendingCancellationResponseModel

- `timestamp_seconds` (integer, required) — O timestamp do cancelamento.
- `kind` ("cancellation", optional, default: cancellation)

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "tier": "starter",
  "character_count": 1000,
  "character_limit": 10000,
  "max_character_limit_extension": 10000,
  "max_credit_limit_extension": 10000,
  "can_extend_character_limit": true,
  "allowed_to_extend_character_limit": true,
  "voice_slots_used": 1,
  "professional_voice_slots_used": 0,
  "professional_voice_slots_used_in_workspace": 0,
  "voice_limit": 10,
  "voice_add_edit_counter": 0,
  "professional_voice_limit": 1,
  "can_extend_voice_limit": true,
  "can_use_instant_voice_cloning": true,
  "can_use_professional_voice_cloning": true,
  "current_overage": {
    "amount": "0",
    "currency": "usd"
  },
  "status": "active",
  "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
    }
  ],
  "has_open_invoices": true,
  "next_character_count_reset_unix": 1738356858,
  "currency": "usd",
  "billing_period": "monthly_period",
  "character_refresh_period": "monthly_period",
  "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
  },
  "has_used_starter_coupon_on_account": false,
  "has_used_creator_coupon_on_account": false,
  "is_eligible_for_starter_promo": false
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/user/subscription"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/user/subscription';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/user/subscription"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/user/subscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/user/subscription")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/user/subscription');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/user/subscription");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/user/subscription")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```