Skip to main content
GET
Get invoice payment status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoiceId
string
required
Pattern: ^[0-9a-fA-F]{24}$

Response

Invoice payment status information including payment status, amounts, and dates.

invoiceId
string
required
Pattern: ^[0-9a-fA-F]{24}$
billingStatus
enum<string>
required

The billing status of the invoice

Available options:
None,
Paid,
Rejected,
PendingPayment,
Overdue
amountDue
number
required
amountPaid
number
required
total
number
required
dueDate
string<date-time>
paidAt
string<date-time>
invoicePdfUrl
string