Contrato Criado

Notifica quando um contrato é criado.

Response params

producer
object

Informações do produtor.

producer.id
string

Id do produtor.

producer.name
string

Nome do produtor.

producer.email
string

Email do produtor.

products
array of object

Informações dos produtos.

products[n].id
string

Id do produto.

products[n].name
string

Nome do produto.

products[n].deliveries
array of string

Formas de entrega do produto.

products[n].plan
object

Plano do produto.

products[n].plan.id
string

Id do plano.

products[n].plan.name
string

Nome do plano.

products[n].price
object

Preço do produto.

products[n].price.currency
string

Moeda usada no produto.

products[n].price.value
number

Valor do produto.

products[n].membershipFee
object

Taxa de adesão.

products[n].membershipFee.currency
string

Moeda da taxa de adesão do produto.

products[n].membershipFee.value
number

Valor da taxa de adesão do produto.

contract
object

Informações do contrato.

contract.id
string

Id da fatura.

contract.payment
object

Informações de pagamento.

contract.payment.method
string

Forma de pagamento.

contract.payment.totalOfInstallments
number

Número de parcelas.

contract.status
enum

Status do contrato.

upToDate
awaitingPayment
late
canceled
defaulter
suspended
trial
finished
free
contract.trialDays
number

Dias de teste.

contract.createdAt
string

Data de criação do contrato.

contract.updatedAt
string

Data de atualização do contrato.

contract.contentAccess
object

Informações de acesso de conteúdo.

contract.contentAccess.removeOnContractEnd
boolean

Remover acesso ao conteúdo no final do contrato.

contract.contentAccess.removeOnLatePayment
boolean

Remover acesso ao conteúdo de pagamento com atraso.

contract.isPSL
boolean

Se o contrato é PSL (parcelamento sem limite).

contract.recurrence
object

Informações da recorrência.

contract.recurrence.startsAt
string

Data de inicio do contrato.

contract.recurrence.nextDue
string

Data do próximo vencimento.

contract.recurrence.currentDue
string

Data atual do contrato.

contract.recurrence.finalDue
string

Data do último vencimento.

contract.recurrence.finishesAt
string

Data do término do contrato.

contract.recurrence.frequency
object

Informações da frequência.

contract.recurrence.frequency.type
string

Tipo de frequência da cobrança.

contract.recurrence.frequency.value
number

Valor referente a frequência da cobrança.

contract.recurrence.charges
object

Informações da cobrança.

contract.recurrence.charges.total
number

Número de cobranças.

contract.recurrence.charges.current
number

Moeda usada nas cobranças.

contract.recurrence.isFinite
boolean

Se é finito ou infinito.

contract.recurrence.price
object

Informações de preço.

contract.recurrence.price.currency
string

Moeda usada no preço.

contract.recurrence.price.value
number

Valor do contrato.

customer
object

Informações do cliente.

customer.name
string

Nome do cliente.

customer.email
string

Email do cliente.

customer.phone
object

Informações do telefone do cliente.

customer.phone.countryCode
string

Código de telefone do país do cliente.

customer.phone.areaCode
string

Codigo de área do cliente.

customer.phone.number
string

Número de telefone do cliente.

financialResponsible
object

Informações do responsável financeiro.

financialResponsible.name
string

Nome do responsável financeiro

financialResponsible.email
string

Email do responsável financeiro

financialResponsible.phone
object

Informações do telefone do responsável financeiro.

financialResponsible.phone.countryCode
string

Código de telefone do país do responsável financeiro.

financialResponsible.phone.areaCode
string

Código de área do responsável financeiro.

financialResponsible.phone.number
string

Número de telefone do responsável financeiro.

Payload

1{
2  "producer": {
3    "id": "37296411",
4    "name": "Next Assinaturas",
5    "email": "qa-next@eduzz.com"
6  },
7  "products": [
8    {
9      "id": "1234",
10      "name": "Produto de assinatura",
11      "deliveries": [
12        "file",
13        "external",
14        "nutror",
15        "alpaclass"
16      ],
17      "plan": {
18        "id": null,
19        "name": null
20      },
21      "price": {
22        "currency": "BRL",
23        "value": 10
24      },
25      "membershipFee": {
26        "currency": "BRL",
27        "value": 10
28      }
29    }
30  ],
31  "contract": {
32    "id": "3456",
33    "payment": {
34      "method": "creditCard",
35      "totalOfInstallments": 12
36    },
37    "status": "upToDate",
38    "trialDays": 0,
39    "createdAt": "2024-01-15T15:00:00.000Z",
40    "updatedAt": "2024-01-15T15:00:00.000Z",
41    "contentAccess": {
42      "removeOnContractEnd": true,
43      "removeOnLatePayment": true
44    },
45    "isPSL": false,
46    "recurrence": {
47      "startsAt": "2024-01-15T15:00:00.000Z",
48      "nextDue": "2024-02-15T15:00:00.000Z",
49      "currentDue": "2024-01-15T15:00:00.000Z",
50      "lastDue": "2025-01-09T15:00:00.000Z",
51      "finishesAt": "",
52      "frequency": {
53        "type": "month",
54        "value": 1
55      },
56      "charges": {
57        "total": 1,
58        "current": 1
59      },
60      "isFinite": true,
61      "price": {
62        "currency": "BRL",
63        "value": 10
64      }
65    }
66  },
67  "customer": {
68    "name": "Teste QA Eduzz",
69    "email": "testeeduzzqa@eduzz.com",
70    "phone": {
71      "countryCode": "55",
72      "areaCode": "15",
73      "number": "5999999999"
74    }
75  },
76  "financialResponsible": {
77    "name": "Responsável Financeiro",
78    "email": "financial-responsible@eduzz.com",
79    "phone": {
80      "countryCode": "55",
81      "areaCode": "15",
82      "number": "5999999999"
83    }
84  }
85}