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

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

​
GET — resposta

​
id
string
​
name
string
​
allow_credit_card
boolean
​
max_installments
string
​
max_installments_no_tax
string
​
allow_boleto
boolean
​
boleto_max_installments
integer
​
boleto_expiration_date
string
​
boleto_payment_limit_date
string
​
boleto_body_instructions
string
​
boleto_late_fee_mode
string
​
boleto_late_fee_value
integer
​
boleto_late_fee_start_date
string
​
boleto_interest_mode
string
​
boleto_interest_value
integer
​
boleto_interest_start_date
string
​
boleto_discounts
array
​
allow_pix
boolean
{
  "id": "f2c0c1a4-9c98-4e6e-bd14-7c5a3a6b1bcd",
  "name": "Cursos - Padrao",
  "allow_credit_card": true,
  "max_installments": "12",
  "max_installments_no_tax": "3",
  "allow_boleto": true,
  "boleto_max_installments": 1,
  "boleto_expiration_date": "2026-06-30",
  "boleto_payment_limit_date": "2026-07-15",
  "boleto_late_fee_mode": "PERCENTAGE",
  "boleto_late_fee_value": 200,
  "boleto_interest_mode": "MONTHLY_PERCENTAGE",
  "boleto_interest_value": 100,
  "boleto_discounts": [
    {"mode": "PERCENTAGE", "value": 10, "until_date": "2026-06-20"}
  ],
  "allow_pix": true
}

​
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

StatusQuando
400Falha de validação em PUT / PATCH.
401Credenciais ausentes ou inválidas.
403Sem acesso ao seller_id.
404Plano não encontrado para este vendedor.

​
Exemplos

curl "https://api.dlpay.cloud/sales/seller/$SELLER_ID/paymentplans/$PLAN_ID/" \
  -H "Authorization: Bearer $ACCESS_TOKEN"