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

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/invoices \
3	--header 'accept: application/json' \
4	--header 'authorization: Bearer qzrUZcm4dISz/ayXgq7g9+GmusYbXHmIpJ7fbLYDIjUPtNwAN1rrsRZbeJ6e6tAlSUSy3w=='
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}