RevKeenDocs
StatusSupport
API Reference

API Reference

Complete REST API reference for the RevKeen billing and payments platform

The RevKeen API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Make your first request · Authentication

GETPOSTPUTPATCHDELETEWebhook

135 operations and 58 webhook events.

Core Payments

9 operations

Payment Intents, Refunds

Checkout

26 operations

Payment Links, Checkout Sessions, Cart Sessions, Storefront

Billing & Subscriptions

26 operations

Invoices, Credit Notes, Subscriptions, Billing

Usage Billing

9 operations

Meters, Usage Events, Usage

Products & Pricing

14 operations

Products, Prices

Customers & Vault

10 operations

Customers, Entitlements, Payment Methods

Money Movement

2 operations

Transactions

Webhooks & Events

10 operations

Events, Webhook Endpoints

Invoice Line Items

1 operations

Invoice Line Items

Accounting Integrations

2 operations

Accounting Integrations

Webhook Deliveries

3 operations

Webhook Deliveries

Customer Portal

12 operations

Customer Portal

Customer Meters

2 operations

Customer Meters

Direct Debit

3 operations

Direct Debit

Mandates

6 operations

Mandates

Webhooks

Receive and verify 58 event types from RevKeen.

Make your first staging request

Set your staging API key in your server environment, then list customers. A matching key returns 200 OK with a list payload.

Terminal · staging
export REVKEEN_API_KEY=rk_sandbox_your_api_key
curl https://staging-api.revkeen.com/v2/customers \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Accept: application/json"

Follow the complete quickstart · Authentication and key setup

Base URL

https://api.revkeen.com/v2

Use https://staging-api.revkeen.com/v2 for pre-production testing. Staging data persists. Verify your payment provider's test configuration before testing payment workflows; staging does not guarantee that every connected provider is simulated. See Environments.

Authentication

All API requests require authentication. Send your merchant API key in the x-api-key header, or as Authorization: Bearer <key> — both are accepted:

curl https://api.revkeen.com/v2/invoices \
  -H "x-api-key: rk_live_..."
EnvironmentKey prefixDescription
Stagingrk_sandbox_Pre-production testing against staging.
Live moderk_live_Real transactions. Use in production.

Create and manage API keys in Dashboard → Settings → Developer. See Authentication for scopes, IP allowlists, rolling, and OAuth 2.1.

Rate limits

Each API key may make 600 requests per minute, in production and sandbox alike. The limit is per key, counted over a 60-second window, with no separate burst allowance. Some endpoints apply their own, lower limits. An over-limit key is still valid: wait for Retry-After and retry rather than re-authenticating.

Requests are rate limited. Rate-limited responses return 429 Too Many Requests with type: rate_limit_error, code: rate_limit_exceeded, and a Retry-After header in whole seconds. Where the limiter publishes them, X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (a UNIX timestamp in seconds) accompany the response. See Errors.

Idempotency

All POST endpoints accept an Idempotency-Key header (UUID v4 recommended). Keys are valid for 24 hours. Duplicate requests within the TTL return the original response. See Idempotency.

Versioning

The API is versioned by date. Pin a version via the RevKeen-Version header:

RevKeen-Version: 2026-05-01

Browse by category

Core Payments

Payment Intents

Create a payment intentPOST

/payment-intents

List payment intentsGET

/payment-intents

Retrieve a payment intentGET

/payment-intents/{id}

Confirm a payment intentPOST

/payment-intents/{id}/confirm

Capture a payment intentPOST

/payment-intents/{id}/capture

Cancel a payment intentPOST

/payment-intents/{id}/cancel
Refunds

List refundsGET

/refunds

Create a refundPOST

/refunds

Get refund by IDGET

/refunds/{id}

Checkout

Payment Links

Create a new payment linkPOST

/payment-links

List payment linksGET

/payment-links

Get payment link by IDGET

/payment-links/{id}

Expire a payment linkPOST

/payment-links/{id}/expire

Update payment link statusPATCH

/payment-links/{id}/status

Deactivate a payment linkPOST

/payment-links/{id}/deactivate

Activate a payment linkPOST

/payment-links/{id}/activate

Archive a payment linkPOST

/payment-links/{id}/archive
Checkout Sessions

Create a checkout sessionPOST

/checkout-sessions

Retrieve a checkout sessionGET

/checkout-sessions/{id}

Expire a checkout sessionPOST

/checkout-sessions/{id}/expire
Cart Sessions

Create a cart sessionPOST

/cart-sessions

Retrieve a cart sessionGET

/cart-sessions/{id}

Add a line item to a cart sessionPOST

/cart-sessions/{id}/line-items

Update a line item's quantityPATCH

/cart-sessions/{id}/line-items/{line_id}

Remove a line item from a cart sessionDELETE

/cart-sessions/{id}/line-items/{line_id}

Toggle an add-on on a cart sessionPOST

/cart-sessions/{id}/add-ons

Set or clear a cart discount codePOST

/cart-sessions/{id}/discount-code

Capture customer email + consent on a cartPOST

/cart-sessions/{id}/contact

