🔗Editar um Plano

Valor a ser pago no ato da adesão do plano, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00Valor a ser pago no ato da adesão do plano, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00Edição de um plano

Para editar um plano existente, você pode fazer uma requisição PUT com um objeto JSON contendo os detalhes atualizados do plano para a seguinte URL:

URL de Solicitação:

https://api.zsystems.com.br/planos/{PlanoId}

Cabeçalhos Exigidos para a Requisição:

  • Content-Type: Necessário especificar como multipart/form-data ou application/json, adaptado ao método de envio dos dados.

  • Authorization: Precisa incluir um 'TokenAPI', precedido por Bearer, para confirmar a autenticação e conceder permissão para realizar a solicitação.

Detalhes dos Parâmetros da Solicitação:

Id

Tipo

Descrição

PlanoId

Identificador do plano já cadastrado

name

Nome do plano. Ex.: Plano semanal

description

Descrição do plano, falando sobre os beneficios da assinatura

setup_amount

Valor a ser pago no ato da adesão do plano, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00

amount

Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00

grace_period

Período gratuito antes da primeira cobrança

tolerance_period

Período de tolerância quando o pagamento não ocorre

frequency

Frequencia na qual a recorrencia vai acontecer. Nesse campo pode receber 4 valores, sendo eles: ['daily', 'weekly', 'monthly', 'annualy']

interval

Intervalo de tempo que vai acontecer a recorrencia, por exemplo: Se você tiver marcado que a frequencia é semanal e colocar o valor de 1 nesse campo, semanalmente ocorrera a cobrança, mas se você colocar o valor de 2, a cobrança ocorrera de 2 em 2 semanas. No caso de colocar 4 , a cobrança ocorrerá acada 4 semanas

currency

Tipo de moeda a ser utilizado, no caso sempre BRL

payment_methods

Métodos de pagamento, no futuro pode ser implementado outros métodos, mas hoje só está disponível via crédito

Exemplo de requisição:

{
  "name": "Plano 6 Avançado",
  "description": "Plano portal de noticias + Plus",
  "setup_amount": 0,
  "amount": 100,
  "grace_period": "0",
  "tolerance_period": 3,
  "frequency": "monthly",
  "interval": 1
}

Exemplo de resultado:

{
  "success": true,
  "message": "Operação realizada com sucesso",
  "plano": {
    "id": 42,
    "name": "Plano Mensal---",
    "description": "Plano com cobrança recorrente mensal",
    "frequency": "monthly",
    "interval": 1,
    "amount": 125,
    "setup_amount": 25,
    "currency": "BRL",
    "grace_period": "0",
    "tolerance_period": 0,
    "duration": null,
    "created": "2019-11-26T20:18:43.000Z",
    "modified": "2019-11-26T20:18:43.000Z",
    "removed": null
  }
}

Last updated