Atualizar forma de pagamento
Define por onde as próximas cobranças serão feitas — e ativa a assinatura, quando ela ainda não cobrava.
POST /subscriptions/:id/payment-method
Faz parte do recurso Assinaturas — o conceito e os dez estados estão lá.
Troca a forma de pagamento padrão da assinatura. É também a única rota que tira uma assinatura de
incomplete.
- cartão novo — tokenize com o Tokenizer SDK e envie o
tok_emtoken. O cartão é salvo na carteira do cliente antes de virar o padrão; - cartão já salvo — envie o
crd_emcardId. Se não pertencer ao cliente da assinatura, responde409; - PIX ou boleto — só o
type, semtokennemcardId.
canceled, completed e incomplete_expired
respondem 409 — não há cobrança futura para configurar.incomplete. Ver
Faturas.Exemplo
crd_ da resposta é o cartão materializado a partir do tok_ enviado — o token é efêmero, o
cartão salvo é permanente. O exemplo está abreviado; o playground mostra o corpo inteiro.Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID da assinatura
Body
Response
Forma de pagamento atualizada
Identificador único do registro.
Número do endereço.
Código do contrato no sistema do integrador; pesquisável, sem unicidade.
ID do cliente associado ao registro.
E-mail do cliente.
Nome do cliente.
Documento do cliente (CPF ou CNPJ).
Moeda no padrão ISO 4217 (ex.: BRL).
Status atual do registro (assinatura, fatura, plano ou slip de pagamento).
incomplete, incomplete_expired, trialing, active, past_due, unpaid, paused, canceled, completed ID do grupo de cobrança ao qual o registro pertence; nulo se não agrupado.
Início do período de cobrança atual da assinatura (ISO 8601).
Fim do período de cobrança atual da assinatura (ISO 8601).
Data e hora prevista para a próxima fatura da assinatura (ISO 8601).
Regra de recorrência (intervalo, unidade e âncora do ciclo).
Como a fatura é cobrada. Hoje só a cobrança automática na forma de pagamento padrão.
charge_automatically Momento da cobrança do ciclo: prepaid (no início) ou postpaid (no fim).
prepaid, postpaid Modo de geração de faturas: just_in_time (a cada ciclo) ou upfront (todas antecipadas).
just_in_time, upfront Indica se a assinatura será cancelada ao fim do período atual.
Data e hora do cancelamento; nula se não cancelado (ISO 8601).
Data e hora em que a assinatura foi efetivamente encerrada; nula se ainda ativa (ISO 8601).
Motivo do cancelamento da assinatura.
Data e hora em que a assinatura foi pausada; nula se não pausada (ISO 8601).
Data e hora agendada para a retomada automática da assinatura pausada (ISO 8601).
Motivo da pausa da assinatura.
Data e hora de término do período de teste; nula se sem trial (ISO 8601).
Prazo para concluir o primeiro pagamento antes de a assinatura incompleta expirar (ISO 8601).
Lembretes de fim do período de teste já disparados para a assinatura.
Número máximo de ciclos da assinatura; nulo se não houver limite.
Número de ciclos já faturados (faturas emitidas) da assinatura.
Número de ciclos já concluídos (pagos) da assinatura.
Referência da forma de pagamento padrão usada para cobrar a assinatura.
Configuração de divisão (split) dos valores entre recebedores; nula se sem split.
O que fazer quando a primeira cobrança não é aprovada: allow_incomplete cria a assinatura com a fatura em aberto; error_if_incomplete cancela a assinatura.
allow_incomplete, error_if_incomplete ID da fatura mais recente gerada pela assinatura.
Token do link público para o cliente atualizar a forma de pagamento; nulo se não gerado.
Formas de pagamento permitidas no link público de troca; nula se não habilitada.
Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
Itens que a assinatura cobra.