---
title: "Cria uma nova assinatura."
method: POST
path: "/v1/subscriptions"
tags: ["subscriptions"]
---

# Cria uma nova assinatura.

`POST /v1/subscriptions`

## Request

- Base URL: `//app.vindi.com.br/api` (relative, and the document’s source URL is not known)
- URL: `//app.vindi.com.br/api/v1/subscriptions`
- Auth: HTTP basic

Este método irá criar uma assinatura e obrigatoriamente retornar o objeto `subscription`. Se os parâmetros do plano indicarem uma cobrança imediata, o retorno da mesma requisição também irá conter os detalhes da fatura emitida, representada pelo objeto `bill`. Dentro deste objeto você poderá encontrar informações mais detalhadas sobre o processamento da transação (`last_transaction`).

#### Exemplo de requisição

```
  {
    "plan_id": 12,
    "customer_id": 142,
    "payment_method_code": "credit_card",
    "product_items": [
      { "product_id": 14 }
    ]
  }
```

Para mais detalhes e possibilidades de customização, consulte abaixo a seção **Parâmetros**.

#### Método de pagamento

Para uma lista dos métodos de pagamento disponíveis e seus respectivos códigos, consulte o serviço `GET payment_methods`.

A plataforma tomará uma ação diferente dependendo do método de pagamento informado através do parâmetro `payment_method_code`. Caso o método exija, por exemplo, os dados do cartão de crédito do cliente, a plataforma irá verificar se o cliente em questão possui um cartão válido. Se possuir, uma tentativa de cobrança será efetuada. Se não possuir, um e-mail será enviado ao cliente solicitando seus dados de pagamento.

Caso a forma de pagamento não exija nenhum dado adicional, um e-mail será enviado ao cliente. Boletos bancários possuem exatamente este comportamento.

#### Produtos da assinatura

Por padrão, a lista de itens da nova assinatura herdará as configurações de itens do plano informado via `plan_id`.

Caso seja necessário, também é possível customizar esta lista de itens no momento da criação da assinatura através do array `product_items`. Através deste array de objetos é possível definir quais serão os produtos (`product_id`), quantidades (`quantity`) e o número de períodos (`cycles`) onde cada produto deverá será aplicado. Este atributo é especialmente útil para definir condições específicas que fogem das condições normais de precificação que você definiu no plano.

#### Customização da precificação

