Detalhes de uma lista de assinaturas
Obtém os detalhes das assinaturas por intervalo de data
Query params
number
Body params
data inicial da busca no formato 2024-01-01T00:00:00
data final da busca no formato 2024-01-31T23:59:59
pesquisa pela criação, ou alteração do registro
Response params (200)
id da assinatura
data de criação da assinatura
data de atualização da assinatura
status da assinatura
id da primeira fatura da assinatura
indica se a assinatura é finita
indica se a assinatura é parcelamento sem limites
indica se a assinatura possui alguma fatura negociada
informações sobre a interrupção (suspensão ou cancelamento) da assinatura
data da interrupção
tipo da interrupção
data de remoção do acesso
motivo da interrupção
origem da interrupção
status anterior
responsável pela interrupção
informações sobre a recorrência da assinatura
data de início da recorrência
próxima data de vencimento
data de vencimento atual
data do último vencimento
data de finalização da recorrência
frequência da recorrência
tipo da frequência
período da frequência
informações sobre as cobranças da assinatura
total de cobranças
em qual cobrança está atualmente
cobranças pagas
cobranças pendentes
cobranças negociadas
produtos da assinatura
id do produto
Nome do produto
indica se o produto possui taxa de adesão
informações sobre a taxa de adesão
moeda da taxa de adesão
valor da taxa de adesão
tipos de entrega do produto
informações sobre o pagamento da assinatura
informações sobre o preço
moeda do preço
valor do preço
método de pagamento
número de parcelas
informações sobre o cliente
nome do cliente
email do cliente
informações sobre o telefone do cliente
código do país (ddi)
código de área (ddd)
número do telefone
Status codes
| Status | Descrição |
| 200 | Success |
| 422 | Erro de validação |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/myeduzz/v1/subscriptions \
3 --header 'accept: application/json' \
4 --header 'authorization: Bearer qzrUZcm4dISz/ayXgq7g9+GmusYbXHmIpJ7fbLYDIjUPtNwAN1rrsRZbeJ6e6tAlSUSy3w=='1{
2 "pages": 49,
3 "page": 2,
4 "itemsPerPage": 15,
5 "totalItems": 733,
6 "items": [
7 {
8 "id": "123456",
9 "createdAt": "2024-01-15T15:00:00.000Z",
10 "updatedAt": "2024-01-20T15:00:00.000Z",
11 "status": "canceled",
12 "firstInvoiceId": "654321",
13 "isFinite": true,
14 "isUnlimitedInstallments": false,
15 "hasNegotiation": false,
16 "interruption": {
17 "createdAt": "2024-01-20T15:00:00.000Z",
18 "type": "cancel",
19 "removeAccessDate": "2024-02-30T15: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 "recurrence": {
26 "startsAt": "2024-01-15T15:00:00.000Z",
27 "nextDueDate": "2024-02-15T15:00:00.000Z",
28 "currentDueDate": "2024-01-15T15:00:00.000Z",
29 "finalDueDate": "2025-06-15T15:00:00.000Z",
30 "finishesAt": "2025-07-15T15:00:00.000Z",
31 "frequency": {
32 "type": "monthly",
33 "value": 1
34 }
35 },
36 "charges": {
37 "total": 6,
38 "current": 1,
39 "paid": 1,
40 "pending": 0,
41 "negotiated": 0
42 },
43 "products": [
44 {
45 "id": "123321",
46 "title": "Teste Assinatura",
47 "hasMembershipFee": false,
48 "membershipFee": {
49 "currency": "BRL",
50 "value": 0
51 },
52 "deliveries": [
53 "files",
54 "external",
55 "nutror",
56 "alpaClass"
57 ]
58 }
59 ],
60 "payment": {
61 "price": {
62 "currency": "BRL",
63 "value": 1000
64 },
65 "method": "bankslip",
66 "installments": 6
67 },
68 "client": {
69 "name": "Fulano de tal",
70 "email": "fulanodetal@eduzz.com",
71 "phone": {
72 "countryCode": "55",
73 "areaCode": "15",
74 "number": "999999999"
75 }
76 }
77 }
78 ]
79}