API Reference

Criar Plano

Cria um novo plano.

Log in to see full request history

Criar Plano

Cadastra um novo plano em nossa base de dados de acordo com as informações passadas.

É necessário passar o token gerado no momento em que o usuário realiza o login no header "Authorization".

Abaixo temos um exemplo de como inserir essa informação usando JSON.

{ "Authorization": "eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0" }

No Body devemos passar obrigatoriamente todos os dados do plano.

Abaixo temos um exemplo de como inserir essa informação usando JSON.

{ "codigo_erp":"123", "nome":"Teste", "descricao":"Teste", "valor":1.0, "desconto":0.0, "total_estoque":1, "grupo_id":123, "quatidade_atual_adessoes":1, "quatidade_maxima_adessoes":1, "estabelecimento_id":123, "tipo_recorrencia_id":1 }
Body Params
string
required

Código ERP do cliente. Ex.: 1234

string
required

Nome do Plano. Ex.: Plano Anual

string
required

Descrição do plano. Ex.: Cobrança realizada anualmente.

double
required

Valor cobrado pelo plano. Ex.: 10.50

double
required

Desconto do plano. Ex.: 1.50

int32
required

Total do estoque. Ex.: 10

int32
required

Id do grupo em que pertence o plano. Ex.: 123

int32
required

Quantidade atual de adesões do plano. Ex.: 12

int32
required

Quantidade máxima de adesões. Ex.: 20

int32
required

Id do estabelecimento. Ex.: 123

int32
required

Id do tipo recorrência. Ex.: 12

Headers
string
required

Token gerado no momento em que o usuário realiza o login no portal. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json