Skip to content
Baiyar DocsBaiyar DocsBaiyar Docs

List invoices

Lists invoices visible to this API key, newest first.

GET/v1/invoices
Requires invoices:read permission.

Query parameters

Section titled “Query parameters”
project_idstringoptional

Only the invoices of this project.

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

statusstringoptional

Only invoices in this status.

Example: draft

Possible values: draft, open, paying, paid, expired, void

qstringoptional

The invoice number, or part of the customer's name or email.

Example: Budi

Min length: 1

Max length: 100

starting_afterstringoptional

The id of the last item on the page you have. The next page starts after it.

Example: inv_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with inv_.

limitintegeroptional

How many items one page holds, from 1 to 100. The default is 20.

Example: 20

Minimum: 1

Maximum: 100

Response (200)

Section titled “Response (200)”

Returns a page of a list: data holds the items, and meta.pagination says how the list goes on. Page with limit and starting_after (the id of the last item you have), or fetch meta.pagination.next.

dataarray of objectrequired

The returned object, or an array of objects for a list.

idstringrequired

The id of the invoice (inv_…).

Example: inv_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with inv_.

livemodebooleanrequired

true means this object belongs to live and can involve real payments; false means it belongs to the sandbox.

project_idstringrequired

The project this object belongs to. Its settings determine which payment methods and limits apply.

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

numberstringrequired

The running number of your invoices, by month: INV/2026/10/0001. A number is never used twice.

Example: INV/2026/10/0001

statusstringrequired

draft (editable), open (waiting for payment), paying (a payment is under way), paid, expired (past its due date) or void.

Example: open

Possible values: draft, open, paying, paid, expired, void

customer_namestringrequired

The name of the customer you bill.

Example: Budi Santoso

customer_emailstringrequired

Where the pay link is mailed when you issue the invoice in live.

Example: budi@example.com

customer_phonestring | nullrequired

The customer's phone number; optional.

Example: +628123456789

notestring | nullrequired

A note printed on the invoice, up to 500 characters.

Example: Terima kasih atas kepercayaannya.

itemsarray of objectrequired

The lines of the bill, from 1 to 50.

descriptionstringrequired

Name the product or service being billed on this invoice line.

Example: Desain logo

quantityintegerrequired

Number of units on this line; multiplied by unit_amount to calculate amount.

Example: 2

unit_amountintegerrequired

The price of one unit, a whole rupiah, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 30000000

amountintegerrequired

The line total: quantity times the unit price, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 60000000

currencystringrequired

The currency, an ISO 4217 code. Only IDR today.

Example: IDR

Value: IDR

subtotalintegerrequired

The sum of the lines, before tax, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 60000000

tax_rate_bpintegerrequired

One tax rate for the whole invoice in basis points: 1100 is 11%. No tax when left out.

Example: 1100

tax_amountintegerrequired

The tax, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 6600000

totalintegerrequired

What the customer pays: the subtotal plus the tax, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 66600000

fee_bearerstringrequired

Who bears Baiyar's fee: merchant takes it out of what you receive, customer adds it to what the payer pays.

Example: merchant

Possible values: merchant, customer

due_atstringrequired

When the invoice is due (RFC 3339). After that the pay link no longer takes payments.

Example: 2026-11-15T16:59:59Z

Format: date-time

urlstring | nullrequired

The address to send to the customer, where they pay. Null until the invoice is issued.

Example: https://pay.baiyar.com/p/lt_live_…

payment_link_idstring | nullrequired

The single-use payment link made when the invoice was issued; null for a draft.

Example: lnk_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with lnk_.

issued_atstring | nullrequired

When it was issued; null for a draft.

Example: 2026-10-26T03:04:05.000Z

Format: date-time

paid_atstring | nullrequired

When the payment was confirmed as paid (RFC 3339, UTC); null until then.

Example: 2026-10-26T03:04:05.000Z

Format: date-time

voided_atstring | nullrequired

When it was voided; null otherwise.

Example: 2026-10-26T03:04:05.000Z

Format: date-time

versionintegerrequired

Send it back when you rewrite a draft, so a save by somebody else in between is noticed.

Example: 1

created_atstringrequired

When this object was created (RFC 3339, UTC). Use it to sort objects by creation time.

Example: 2026-10-26T03:04:05.000Z

Format: date-time

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

paginationobjectrequired

Pagination details for a list response. Use next to fetch the next page, or starting_after to build the URL yourself.

per_pageintegerrequired

Number of items returned on this page.

Example: 20

has_morebooleanrequired

true means more items are available on another page.

nextstring | nullrequired

The address of the next page, with your filters kept; null on the last page.

Example: string

A failed request answers with the common error shape; see Errors.

curl "https://api.baiyar.com/v1/invoices" \
  -H "Authorization: Bearer $BAIYAR_KEY"