Retrieve an invoice
Retrieves an invoice by its Kelviq invoice ID.
Authorizations
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
The unique Kelviq identifier of the invoice.
Response
Invoice details.
"INV-20260801101420-Q7M2P"
A product in the catalog. Each product can have multiple plans, images and files.
DRAFT, OPEN, PAID, VOID, UNCOLLECTIBLE, PAYMENT_FAILED "PAID"
"2026-08-01T10:14:22Z"
Decimal amount, serialized as a string (e.g. "40.00"), not a JSON number.
"40.00"
Decimal amount, serialized as a string, not a JSON number.
"0.00"
Decimal amount, serialized as a string, not a JSON number.
"0.00"
Decimal amount, serialized as a string, not a JSON number.
"40.00"
"USD"
4000
0
0
4000
"$"
The billing address of the customer.
A versioned plan attached to a product. Updates create new versions; only the published version is is_latest=true.
ONE_TIME, SUBSCRIPTION "SUBSCRIPTION"
Licenses issued for the invoice's subscription, if the plan includes licensing. Empty for a one-time-payment invoice.
Summary of the subscription linked to this order. An empty object ({}) when the order has no linked subscription.
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).
"https://portal.kelviq.com/acme-inc/pay/aW5fMVJwb1pvU0JzdEN6eW9jUzdpUG1pdGgz"
"2026-08-01T10:14:20Z"
"2026-08-01T10:14:22Z"
null
Number of payment attempts made against this invoice.
1
When Stripe will next retry collection, if a retry is scheduled.
null
Details of the most recent failed payment attempt. null once the invoice is paid.
null
Line items and balance details for the invoice.
The payment method used for the order's first successful transaction. null if no successful transaction exists yet.