SopagueDocs
v3

Alterar Meio de Pagamento

PUT/v2/recurrences/subscriptions/{subscriptionId}/payment-method

Atualiza o cartão vinculado à assinatura para as cobranças dos próximos ciclos do Job diário.

Cabeçalhos (Headers)

CabeçalhoValorObrigatórioDescrição
AuthorizationBearer <token>SimToken JWT Bearer autenticado
Content-Typeapplication/jsonSimTipo de mídia
Idempotency-Key<guid_ou_string>SimChave de idempotência

Parâmetros

Exemplo de requisição
{
  "paymentCustomerPaymentMethodId": "d4c3b2a1-5a6b-7c8d-9e0f-1a2b3c4d5e6f"
}

Resposta (200 OK)

Exemplo de resposta
{
  "id": "e1f2a3b4-5c6d-7e8f-9a01-234567890abc",
  "paymentMethodId": "d4c3b2a1-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "status": "ACTIVE"
}

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Possível resposta HTTP

O 404 pode ocorrer quando a rota ou o recurso solicitado não é encontrado. Confira a URL base, a versão da API, o caminho e o identificador do recurso, quando aplicável.

HTTP/1.1 404 Not Found

Este exemplo ilustra o status HTTP. O corpo da resposta depende da rota e do ambiente.