Skip to main content
GET
/
invoices
List invoices
curl --request GET \
  --url https://billing-api.sandbox.z2pay.com/invoices \
  --header 'x-api-key: <api-key>'

Authorizations

​
x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
status
enum<string>[]
required
Available options:
scheduled,
suspended,
open,
paid,
past_due,
unpaid,
canceled,
refunded
​
subscriptionId
string
​
subscriptionIds
string[]
required
Maximum string length: 36
​
subscriptionCode
string
Maximum string length: 20
​
customerId
string
​
paymentMethods
enum<string>[]
required
Available options:
card,
pix,
boleto,
other
​
paymentMethodSubscriptionIds
string[]
required
Maximum string length: 36
​
search
string
​
code
string
Maximum string length: 20
​
customer
string
Maximum string length: 255
​
totalMin
integer
required
Required range: x >= 0
​
totalMax
integer
required
Required range: x >= 0
​
dateField
enum<string>
Available options:
issued,
due,
paid,
created,
charge
​
dateFrom
​
dateTo
​
orderBy
enum<string>
Available options:
createdAt,
dueAt,
code,
customer,
paidAt,
value
​
order
enum<string>
Available options:
asc,
desc
​
idsIn
string[]

Response

Paginated list