Caso o atributo `pricing_schema` não seja informado no `product_item`, a plataforma irá assumir a precificação padrão do produto. Se quiser customizar a precificação exclusivamente para esta assinatura, é possível informar o atributo `pricing_schema` com os parâmetros descritos abaixo. Mais detalhes sobre a precificação de produtos podem ser encontrados [neste artigo](http://atendimento.vindi.com.br/hc/pt-br/articles/203303380).

#### Descontos

Cada produto da assinatura poderá receber um ou mais descontos que serão utilizados no cálculo da geração das faturas. Informe o atributo `discounts` para `product_item`. Caso mais de um desconto seja informado para o mesmo produto, os valores serão sempre calculados a partir do valor inicial.

#### Tratamento de assinaturas com pagamentos rejeitados

Conforme mencionado anteriormente, a plataforma irá retornar a fatura gerada (`bill`) caso a assinatura possua uma cobrança imediata. Se este retorno possuir uma fatura pendente (`"status": "pending"`) e uma transação rejeitada, você terá as seguintes opções:

- **Manter a assinatura ativa** e aguardar a retentativa automática da plataforma na data indicada pelo atributo `next_attempt`.
- **Efetuar uma nova tentativa** de cobrança através do método `POST /charges/{id}/charge`. Opcionalmente você poderá informar um novo perfil de pagamento.
- **Cancelar a assinatura e a fatura pendente** através do método `DELETE /subscriptions/{id}?cancel_bills=true`.
- **Enviar um e-mail** com um link para a tela de pagamento da fatura. Este e-mail poderá ser enviado automaticamente pelas notificações da plataforma (cobrança rejeitada) ou se preferir, manualmente através do seu próprio backend. Neste caso, use o endereço contido no atributo `url` do objeto `bill`.

## Request body

- PostV1Subscriptions: Cria uma nova assinatura.
  - `body` string: JSON com atributos da nova assinatura.
  - `start_at` string: Data do início da assinatura no formato ISO 8601. Use nulo na criação para início imediato
  - `plan_id` integer, required: ID do plano
  - `customer_id` integer, required: ID do cliente
  - `code` string: Código externo para referência via API
  - `payment_method_code` string, required: Código do método de pagamento
  - `installments` integer: Parcelamento da cobrança. Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano
  - `billing_trigger_type` 'beginning_of_period' | 'end_of_period' | 'day_of_month': Referência para data de geração da cobrança. Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano
  - `billing_trigger_day` integer: Dia para geração da cobrança. Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano
  - `billing_cycles` integer: Número máximo de períodos da assinatura. Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano
  - `metadata` 'array': Metadados da assinatura
  - `product_items` ProductItemParametersCreateSubscription[]: Lista de itens incluídos na assinatura
    - `product_id` integer, required: ID do produto associado
    - `cycles` integer: Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada
    - `quantity` integer: Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado
    - `pricing_schema` PricingSchemaParameters
      - `price` number, required: Preço base
      - `minimum_price` number: Preço mínimo
      - `schema_type` 'flat' | 'per_unit' | 'step_usage' | 'volume_usage' | 'tier_usage', required: Tipo de cálculo da precificação
      - `pricing_ranges` PricingRangeParameters[]: Lista de faixas de precificação
        - `start_quantity` integer, required: Início da faixa
        - `end_quantity` integer: Término da faixa. Opcional apenas para a última
        - `price` number, required: Preço da unidade ou da faixa, dependendo do tipo escolhido
        - `overage_price` number: Preço unitário do excedente da faixa
    - `discounts` DiscountParametersCreateSubscription[]: Lista de descontos
      - `discount_type` 'percentage' | 'amount' | 'quantity', required: Tipo do desconto
      - `percentage` number: Valor numérico para porcentagem de 0.01 até 100
      - `amount` number: Valor para desconto fixo
      - `quantity` integer: Número para desconto por quantidade
      - `cycles` integer: Número de ciclos de recorrência onde o desconto será aplicado a partir do momento de sua criação. Nulo significa desconto por tempo indefinido
  - `payment_profile` PaymentProfileParametersFindOrCreate
    - `id` integer: ID do perfil de pagamento existente
    - `token` string
    - `holder_name` string: Nome do titular/portador do perfil de pagamento
    - `registry_code` string: CPF ou CNPJ do titular/portador
    - `bank_branch` string: Agência da conta bancária
    - `bank_account` string: Número da conta bancária
    - `card_expiration` string: Validade do cartão de crédito no formato MM/AA
    - `allow_as_fallback` string: Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.
    - `card_number` string: Número completo do cartão de crédito
    - `card_cvv` string: Código de segurança do cartão de crédito com 3 ou 4 dígitos
    - `card_token` string
    - `gateway_id` string
    - `payment_method_code` string: Código do método de pagamento
    - `payment_company_code` string: Código do banco ou bandeira
    - `gateway_token` string: Token externo
  - `invoice_split` string: Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano (`true`). Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano
  - `subscription_affiliates` SubscriptionAffiliateParametersCreate[]: Lista de participantes da assinatura. Este campo é exclusivo para transaçõesque utilizaram a regra de split de pagamento e os participantes estejam ativos.
    - `affiliate_id` integer: ID do participante
    - `amount` number: Fração do valor da assinatura referente ao participante
    - `amount_type` integer: Tipo de valor da assinatura, onde 1 representa uma quantia fixa (amount) e 2 representa a porcentagem (percentage)
    - `status` string: Status do participante em uma assinatura

## Response `201`

Assinatura criada com sucesso.

- SubscriptionResponseCreate: Este método irá criar uma assinatura e obrigatoriamente retornar o objeto `subscription`. Se os parâmetros do plano indicarem uma cobrança imediata, o retorno da mesma requisição também irá conter os detalhes da fatura emitida, representada pelo objeto `bill`. Dentro deste objeto você poderá encontrar informações mais detalhadas sobre o processamento da transação (`last_transaction`). #### Exemplo de requisição ``` { "plan_id": 12, "customer_id": 142, "payment_method_code": "credit_card", "product_items": [ { "product_id": 14 } ] } ``` Para mais detalhes e possibilidades de customização, consulte abaixo a seção **Parâmetros**. #### Método de pagamento Para uma lista dos métodos de pagamento disponíveis e seus respectivos códigos, consulte o serviço `GET payment_methods`. A plataforma tomará uma ação diferente dependendo do método de pagamento informado através do parâmetro `payment_method_code`. Caso o método exija, por exemplo, os dados do cartão de crédito do cliente, a plataforma irá verificar se o cliente em questão possui um cartão válido. Se possuir, uma tentativa de cobrança será efetuada. Se não possuir, um e-mail será enviado ao cliente solicitando seus dados de pagamento. Caso a forma de pagamento não exija nenhum dado adicional, um e-mail será enviado ao cliente. Boletos bancários possuem exatamente este comportamento. #### Produtos da assinatura Por padrão, a lista de itens da nova assinatura herdará as configurações de itens do plano informado via `plan_id`. Caso seja necessário, também é possível customizar esta lista de itens no momento da criação da assinatura através do array `product_items`. Através deste array de objetos é possível definir quais serão os produtos (`product_id`), quantidades (`quantity`) e o número de períodos (`cycles`) onde cada produto deverá será aplicado. Este atributo é especialmente útil para definir condições específicas que fogem das condições normais de precificação que você definiu no plano. #### Customização da precificação Caso o atributo `pricing_schema` não seja informado no `product_item`, a plataforma irá assumir a precificação padrão do produto. Se quiser customizar a precificação exclusivamente para esta assinatura, é possível informar o atributo `pricing_schema` com os parâmetros descritos abaixo. Mais detalhes sobre a precificação de produtos podem ser encontrados [neste artigo](http://atendimento.vindi.com.br/hc/pt-br/articles/203303380). #### Descontos Cada produto da assinatura poderá receber um ou mais descontos que serão utilizados no cálculo da geração das faturas. Informe o atributo `discounts` para `product_item`. Caso mais de um desconto seja informado para o mesmo produto, os valores serão sempre calculados a partir do valor inicial. #### Tratamento de assinaturas com pagamentos rejeitados Conforme mencionado anteriormente, a plataforma irá retornar a fatura gerada (`bill`) caso a assinatura possua uma cobrança imediata. Se este retorno possuir uma fatura pendente (`"status": "pending"`) e uma transação rejeitada, você terá as seguintes opções: - **Manter a assinatura ativa** e aguardar a retentativa automática da plataforma na data indicada pelo atributo `next_attempt`. - **Efetuar uma nova tentativa** de cobrança através do método `POST /charges/{id}/charge`. Opcionalmente você poderá informar um novo perfil de pagamento. - **Cancelar a assinatura e a fatura pendente** através do método `DELETE /subscriptions/{id}?cancel_bills=true`. - **Enviar um e-mail** com um link para a tela de pagamento da fatura. Este e-mail poderá ser enviado automaticamente pelas notificações da plataforma (cobrança rejeitada) ou se preferir, manualmente através do seu próprio backend. Neste caso, use o endereço contido no atributo `url` do objeto `bill`.
  - `subscription` Subscription, required: Utilize este método para listar as assinaturas associadas à sua conta na Vindi. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination) e [filtros de busca](http://atendimento.vindi.com.br/hc/pt-br/articles/204163150). #### Atributos para busca <code>status</code>, <code>id</code>, <code>code</code>, <code>installments</code>, <code>customer_id</code>, <code>interval</code>, <code>interval_count</code>, <code>billing_trigger_day</code>, <code>billing_trigger_type</code>, <code>billing_cycles</code>, <code>plan_id</code>, <code>payment_method_id</code>, <code>start_at</code>, <code>cancel_at</code>, <code>overdue_since</code>, <code>created_at</code>, <code>updated_at</code> e <code>end_at</code>. #### Inadimplência Além dos filtros acima, a busca por assinaturas adimplentes ou inadimplentes pode ser realizada através do atributo `overdue_since` no parâmetro `query`. Exemplos: - Assinaturas adimplentes: `overdue_since = null` - Assinaturas inadimplentes: `overdue_since != null` - Assinaturas inadimplentes há mais de n dias: `overdue_since < 2016-03-15` #### Itens da assinatura Uma assinatura é composta de vários itens representados no array `product_items`. Este endpoint lista apenas os 25 primeiros itens de cada assinatura. Caso queira listar mais itens de uma assinatura, utilize o método da API `GET /subscriptions/{id}/product_items`.
    - `id` integer, required: ID da assinatura
    - `status` 'active' | 'canceled' | 'future' | 'expired', required: Status da assinatura
    - `start_at` string, required: Data do início da assinatura no formato ISO 8601
    - `end_at` string: Data do término da assinatura no formato ISO 8601
    - `next_billing_at` string: Data da próxima cobrança da assinatura
    - `overdue_since` string: Data do início da inadimplência
    - `code` string: Código externo para referência via API
    - `cancel_at` string: Data do cancelamento da assinatura
    - `interval` 'days' | 'months', required: Duração do intervalo
    - `interval_count` integer, required: Número de intervalos dentro de um período
    - `billing_trigger_type` 'beginning_of_period' | 'end_of_period' | 'day_of_month', required: Referência para data de geração da cobrança
    - `billing_trigger_day` integer, required: Dia para geração da cobrança.
    - `billing_cycles` integer: Número máximo de períodos da assinatura. Nulo significa duração indefinida
    - `installments` integer, required: Número de parcelas
    - `created_at` string, required: Data e hora do cadastro da assinatura
    - `updated_at` string, required: Data e hora da última atualização da assinatura
    - `customer` CustomerSummary, required
      - `id` integer, required: ID do cliente
      - `name` string, required: Nome do cliente
      - `email` string: E-mail do cliente
      - `code` string: Código opcional para referência via API
    - `plan` PlanSummary, required
      - `id` integer, required: ID do plano
      - `name` string, required: Nome do plano
      - `code` string: Código externo do plano
    - `product_items` ProductItem[], required: Produtos incluídos na assinatura. Este atributo exibe os primeiros 25 itens. Para os demais, consulte o método `GET /subscriptions/:id/product_items`.
      - `id` integer, required: ID do item
      - `status` 'active' | 'inactive' | 'deleted', required: Status do item
      - `uses` integer: Número de ciclos de recorrência que utilizaram o produto.
      - `cycles` integer: Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada
      - `quantity` integer: Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado
      - `created_at` string, required: Data e hora da criação do item
      - `updated_at` string, required: Data e hora da última atualização do item
      - `product` ProductSummary, required
        - `id` integer, required: ID do produto
        - `name` string, required: Nome do produto
        - `code` string: Código externo do produto
      - `pricing_schema` PricingSchema
        - `id` string, required: ID do esquema de precificação
        - `short_format` string, required: Descrição da precificação gerada automaticamente
        - `price` number, required: Preço base
        - `minimum_price` number: Preço mínimo
        - `schema_type` 'flat' | 'per_unit' | 'step_usage' | 'volume_usage' | 'tier_usage', required: Tipo de cálculo da precificação
        - `pricing_ranges` PricingRange[]: Lista de faixas de precificação
          - `id` string, required: ID do faixa de precificação
          - `start_quantity` integer, required: Início da faixa
          - `end_quantity` integer: Término da faixa. Opcional apenas para a última
          - `price` number, required: Preço da unidade ou da faixa, dependendo do tipo escolhido
          - `overage_price` number: Preço unitário do excedente da faixa
        - `created_at` string, required: Data e hora do cadastro do esquema de precificação
      - `discounts` DiscountSummary[]: Lista de descontos ativos. Descontos já aplicados não serão retornados
        - `id` integer, required: ID do desconto
        - `discount_type` 'percentage' | 'amount' | 'quantity', required: Tipo do desconto
        - `percentage` number: Valor numérico para porcentagem de 0.01 até 100
        - `amount` number: Valor para desconto fixo
        - `quantity` integer: Número para desconto por quantidade
        - `cycles` integer: Número de ciclos de recorrência onde o desconto será aplicado a partir do momento de sua criação. Nulo significa desconto por tempo indefinido
    - `payment_method` PaymentMethodSummary, required
      - `id` integer, required: ID do método de pagamento
      - `public_name` string, required: Nome público do método de pagamento
      - `name` string, required: Nome interno do método de pagamento
      - `code` string, required: Código externo para referência via API
      - `type` string, required: Tipo do método de pagamento
    - `current_period` PeriodSummary
      - `id` integer, required: ID do período
      - `billing_at` string: Data para geração automática da cobrança do período
      - `cycle` integer, required: Ciclo do período
      - `start_at` string, required: Data e hora do início do período
      - `end_at` string, required: Data e hora do término do período
      - `duration` integer, required: Duração do período em número de segundos
    - `metadata` object: Metadados da assinatura
    - `payment_profile` PaymentProfileSummary
      - `id` integer, required: ID do perfil de pagamento
      - `holder_name` string: Nome do titular/portador do perfil de pagamento
      - `registry_code` string: CPF ou CNPJ do titular/portador
      - `bank_branch` string: Agência da conta bancária
      - `bank_account` string: Número da conta bancária
      - `card_expiration` string: Validade do cartão de crédito no formato MM/AA
      - `allow_as_fallback` string: Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.
      - `card_number_first_six` string: Primeiros 6 dígitos do cartão de crédito (BIN/IIN)
      - `card_number_last_four` string: Últimos 4 dígitos do cartão de crédito
      - `renewed_card` object
        - `card_number_last_four` string: Últimos quatro dígitos do cartão de crédito renovado
        - `card_expiration` string: Nova validade do cartão de crédito renovado
      - `card_renewed_at` string: Data da renovação do cartão de crédito renovado
      - `token` string, required: Token interno para referência do perfil de pagamento
      - `created_at` string, required: Data e hora do cadastro do perfil de pagamento
      - `payment_company` PaymentCompany, required
        - `id` integer, required: ID da bandeira ou banco
        - `name` string, required: Nome da bandeira ou banco
        - `code` string, required: Código para referência via API
    - `invoice_split` string: Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano.
    - `subscription_affiliates` SubscriptionAffiliateResponseFull[]: Lista de participantes da assinatura. Este campo é exclusivo para transaçõesque utilizaram a regra de split de pagamento e os participantes estejam ativos.
      - `affiliate_id` integer: ID do participante
      - `amount` number: Fração do valor da assinatura referente ao participante
      - `amount_type` integer: Tipo de valor da assinatura, onde 1 representa uma quantia fixa (amount) e 2 representa a porcentagem (percentage)
      - `status` string: Status do participante em uma assinatura
  - `bill` BillSubscription
    - `id` integer, required: ID da fatura
    - `code` string: Código externo para referência via API
    - `amount` number, required: Valor da fatura
    - `installments` integer, required: Número de parcelas
    - `status` 'review' | 'pending' | 'paid' | 'canceled' | 'scheduled', required: Status da fatura
    - `billing_at` string: Data opcional de emissão da cobrança
    - `due_at` string: Data vencimento da fatura
    - `url` string, required: URL para pagamento da fatura
    - `created_at` string, required: Data e hora da geração da fatura
    - `charges` BillCharge[]: Cobranças da fatura
      - `id` integer, required: ID da cobrança
      - `amount` number, required: Valor da cobrança
      - `status` 'pending' | 'paid' | 'canceled' | 'processing' | 'fraud_review', required: Status da cobrança
      - `due_at` string, required: Data do vencimento da cobrança
      - `paid_at` string: Data do pagamento da cobrança, apenas se a cobrança já foi paga
      - `installments` integer, required: Número de parcelas da cobrança. Valores acima de 1 são usados apenas para parcelamento através da administradora do cartão de crédito
      - `attempt_count` integer: Número de tentativas automáticas de cobrança já realizadas
      - `next_attempt` integer: Data da próxima tentativa automática de cobrança
      - `print_url` string: URL para impressão da cobrança. Usado apenas para boletos
      - `created_at` string, required: Data e hora da geração da cobrança
      - `updated_at` string, required: Data e hora da última atualização da cobrança
      - `last_transaction` TransactionSummary, required
        - `id` integer, required: ID da transação
        - `transaction_type` 'charge' | 'refund' | 'authorization' | 'capture' | 'verify' | 'register' | 'void' | 'renew_payment_profile' | 'pre_authorization' | 'update', required: Tipo da transação
        - `status` 'processing' | 'success' | 'rejected' | 'failure' | 'timeout' | 'waiting' | 'canceled' | 'fraud_review', required: Status da transação
        - `amount` number, required: Valor da transação
        - `installments` integer, required: Número de parcelas
        - `gateway_message` string, required: Mensagem de resposta do gateway
        - `gateway_response_code` string, required: Código de resposta do gateway
        - `gateway_authorization` string, required: Código da autorização usado no estorno ou captura. Varia de acordo com o adquirente
        - `gateway_transaction_id` string, required: Código externo de referência do gateway. Para boletos, representa o "nosso número"
        - `gateway_response_fields` string: Atributos de resposta específicos do gateway
        - `fraud_detector_score` number: Pontuação da análise antifraude entre 0.00 e 1.00. Quanto maior a pontuação, maior o risco de fraude
        - `fraud_detector_status` 'automatic_success' | 'manual_success' | 'automatic_rejected' | 'manual_rejected' | 'review' | 'failure': Status da análise antifraude
        - `fraud_detector_id` string: ID da análise antifraude
        - `created_at` string, required: Data e hora da transação
        - `gateway` GatewaySummary, required
          - `id` integer, required: ID do gateway
          - `connector` string, required: Conector utilizado no gateway
        - `payment_profile` PaymentProfileSummary, required
          - `id` integer, required: ID do perfil de pagamento
          - `holder_name` string: Nome do titular/portador do perfil de pagamento
          - `registry_code` string: CPF ou CNPJ do titular/portador
          - `bank_branch` string: Agência da conta bancária
          - `bank_account` string: Número da conta bancária
          - `card_expiration` string: Validade do cartão de crédito no formato MM/AA
          - `allow_as_fallback` string: Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.
          - `card_number_first_six` string: Primeiros 6 dígitos do cartão de crédito (BIN/IIN)
          - `card_number_last_four` string: Últimos 4 dígitos do cartão de crédito
          - `renewed_card` object
            - `card_number_last_four` string: Últimos quatro dígitos do cartão de crédito renovado
            - `card_expiration` string: Nova validade do cartão de crédito renovado
          - `card_renewed_at` string: Data da renovação do cartão de crédito renovado
          - `token` string, required: Token interno para referência do perfil de pagamento
          - `created_at` string, required: Data e hora do cadastro do perfil de pagamento
          - `payment_company` PaymentCompany, required
            - `id` integer, required: ID da bandeira ou banco
            - `name` string, required: Nome da bandeira ou banco
            - `code` string, required: Código para referência via API
      - `payment_method` PaymentMethodSummary, required
        - `id` integer, required: ID do método de pagamento
        - `public_name` string, required: Nome público do método de pagamento
        - `name` string, required: Nome interno do método de pagamento
        - `code` string, required: Código externo para referência via API
        - `type` string, required: Tipo do método de pagamento
    - `payment_profile` PaymentProfileSummary
      - `id` integer, required: ID do perfil de pagamento
      - `holder_name` string: Nome do titular/portador do perfil de pagamento
      - `registry_code` string: CPF ou CNPJ do titular/portador
      - `bank_branch` string: Agência da conta bancária
      - `bank_account` string: Número da conta bancária
      - `card_expiration` string: Validade do cartão de crédito no formato MM/AA
      - `allow_as_fallback` string: Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.
      - `card_number_first_six` string: Primeiros 6 dígitos do cartão de crédito (BIN/IIN)
      - `card_number_last_four` string: Últimos 4 dígitos do cartão de crédito
      - `renewed_card` object
        - `card_number_last_four` string: Últimos quatro dígitos do cartão de crédito renovado
        - `card_expiration` string: Nova validade do cartão de crédito renovado
      - `card_renewed_at` string: Data da renovação do cartão de crédito renovado
      - `token` string, required: Token interno para referência do perfil de pagamento
      - `created_at` string, required: Data e hora do cadastro do perfil de pagamento
      - `payment_company` PaymentCompany, required
        - `id` integer, required: ID da bandeira ou banco
        - `name` string, required: Nome da bandeira ou banco
        - `code` string, required: Código para referência via API

## Other responses

- `400`: Erro de sintaxe JSON no corpo do request.
- `422`: Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.dev/vindi/apis/api-vindi.md) - [All operations](https://skmtc.dev/vindi/apis/api-vindi/llms.txt) - [OpenAPI document](https://skmtc.dev/vindi/apis/api-vindi/revisions/3e857e1cdd03?raw)