# Obter Assinaturas Lists all recurrent subscriptions.AvisoEste método de API não pode ser usado sob uma carga alta. A carga máxima é de 20 solicitações por minuto. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. Endpoint: GET /merchants/{merchant_id}/subscriptions Version: 2.0 Security: basicAuth ## Path parameters: - `merchant_id` (integer, required) ID de comerciante. ## Query parameters: - `offset` (integer) Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0). - `limit` (integer, required) Limite da quantidade de elementos na página. - `user_id` (string) ID de usuário. - `project_id[]` (array) Lista de IDs de projetos. - `plan_id[]` (array) Lista de IDs de planos de assinatura. - `product_id[]` (array) Lista de IDs de produto aos quais os planos estão vinculados. - `group_id[]` (array) Lista de IDs de grupo aos quais os planos estão vinculados. - `status[]` (array) Status. Enum: "active", "canceled", "non_renewing" - `datetime_from` (string) Data de amostra. Use isso para encontrar assinaturas criadas após a solicitação. - `datetime_to` (string) Data de amostra. Use isso para encontrar assinaturas criadas após a solicitação. ## Response 200 fields (application/json): - `charge_amount` (number) Quantia da cobrança. - `comment` (string) Motivo para a alteração do status da assinatura - `currency` (string) Moeda da compra. Código de três letras da moeda de acordo com o ISO 4217. - `date_create` (string) A data de criação da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). - `date_end` (string) A data final da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). - `date_last_charge` (string,null) A data da última cobrança da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). - `date_next_charge` (string,null) A data da próxima cobrança da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). - `id` (integer) ID de assinatura - `plan` (object) - `plan.billing_retry` (object) Dados de tentativa de cobrança. - `plan.billing_retry.value` (integer, required) Quantidade de tentativas de cobrança. - `plan.charge` (object) Dados de cobrança. - `plan.charge.amount` (number) Quantia da cobrança. - `plan.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). - `plan.charge.period` (object, required) Período de cobrança. - `plan.charge.period.type` (string, required) Unidade de tempo. Pode ser day, month ou lifetime. Enum: "day", "month", "lifetime" - `plan.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 - `plan.charge.prices` (array) Lista de preços em moedas diferentes. - `plan.charge.prices.setup_fee` (number) Cobrança única de configuração realizada como parte da primeira fatura. - `plan.description` (object) Descrição do plano. O valor consiste de pares "localization":"plan description". - `plan.description.ar` (string) Árabe. - `plan.description.bg` (string) Búlgaro. - `plan.description.cn` (string) Chinês (Simplificado). - `plan.description.cs` (string) Tcheco. - `plan.description.de` (string) Alemão. - `plan.description.en` (string) Inglês. - `plan.description.es` (string) Espanhol. - `plan.description.fr` (string) Francês. - `plan.description.he` (string) Hebreu. - `plan.description.it` (string) Italiano. - `plan.description.ja` (string) Japonês. - `plan.description.ko` (string) Coreano. - `plan.description.pl` (string) Polonês. - `plan.description.pt` (string) Português. - `plan.description.ro` (string) Romeno. - `plan.description.ru` (string) Russo. - `plan.description.th` (string) Tailandês. - `plan.description.tr` (string) Turco. - `plan.description.tw` (string) Chinês (Tradicional). - `plan.description.vi` (string) Vietnamita. - `plan.expiration` (object) Dados de término da assinatura. - `plan.expiration.type` (string, required) Unidade de tempo. Pode ser day ou month. Enum: "day", "month" - `plan.expiration.value` (integer,null, required) Tempo de validade. - `plan.external_id` (string) Planejar ID externo (32 caracteres). - `plan.grace_period` (object) Dados do período de carência. - `plan.grace_period.type` (string, required) Unidade de tempo. Pode ser day. Enum: "day" - `plan.grace_period.value` (integer, required) Quantidade de unidades de tempo. - `plan.group_id` (string,null) ID de grupo ao qual o plano está vinculado. - `plan.id` (integer) ID de plano de assinatura. - `plan.name` (object) Nome do plano. O valor consiste de pares "localization":"plan name". - `plan.project_id` (integer) ID de projeto. - `plan.refund_period` (integer,null) Período em que o usuário pode reembolsar o pagamento de um plano de assinatura (em dias). - `plan.status` (object) - `plan.status.value` (string) Status do plano de assinatura. Enum: "active", "disabled" - `plan.tags` (array) Rótulos do plano. - `plan.trial` (object) Dados do período de teste. - `product` (object,null) - `product.id` (integer,null) ID de produto aos quais os planos estão vinculados. - `product.description` (object) Descrições de itens traduzidas. - `product.group_id` (string) ID de grupo ao qual o produto está vinculado. - `product.name` (string) Nome do produto. - `status` (string) Status Enum: "new", "active", "canceled", "non_renewing", "freeze" - `user` (object) - `user.id` (string) ID de usuário - `user.name` (string) Nome de usuário