Convert a cart session into a checkout sessionPOST

/cart-sessions/{id}/convert
Storefront

List storefront productsGET

/storefront/products

Get a storefront productGET

/storefront/products/{product_id}

List storefront originsGET

/storefront/origins

Register a storefront originPOST

/storefront/origins

Remove a storefront originDELETE

/storefront/origins/{origin_id}

Get storefront integration statusGET

/storefront/status

Billing & Subscriptions

Invoices

Explain invoice usage chargesGET

/invoices/{id}/usage-explain

List invoicesGET

/invoices

Create invoicePOST

/invoices

Get invoiceGET

/invoices/{id}

Update invoicePATCH

/invoices/{id}

Get invoice PDF linkGET

/invoices/{id}/pdf

Finalize an invoicePOST

/invoices/{id}/finalize

Void an invoicePOST

/invoices/{id}/void

Send an invoicePOST

/invoices/{id}/send

Record or collect a paymentPOST

/invoices/{id}/pay
Credit Notes

List credit notesGET

/credit_notes

Create a credit notePOST

/credit_notes

Get credit note by IDGET

/credit_notes/{id}

Void a credit notePOST

/credit_notes/{id}/void

List line items on a credit noteGET

/credit_notes/{id}/lines

Preview a credit note without creating itPOST

/credit_notes/preview
Subscriptions

Create a new subscriptionPOST

/subscriptions

List subscriptionsGET

/subscriptions

Get subscription by IDGET

/subscriptions/{id}

Update subscription detailsPATCH

/subscriptions/{id}

Change subscription planPOST

/subscriptions/{id}/change-plan

Preview a plan changePOST

/subscriptions/{id}/preview-change-plan

Pause subscriptionPOST

/subscriptions/{id}/pause

Resume subscriptionPOST

/subscriptions/{id}/resume

Cancel subscriptionPOST

/subscriptions/{id}/cancel
Billing

Get merchant billing overviewGET

/billing/overview

Usage Billing

Meters

List metersGET

/meters

Create a meterPOST

/meters

Get meter quantitiesGET

/meters/{id}/quantities

Get a meterGET

/meters/{id}

Update a meterPATCH

/meters/{id}
Usage Events

Ingest usage eventsPOST

/usage-events

Query usage eventsGET

/usage-events

Get a usage eventGET

/usage-events/{id}
Usage

Get current usage balanceGET

/usage/balance

Products & Pricing

Products

List productsGET

/products

Create productPOST

/products

Get product by IDGET

/products/{id}

Update productPATCH

/products/{id}

List product collectionsGET

/product-collections

Create a product collectionPOST

/product-collections

Get a product collectionGET

/product-collections/{id}

Update a product collectionPATCH

/product-collections/{id}

Delete a product collectionDELETE

/product-collections/{id}
Prices

List pricesGET

/prices

Create a pricePOST

/prices

Retrieve a priceGET

/prices/{id}

Update a pricePATCH

/prices/{id}

Archive a priceDELETE

/prices/{id}

Customers & Vault

Customers

Get customer billing stateGET

/customers/{id}/state

Create a new customerPOST

/customers

List customersGET

/customers

Get customer by IDGET

/customers/{id}

Update customer detailsPATCH

/customers/{id}

Get customer payment methodsGET

/customers/{id}/payment-methods
Entitlements

List entitlementsGET

/entitlements

Check entitlement accessGET

/entitlements/check
Payment Methods

Detach a payment method from its customerPOST

/payment-methods/{id}/detach

Set a payment method as its customer's defaultPOST

/payment-methods/{id}/set-default

Money Movement

Transactions

List transactionsGET

/transactions

Get transaction by IDGET

/transactions/{id}

Webhooks & Events

Events

List eventsGET

/events

Retrieve an eventGET

/events/{id}

Resend webhook for an eventPOST

/events/{id}/resend
Webhook Endpoints

List webhook endpointsGET

/webhook-endpoints

Create webhook endpointPOST

/webhook-endpoints

Get webhook endpointGET

/webhook-endpoints/{id}

Update webhook endpointPATCH

/webhook-endpoints/{id}

Delete webhook endpointDELETE

/webhook-endpoints/{id}

Rotate signing secretPOST

/webhook-endpoints/{id}/rotate-secret

Redeliver an event to this endpointPOST

/webhook-endpoints/{id}/redeliver

Invoice Line Items

Invoice Line Items

List usage events for an invoice lineGET

/invoice-line-items/{id}/usage-events

Accounting Integrations

Accounting Integrations

Create an accounting-led invoice payment requestPOST

/integrations/accounting/invoice-payment-requests

Get an accounting-led invoice payment requestGET

/integrations/accounting/invoice-payment-requests/{id}

Webhook Deliveries

Webhook Deliveries

List webhook deliveriesGET

/webhook-deliveries

Retrieve a webhook deliveryGET

/webhook-deliveries/{id}

Retry a webhook deliveryPOST

/webhook-deliveries/{id}/retry

Customer Portal

Customer Portal

Create a customer-portal sessionPOST

/customer-portal/sessions

