Detalhes do cliente

GET
https://api.eduzz.com/myeduzz/v1/subscriptions/customers/:email
Required scopes:myeduzz_subscriptions_read

Obtém os detalhes do cliente via email

Path params

email

email do cliente

Response params (200)

name
string

nome do cliente

email
string

Email do cliente

phone
object

Informações de telefone do cliente

phone.countryCode
string

Código do pais

phone.areaCode
string

Código de área

phone.number
string

Número

subscriptions
array of object

Informações de assinaturas

subscriptions[n].id
string

id da assinatura

subscriptions[n].createdAt
datetime

data de criação da assinatura

subscriptions[n].updatedAt
datetime

data de atualização da assinatura

subscriptions[n].status
enum

status da assinatura

upToDate
awaitingPayment
late
canceled
defaulter
suspended
trial
finished
free
subscriptions[n].firstInvoiceId
string

id da primeira assinatura

subscriptions[n].isFinite
boolean

indica se a assinatura é finita

subscriptions[n].isUnlimitedInstallments
boolean

indica se a assinatura é parcelamento sem limites

subscriptions[n].hasNegotiation
boolean

indica se a assinatura possui alguma fatura negociada

subscriptions[n].interruption
object

informações sobre a interrupção (suspensão ou cancelamento) da assinatura

subscriptions[n].interruption.createdAt
datetime

data da interrupção

subscriptions[n].interruption.type
enum

tipo da interrupção

cancel
suspend
subscriptions[n].interruption.removeAccessDate
datetime

data de remoção do acesso

subscriptions[n].interruption.reason
string

motivo da interrupção

subscriptions[n].interruption.origin
string

origem da interrupção

subscriptions[n].interruption.previousStatus
enum

status anterior

upToDate
awaitingPayment
late
canceled
defaulter
suspended
trial
finished
free
subscriptions[n].interruption.responsible
string

responsável pela interrupção

subscriptions[n].recurrence
object

informações sobre a recorrência da assinatura

subscriptions[n].recurrence.startsAt
datetime

data de início da recorrência

subscriptions[n].recurrence.nextDueDate
datetime

próxima data de vencimento

subscriptions[n].recurrence.currentDueDate
datetime

data de vencimento atual

subscriptions[n].recurrence.finalDueDate
datetime

data do último vencimento

subscriptions[n].recurrence.finishesAt
datetime

data de finalização da recorrência

subscriptions[n].recurrence.frequency
object

frequência da recorrência

subscriptions[n].recurrence.frequency.type
enum

tipo da frequência

daily
weekly
monthly
yearly
subscriptions[n].recurrence.frequency.value
number

período da frequência

subscriptions[n].charges
object

informações sobre as cobranças da assinatura

subscriptions[n].charges.total
number

total de cobranças

subscriptions[n].charges.current
number

em qual cobrança está atualmente

subscriptions[n].charges.paid
number

cobranças pagas

subscriptions[n].charges.pending
number

cobranças pendentes

subscriptions[n].charges.negotiated
number

cobranças negociadas

subscriptions[n].products
array of object

produtos da assinatura

subscriptions[n].products[n].id
string

id do produto

subscriptions[n].products[n].title
string

Nome do produto

subscriptions[n].products[n].hasMembershipFee
boolean

indica se o produto possui taxa de adesão

subscriptions[n].products[n].membershipFee
object

informações sobre a taxa de adesão

subscriptions[n].products[n].membershipFee.currency
string

moeda da taxa de adesão

subscriptions[n].products[n].membershipFee.value
number

valor da taxa de adesão

subscriptions[n].payment
object

informações sobre o pagamento da assinatura

subscriptions[n].payment.price
object

informações sobre o preço

subscriptions[n].payment.price.currency
string

moeda do preço

subscriptions[n].payment.price.value
number

valor do preço

subscriptions[n].payment.method
enum

método de pagamento

bankslip
creditcard
pix
unknown
subscriptions[n].payment.installments
number

número de parcelas

subscriptions[n].client
object

informações sobre o cliente

subscriptions[n].client.name
string

nome do cliente

subscriptions[n].client.email
string

email do cliente

subscriptions[n].client.phone
object

informações sobre o telefone do cliente

subscriptions[n].client.phone.countryCode
string

código do país (ddi)

subscriptions[n].client.phone.areaCode
string

código de área (ddd)

subscriptions[n].client.phone.number
string

número do telefone

Status codes

StatusDescrição
200Success
404Assinatura não encontrada
422Erro de validação

Exemplos

1curl --request GET \
2	--url https://api.eduzz.com/myeduzz/v1/subscriptions/customers/fulanodetal@eduzz.com \
3	--header 'accept: application/json' \
4	--header 'authorization: Bearer qzrUZcm4dISz/ayXgq7g9+GmusYbXHmIpJ7fbLYDIjUPtNwAN1rrsRZbeJ6e6tAlSUSy3w=='
Response
1{
2  "name": "fulanodetal",
3  "email": "fulanodetal@eduzz.com",
4  "phone": {
5    "countryCode": "55",
6    "areaCode": "15",
7    "number": "999999999"
8  },
9  "subscriptions": [
10    {
11      "id": "2060691",
12      "startDate": "2024-01-15T15:00:00.000Z",
13      "updatedAt": null,
14      "status": "upToDate",
15      "firstInvoiceId": "51128029",
16      "interruption": {
17        "createdAt": "2024-01-15T15:00:00.000Z",
18        "type": "cancel",
19        "removeAccessDate": "2024-01-15T15:00:00.000Z",
20        "reason": "Cliente não está realizando os pagamentos corretamente",
21        "origin": "Myeduzz",
22        "previousStatus": "late",
23        "responsible": "Atendimento Eduzz"
24      },
25      "isUnlimitedInstallments": false,
26      "hasNegotiation": false,
27      "isFinite": false,
28      "recurrence": {
29        "startsAt": "2024-01-15T15:00:00.000Z",
30        "nextDueDate": "2024-02-15T15:00:00.000Z",
31        "currentDueDate": "2024-01-15T15:00:00.000Z",
32        "finalDueDate": "2025-01-09T15:00:00.000Z",
33        "finishesAt": "2025-01-09T15:00:00.000Z",
34        "frequency": {
35          "type": "monthly",
36          "value": 1
37        }
38      },
39      "products": [
40        {
41          "id": "1737509",
42          "name": "Teste Assinatura",
43          "hasMembershipFee": false,
44          "membershipFee": {
45            "currency": "BRL",
46            "value": 0
47          }
48        }
49      ],
50      "payment": {
51        "price": {
52          "currency": "BRL",
53          "value": 1000
54        },
55        "method": "bankslip",
56        "installments": 6
57      },
58      "charges": {
59        "total": 6,
60        "current": 2,
61        "paid": 1,
62        "pending": 3,
63        "negotiated": 0
64      }
65    }
66  ]
67}