API Reference

Criar Assinatura

Cria uma assinatura.

Log in to see full request history

Criar Assinatura

Cria uma nova assinatura relacionando a mesma com um plano e cliente.

É 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" }

É necessário passar alguns dados através do Body para realizar a criação da assinatura.

Abaixo temos um exemplo de como inserir essas informações usando JSON.

{ "cliente_id":12345, "plano_id":123, "captura_id":12, "estabelecimento_id":123, "grupo_id":123, "ativo":true, "data_primeira_cobranca":"2023-06-27T23:59:59Z", "data_expiracao": "2023-06-30T23:59:59Z", "cobrar_na_adesao":true, "valor":1.0 }
Body Params
int32
required

Id do cliente. Ex.: 12345

int32
required

Id do plano. Ex.: 123

int32
required

Id da captura. Ex.: 16 (Cartão), 23 (Boleto) ou 24 (Pix).

int32
required

Id do estabelecimento. Ex.: 123

int32
required

Id do grupo. Ex.: 123

float
required

Valor da assinatura. Ex.: 10.99

boolean
required

Ativo. Ex.: true ou false

boolean
required

Cobrar na adesão da assinatura. Ex.: true ou false

string
required

Data de expiração. Ex.: 2023-06-30T23:59:59Z

string
required

Data da próxima cobrança. Ex.: 2023-06-30T23:59:59Z

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