Retrieve the authenticated customerGET

/customer-portal/customer

List the authenticated customer's subscriptionsGET

/customer-portal/subscriptions

Retrieve a subscriptionGET

/customer-portal/subscriptions/{id}

Cancel a subscriptionPOST

/customer-portal/subscriptions/{id}/cancel

List the authenticated customer's invoicesGET

/customer-portal/invoices

Retrieve an invoiceGET

/customer-portal/invoices/{id}

List the authenticated customer's Direct Debit mandatesGET

/customer-portal/mandates

Re-authorise a Direct Debit mandate with new bank detailsPOST

/customer-portal/mandates/{id}/re-authorize

Cancel a Direct Debit mandatePOST

/customer-portal/mandates/{id}/cancel

Send a step-up OTP for a Direct Debit bank-detail changePOST

/customer-portal/mandates/{id}/re-authorize/send-otp

Verify a step-up OTP and receive a change-of-bank tokenPOST

/customer-portal/mandates/{id}/re-authorize/verify-otp

Customer Meters

Customer Meters

List a customer's meter usageGET

/customer-meters

Retrieve a customer-meter aggregateGET

/customer-meters/{customer_id}/{meter_id}

Direct Debit

Direct Debit

Look up a pending signed mandate requestGET

/dd/mandate-requests/{token}

Validate a UK bank account for Direct DebitPOST

/dd/validate

Preview the Direct Debit collection date chainPOST

/dd/preview

Mandates

Mandates

List Direct Debit mandatesGET

/mandates

Retrieve a Direct Debit mandateGET

/mandates/{id}

Cancel a Direct Debit mandatePOST

/mandates/{id}/cancel

Suspend a Direct Debit mandatePOST

/mandates/{id}/suspend

Reinstate a suspended Direct Debit mandatePOST

/mandates/{id}/reinstate

Schedule a one-off Direct Debit collectionPOST

/mandates/{id}/collections

Webhook events

Requests sent by RevKeen to your endpoint. Set up signature verification and delivery handling.

Payment succeededWebhook

payment.succeeded

Payment failedWebhook

payment.failed

Invoice createdWebhook

invoice.created

Invoice paidWebhook

invoice.paid

Invoice overdueWebhook

invoice.overdue

Subscription createdWebhook

subscription.created

Subscription activatedWebhook

subscription.activated

Subscription canceledWebhook

subscription.canceled

Subscription renewedWebhook

subscription.renewed

Subscription pausedWebhook

subscription.paused

Subscription resumedWebhook

subscription.resumed

Subscription plan changedWebhook

subscription.plan_changed

Customer createdWebhook

customer.created

Customer updatedWebhook

customer.updated

Refund createdWebhook

refund.created

Refund succeededWebhook

refund.succeeded

Void createdWebhook

void.created

Void succeededWebhook

void.succeeded

Void failedWebhook

void.failed

Credit note createdWebhook

credit_note.created

Credit note issuedWebhook

credit_note.issued

Credit note voidedWebhook

credit_note.voided

Checkout session completedWebhook

checkout.session.completed

Checkout session expiredWebhook

checkout.session.expired

Order createdWebhook

order.created

Order paidWebhook

order.paid

Terminal payment requestedWebhook

terminal_payment.requested

Terminal payment succeededWebhook

terminal_payment.succeeded

Terminal payment declinedWebhook

terminal_payment.declined

Terminal payment cancelledWebhook

terminal_payment.cancelled

Terminal payment errorWebhook

terminal_payment.error

Terminal refund succeededWebhook

terminal_refund.succeeded

Terminal void succeededWebhook

terminal_void.succeeded

Order fulfilledWebhook

order.fulfilled

Usage threshold reachedWebhook

usage.threshold.reached

Usage period finalizedWebhook

usage.period_finalized

Usage invoice createdWebhook

usage.invoice.created

Usage event ingestedWebhook

usage.event.ingested

Usage event rejectedWebhook

usage.event.rejected

Usage event excludedWebhook

usage.event.excluded

Usage event quarantinedWebhook

usage.event.quarantined

Usage cap exceededWebhook

usage.cap.exceeded

Meter createdWebhook

meter.created

Meter updatedWebhook

meter.updated

Meter archivedWebhook

meter.archived

Meter price createdWebhook

meter_price.created

Meter price updatedWebhook

meter_price.updated

Meter price deactivatedWebhook

meter_price.deactivated

Mandate signedWebhook

mandate.signed

Mandate activatedWebhook

mandate.activated

Mandate suspendedWebhook

mandate.suspended

Mandate cancelledWebhook

mandate.cancelled

Collection scheduledWebhook

collection.scheduled

Advance notice sentWebhook

collection.notice_sent

Collection succeededWebhook

collection.succeeded

Collection failedWebhook

collection.failed

Indemnity claimedWebhook

collection.indemnity_claimed

Settlement createdWebhook

settlement.created

Owner: david · Reviewed 30 Sep 2026 · Next review 30 Oct 2026

On this page

Base URLAuthenticationRate limitsIdempotencyVersioningBrowse by category