Endpoint: GET /sales/seller/{seller_id}/paymentplans/{id}/
Autenticação: JWT Bearer ou chave de API do vendedor.
Endpoint de detalhe de um plano de pagamento. Os quatro verbos padrão estão disponíveis:
  • GET — recupera o plano.
  • PUT — substitui todos os campos editáveis.
  • PATCH — atualização parcial.
  • DELETE — remove o plano.
Remover um plano que ainda está referenciado por um checkout online faz com que os links de checkout vinculados também sejam removidos em cascata. Prefira criar um novo plano e reapontar os links de checkout para ele. A mesma representação é usada para leitura e escrita — consulte Listar planos de pagamento para o esquema completo do corpo.

Pré-requisitos

  • O plano deve existir.
  • O chamador precisa ter acesso ao seller_id.

Parâmetros de rota

string
required
UUID da conta unificada do vendedor.
string
required
UUID do plano de pagamento.

GET — resposta

string
string
boolean
string
string
boolean
integer
string
string
string
string
integer
string
string
integer
string
array
boolean

PUT / PATCH — corpo da requisição

Mesma estrutura do endpoint de criação em Listar planos de pagamento. PUT exige o corpo completo; PATCH aceita apenas as chaves que você quer alterar. Regras de validação para boleto se aplicam:
  • Se boleto_expiration_date for informado, boleto_payment_limit_date também precisa ser informado.
  • boleto_payment_limit_date deve ser maior ou igual a boleto_expiration_date.
  • boleto_late_fee_start_date deve ser maior ou igual a boleto_expiration_date.
  • boleto_interest_start_date deve ser maior ou igual a boleto_expiration_date.
Retorna o plano atualizado.

DELETE — resposta

204 No Content. Atenção: a remoção é em cascata para qualquer link de checkout que use este plano.

Erros

Exemplos