ReferenceCheckout sessions

List checkout sessions

Required scopecheckouts:readThe API key must hold this scope, otherwise Kivoo answers 403 insufficient_scope.
GET/v1/checkouts

Sessions of the store, newest first. externalReference finds those of one of your users.

Authorization

apiKey
AuthorizationBearer <token>

An API key of the store, kv_live_…

In: header

Query Parameters

page?number

Page to return, from 1

Range1 <= value
Default1
pageSize?number

Items per page, 1 to 100

Range1 <= value <= 100
Default25
externalReference?string

Only the sessions of this external reference

Lengthlength <= 255
status?string

Only this status

Value in

  • "open"
  • "paid"
  • "expired"
productId?string

Only the sessions of this license

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.kivoo.africa/v1/checkouts" \  -H "Authorization: Bearer kv_live_EXAMPLE0000000000000000000000000000000000"
{  "page": 1,  "pageSize": 25,  "total": 42,  "data": [    {      "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",      "url": "https://atelier-nour.kivoo.co/checkout/Xk2Lp9QwRt5vZb8NcY3mHs7JdF4gA6eU",      "status": "open",      "expiresAt": "2026-10-19T09:12:00.000Z",      "product": {        "id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c6b",        "title": "Plan Pro — 30 jours"      },      "amount": 4500,      "currency": "XAF",      "externalReference": "42",      "metadata": {        "plan": "pro",        "workspace": "acme"      },      "returnUrl": "https://app.example.com/billing/return",      "customer": {        "email": "awa@example.com",        "lastName": "Diallo",        "firstName": "Awa"      },      "country": "GA",      "order": null,      "licenseKey": null,      "createdAt": "2026-10-18T09:12:00.000Z"    }  ]}