Lista as faturas de uma assinatura.
GET
https://api.eduzz.com/myeduzz/v1/subscriptions/:id/invoices
Required scopes:myeduzz_subscriptions_read
Obtém as faturas de uma assinatura.
Path params
id
Id da assinatura
Response params (200)
id
string
Id da fatura
subscriptionId
string
Id da assinatura
createdAt
datetime
Data de criação da fatura
dueDate
datetime
Data de pagamento da fatura
coupon
string
Cupom utilizado
hasAffiliate
boolean
Indica se a fatura tem afiliado
status
boolean
Indica o status da fatura
payment
object
Informações sobre o pagamento da fatura
payment.amount
object
Informações sobre o pagamento
payment.amount.currency
string
Moeda de pagamento
payment.amount.value
number
Valor do pagamento
payment.link
string
Link de pagamento da fatura (Apenas quando está aberta)
payment.method
enum
Método de pagamento
bankslip
creditcard
pix
unknown
items
array of object
Informações dos itens da fatura
items[n].product
object
Id da assinatura
items[n].product.id
string
Id do produto
items[n].product.title
string
Titulo do produto
items[n].description
string
Descrição do produto
items[n].amount
object
Informações sobre valor do produto
items[n].amount.amount
object
Informações sobre valor do produto
items[n].amount.amount.currency
string
Moeda do produto
items[n].amount.amount.value
number
Valor do produto
items[n].amount.total
object
Informações sobre valor total do produto na fatura
items[n].amount.total.currency
string
Moeda do produto
items[n].amount.total.value
number
Valor do produto
items[n].quantity
number
Indica a quantidade desse produto na fatura
Status codes
| Status | Descrição |
| 200 | Success |
| 404 | Assinatura não encontrada |
| 422 | Erro de validação |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/myeduzz/v1/subscriptions/12345/invoices \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'Response
1{
2 "items": [
3 {
4 "id": "123",
5 "subscriptionId": "12345",
6 "createdAt": "2024-05-24T10:00:34.000Z",
7 "dueDate": "2024-06-24T00:00:00.000Z",
8 "coupon": "teste",
9 "hasAffiliate": false,
10 "status": "open",
11 "payment": {
12 "amount": {
13 "currency": "BRL",
14 "value": 20
15 },
16 "link": "https://url-teste-pagamento/123456/123456?t=x",
17 "method": "creditCard"
18 },
19 "items": [
20 {
21 "product": {
22 "id": "123456789",
23 "title": "Teste"
24 },
25 "description": "Teste descrição produto",
26 "amount": {
27 "currency": "BRL",
28 "value": 20
29 },
30 "total": {
31 "currency": "BRL",
32 "value": 20
33 },
34 "quantity": 1
35 }
36 ]
37 }
38 ]
39}