🔗Webhook ao assinar um plano

Webhook ao assinar um plano:

Id
Descrição

ID

É o identificador dessa assinatura. Nesse caso 4;

plano_id

Refere-se a qual plano essa assinatura pertence, nesse caso é ao plano 17;

ativo

Assinatura ativa ou suspensa? (1 ativo, 0 suspenso)

status_assinatura_id

Status a qual o plano se encontra no momento

payment_method

É o método de pagamento

due_date

É a data da próxima cobrança

due_since_date

É a data da primeira cobrança

expiration_date

É a data de expiração da assinatura

suspended_date

É a data que a assinatura foi suspensa

ID(Plano)

É o identificador do plano, Nesse caso 15;

name

Nome do plano;

description

Descrição do plano

frequency

Frequência na qual o plano será cobrado (diário, semanal, mensal, anual)

interval

É o intervalo entre a próxima recorrência. Nesse caso está marcado como 1, então o plano será cobrado de 1 em 1 dia

amount

É o valor que será cobrado sempre que a recorrência ocorrer

step_amount

É o valor a ser cobrado no ato da adesão do plano.

grace_period

É o período gratuito antes de realizar a primeira cobrança

titulo(Status_assinatura)

Titulo do status desta assinatura;

ID(Cliente)

É o identificador do cliente

nome

É o nome do cliente

email

É o e-mail do cliente

sexo

é o sexo que o cliente definiu no ato do cadastro

data_nascimento

Data de nascimento do cliente

Endereco

Endereço do cliente

logradouro

Rua do cliente

numero

Número da residência

complemento

Complemento do endereço

cep

CEP da rua

cidade

Cidade

uf

Estado

clientes_documentos

Estado

documento

Número do documento

titulo(tipo_documento)

Titulo do documento (RG/CPF)

clientes_contatos

Telefones do cliente

tipo_contato_id

identificador do contato

contato

Número do contato

id(tipo_contato)

identificado do contato

titulo(tipo_contato)

Titulo do contato (celular/telefone)

hook_id

É o identificador do webhook

Exemplo body:

{
  "url": "https://google.com.br",
  "type": "subscription",
  "status": "created",
  "data": {
    "id": 4,
    "plano_id": 17,
    "cliente_id": 13572,
    "ativo": 1,
    "status_assinatura_id": 3,
    "payment_method": "credit",
    "due_date": "2020-01-23",
    "due_since_date": "2020-01-22",
    "expiration_date": null,
    "suspended_at": null,
    "amount": 1,
    "currency": "BRL",
    "created": "2020-01-22T20:43:22.000Z",
    "modified": "2020-01-22T20:46:25.000Z",
    "removed": null,
    "plano": {
      "id": 17,
      "name": "Plano 001",
      "description": "001",
      "frequency": "daily",
      "interval": 1,
      "amount": 1,
      "setup_amount": 0,
      "grace_period": "0",
      "tolerance_period": 0,
      "created": "2020-01-22T17:03:15.000Z",
      "modified": "2020-01-22T17:03:15.000Z"
    },
    "status_assinatura": {
      "titulo": "Pago"
    },
    "cliente": {
      "nome": "assinante",
      "email": "assinante@zsystems.com.br",
      "sexo": "M",
      "data_nascimento": "1991-12-26",
      "endereco": {
        "logradouro": "Rua Assinante",
        "numero": "124",
        "complemento": "",
        "cep": "03380235",
        "cidade": "São Paulo",
        "uf": "SP"
      },
      "clientes_documentos": [
        {
          "tipo_documento_id": 2,
          "documento": "413222222222",
          "tipo_documento": {
            "titulo": "CPF",
            "id": 2
          }
        }
      ],
      "clientes_contatos": [
        {
          "contato": "1142141241",
          "tipo_contato_id": 1,
          "tipo_contato": {
            "titulo": "Telefone",
            "id": 1
          }
        },
        {
          "contato": "41414141241",
          "tipo_contato_id": 2,
          "tipo_contato": {
            "titulo": "Celular",
            "id": 2
          }
        }
      ]
    }
  },
  "hook_id": 130
}

Last updated