Api reference
List the authenticated customer's invoices
Returns invoices owned by the authenticated customer, reverse-chronological by invoice_date. Use the same starting_after/ending_before cursor pattern as subscriptions.
Related endpoints
POST /customer-portal/sessions— Create a customer-portal sessionGET /customer-portal/customer— Retrieve the authenticated customerGET /customer-portal/subscriptions— List the authenticated customer's subscriptionsGET /customer-portal/subscriptions/{id}— Retrieve a subscriptionPOST /customer-portal/subscriptions/{id}/cancel— Cancel a subscriptionGET /customer-portal/invoices/{id}— Retrieve an invoice
Common errors
401 unauthenticated— missing, malformed, or revoked API key.
Pagination
Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.
x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Query Parameters
limit?integer
Default
20Range
1 <= value <= 100starting_after?string
Format
uuidending_before?string
Format
uuidResponse Body
application/json
application/json
curl "https://api.revkeen.com/v2/customer-portal/invoices" \ -H "x-api-key: $REVKEEN_API_KEY"{
"object": "list",
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"object": "invoice",
"invoice_number": "string",
"status": "string",
"currency": "string",
"subtotal": 0,
"tax_amount": 0,
"discount_amount": 0,
"total": 0,
"amount_paid": 0,
"amount_due": 0,
"invoice_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"paid_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"has_more": true,
"url": "string"
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}