# Obter Planos

Lista todos os planos de assinaturas.

Endpoint: GET /projects/{project_id}/subscriptions/plans
Version: 2.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    ID de projeto.

## Query parameters:

  - `plan_id` (integer)
    ID de plano de assinatura.

  - `limit` (integer, required)
    Limite da quantidade de elementos na página.

  - `offset` (integer)
    Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

  - `external_id` (string)
    Planejar ID externo (32 caracteres).

  - `group_id` (string)
    ID de grupo aos quais os planos estão vinculados.

  - `product_id` (integer)
    ID de produto aos quais os planos estão vinculados.

  - `query` (string)
    Consultar (procura em name.en (local padrão)).

## Response 200 fields (application/json):

  - `billing_retry` (object)
    Dados de tentativa de cobrança.

  - `billing_retry.value` (integer, required)
    Quantidade de tentativas de cobrança.

  - `charge` (object)
    Dados de cobrança.

  - `charge.amount` (number)
    Quantia da cobrança.

  - `charge.currency` (string)
    Moeda da compra. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `charge.period` (object, required)
    Período de cobrança.

  - `charge.period.type` (string, required)
    Unidade de tempo. Pode ser day, month ou lifetime.
    Enum: "day", "month", "lifetime"

  - `charge.period.value` (integer, required)
    Quantidade de unidades de tempo. O valor depende do parâmetro do tipo e pode ser: - entre 1 e 366, se type for day - entre 1 e 12, se type for month - 0 se type for lifetime

  - `charge.prices` (array)
    Lista de preços em moedas diferentes.

  - `charge.prices.setup_fee` (number)
    Cobrança única de configuração realizada como parte da primeira fatura.

  - `description` (object)
    Descrição do plano. O valor consiste de pares "localization":"plan description".

  - `description.ar` (string)
    Árabe.

  - `description.bg` (string)
    Búlgaro.

  - `description.cn` (string)
    Chinês (Simplificado).

  - `description.cs` (string)
    Tcheco.

  - `description.de` (string)
    Alemão.

  - `description.en` (string)
    Inglês.

  - `description.es` (string)
    Espanhol.

  - `description.fr` (string)
    Francês.

  - `description.he` (string)
    Hebreu.

  - `description.it` (string)
    Italiano.

  - `description.ja` (string)
    Japonês.

  - `description.ko` (string)
    Coreano.

  - `description.pl` (string)
    Polonês.

  - `description.pt` (string)
    Português.

  - `description.ro` (string)
    Romeno.

  - `description.ru` (string)
    Russo.

  - `description.th` (string)
    Tailandês.

  - `description.tr` (string)
    Turco.

  - `description.tw` (string)
    Chinês (Tradicional).

  - `description.vi` (string)
    Vietnamita.

  - `expiration` (object)
    Dados de término da assinatura.

  - `expiration.type` (string, required)
    Unidade de tempo. Pode ser day ou month.
    Enum: "day", "month"

  - `expiration.value` (integer,null, required)
    Tempo de validade.

  - `external_id` (string)
    Planejar ID externo (32 caracteres).

  - `grace_period` (object)
    Dados do período de carência.

  - `grace_period.type` (string, required)
    Unidade de tempo. Pode ser day.
    Enum: "day"

  - `grace_period.value` (integer, required)
    Quantidade de unidades de tempo.

  - `group_id` (string,null)
    ID de grupo ao qual o plano está vinculado.

  - `id` (integer)
    ID de plano de assinatura.

  - `name` (object)
    Nome do plano. O valor consiste de pares "localization":"plan name".

  - `project_id` (integer)
    ID de projeto.

  - `refund_period` (integer,null)
    Período em que o usuário pode reembolsar o pagamento de um plano de assinatura (em dias).

  - `status` (object)

  - `status.value` (string)
    Status do plano de assinatura.
    Enum: "active", "disabled"

  - `tags` (array)
    Rótulos do plano.

  - `trial` (object)
    Dados do período de teste.

  - `localized_name` (string)
    Nome do plano no idioma padrão (en), replica o valor name.en.