Detalhes de uma assinatura

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

Obtém os detalhes de uma assinatura por id

Path params

id

id da assinatura

Response params (200)

id
string

id da assinatura

createdAt
datetime

data de criação da assinatura

updatedAt
datetime

data de atualização da assinatura

status
enum

status da assinatura

upToDate
awaitingPayment
late
canceled
defaulter
suspended
trial
finished
free
firstInvoiceId
string

id da primeira fatura da assinatura

isFinite
boolean

indica se a assinatura é finita

isUnlimitedInstallments
boolean

indica se a assinatura é parcelamento sem limites

hasNegotiation
boolean

indica se a assinatura possui alguma fatura negociada

interruption
object

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

interruption.createdAt
datetime

data da interrupção

interruption.type
enum

tipo da interrupção

cancel
suspend
interruption.removeAccessDate
datetime

data de remoção do acesso

interruption.reason
string

motivo da interrupção

interruption.origin
string

origem da interrupção

interruption.previousStatus
enum

status anterior

upToDate
awaitingPayment
late
canceled
defaulter
suspended
trial
finished
free
interruption.responsible
string

responsável pela interrupção

recurrence
object

informações sobre a recorrência da assinatura

recurrence.startsAt
datetime

data de início da recorrência

recurrence.nextDueDate
datetime

próxima data de vencimento

recurrence.currentDueDate
datetime

data de vencimento atual

recurrence.finalDueDate
datetime

data do último vencimento

recurrence.finishesAt
datetime

data de finalização da recorrência

recurrence.frequency
object

frequência da recorrência

recurrence.frequency.type
enum

tipo da frequência

daily
weekly
monthly
yearly
recurrence.frequency.value
number

período da frequência

charges
object

informações sobre as cobranças da assinatura

charges.total
number

total de cobranças

charges.current
number

em qual cobrança está atualmente

charges.paid
number

cobranças pagas

charges.pending
number

cobranças pendentes

charges.negotiated
number

cobranças negociadas

products
array of object

produtos da assinatura

products[n].id
string

id do produto

products[n].title
string

Nome do produto

products[n].hasMembershipFee
boolean

indica se o produto possui taxa de adesão

products[n].membershipFee
object

informações sobre a taxa de adesão

products[n].membershipFee.currency
string

moeda da taxa de adesão

products[n].membershipFee.value
number

valor da taxa de adesão

products[n].deliveries
array of string

tipos de entrega do produto

payment
object

informações sobre o pagamento da assinatura

payment.price
object

informações sobre o preço

payment.price.currency
string

moeda do preço

payment.price.value
number

valor do preço

payment.method
enum

método de pagamento

bankslip
creditcard
pix
unknown
payment.installments
number

número de parcelas

client
object

informações sobre o cliente

client.name
string

nome do cliente

client.email
string

email do cliente

client.phone
object

informações sobre o telefone do cliente

client.phone.countryCode
string

código do país (ddi)

client.phone.areaCode
string

código de área (ddd)

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/12345 \
3	--header 'accept: application/json' \
4	--header 'authorization: Bearer qzrUZcm4dISz/ayXgq7g9+GmusYbXHmIpJ7fbLYDIjUPtNwAN1rrsRZbeJ6e6tAlSUSy3w=='
Response
1{
2  "id": "123456",
3  "createdAt": "2024-01-15T15:00:00.000Z",
4  "updatedAt": "2024-01-20T15:00:00.000Z",
5  "status": "canceled",
6  "firstInvoiceId": "654321",
7  "isFinite": true,
8  "isUnlimitedInstallments": false,
9  "hasNegotiation": false,
10  "interruption": {
11    "createdAt": "2024-01-20T15:00:00.000Z",
12    "type": "cancel",
13    "removeAccessDate": "2024-02-30T15:00:00.000Z",
14    "reason": "Cliente não está realizando os pagamentos corretamente",
15    "origin": "MyEduzz",
16    "previousStatus": "late",
17    "responsible": "Atendimento Eduzz"
18  },
19  "recurrence": {
20    "startsAt": "2024-01-15T15:00:00.000Z",
21    "nextDueDate": "2024-02-15T15:00:00.000Z",
22    "currentDueDate": "2024-01-15T15:00:00.000Z",
23    "finalDueDate": "2025-06-15T15:00:00.000Z",
24    "finishesAt": "2025-07-15T15:00:00.000Z",
25    "frequency": {
26      "type": "monthly",
27      "value": 1
28    }
29  },
30  "charges": {
31    "total": 6,
32    "current": 1,
33    "paid": 1,
34    "pending": 0,
35    "negotiated": 0
36  },
37  "products": [
38    {
39      "id": "123321",
40      "title": "Teste Assinatura",
41      "hasMembershipFee": false,
42      "membershipFee": {
43        "currency": "BRL",
44        "value": 0
45      },
46      "deliveries": [
47        "files",
48        "external",
49        "nutror",
50        "alpaClass"
51      ]
52    }
53  ],
54  "payment": {
55    "price": {
56      "currency": "BRL",
57      "value": 1000
58    },
59    "method": "bankslip",
60    "installments": 6
61  },
62  "client": {
63    "name": "Fulano de tal",
64    "email": "fulanodetal@eduzz.com",
65    "phone": {
66      "countryCode": "55",
67      "areaCode": "15",
68      "number": "999999999"
69    }
70  }
71}