Skip to main content
GET
Retrieve an invoice
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

invoiceId
string
required

The unique Kelviq identifier of the invoice.

Response

Invoice details.

id
string
Example:

"INV-20260801101420-Q7M2P"

customer
object
product
object

A product in the catalog. Each product can have multiple plans, images and files.

status
enum<string>
Available options:
DRAFT,
OPEN,
PAID,
VOID,
UNCOLLECTIBLE,
PAYMENT_FAILED
Example:

"PAID"

paidAt
string<date-time> | null
Example:

"2026-08-01T10:14:22Z"

amountSubtotal
string | null

Decimal amount, serialized as a string (e.g. "40.00"), not a JSON number.

Example:

"40.00"

amountDiscount
string

Decimal amount, serialized as a string, not a JSON number.

Example:

"0.00"

amountTax
string | null

Decimal amount, serialized as a string, not a JSON number.

Example:

"0.00"

amountTotal
string | null

Decimal amount, serialized as a string, not a JSON number.

Example:

"40.00"

currency
string
Example:

"USD"

amountSubtotalUnits
integer<int64> | null
Example:

4000

amountDiscountUnits
integer<int64>
Example:

0

amountTaxUnits
integer<int64> | null
Example:

0

amountTotalUnits
integer<int64> | null
Example:

4000

currencySymbol
string
Example:

"$"

billingAddress
object | null

The billing address of the customer.

plan
object

A versioned plan attached to a product. Updates create new versions; only the published version is is_latest=true.

billingType
enum<string> | null
Available options:
ONE_TIME,
SUBSCRIPTION
Example:

"SUBSCRIPTION"

license
object[]

Licenses issued for the invoice's subscription, if the plan includes licensing. Empty for a one-time-payment invoice.

subscription
object

Summary of the subscription linked to this order. An empty object ({}) when the order has no linked subscription.

paymentId
string | null

Opaque identifier used to build a payment link for this invoice. Only set while the invoice is payable (OPEN or PAYMENT_FAILED, and not past due).

Hosted portal URL the customer can use to pay this invoice. null unless the invoice is currently payable (mirrors paymentId).

Example:

"https://portal.kelviq.com/acme-inc/pay/aW5fMVJwb1pvU0JzdEN6eW9jUzdpUG1pdGgz"

createdOn
string<date-time>
Example:

"2026-08-01T10:14:20Z"

modifiedOn
string<date-time>
Example:

"2026-08-01T10:14:22Z"

dueDate
string<date-time> | null
Example:

null

attemptCount
integer

Number of payment attempts made against this invoice.

Example:

1

nextPaymentAttempt
string<date-time> | null

When Stripe will next retry collection, if a retry is scheduled.

Example:

null

failureDetails
object | null

Details of the most recent failed payment attempt. null once the invoice is paid.

Example:

null

customFieldsData
object
Example:
details
object

Line items and balance details for the invoice.

paymentMethod
object | null

The payment method used for the order's first successful transaction. null if no successful transaction exists yet.