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.

Base URL

https://api.revkeen.com/v2

Use https://staging-api.revkeen.com/v2 for test mode. No real charges are created in test mode.

Authentication

All API requests require authentication via the x-api-key header:

curl https://api.revkeen.com/v2/invoices \
  -H "x-api-key: rk_live_..."

Environment	Key prefix	Description
Test mode	`rk_sandbox_`	No real charges. Safe for development.
Live mode	`rk_live_`	Real transactions. Use in production.

Get your API keys from Dashboard > Settings > API Keys. See Authentication for OAuth 2.1 and scoped keys.

Rate limits

Environment	Requests / min	Burst
Test mode	100	200
Production	1,000	2,000
Enterprise	Custom	Custom

Rate-limited responses return 429 Too Many Requests with a Retry-After header. See Rate Limits.

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

Customers

Create and manage customers, payment methods, entitlements, and portal sessions

CRUDPayment MethodsEntitlementsPortal

Products & Pricing

Product catalogue, pricing tiers, and discounts

ProductsPricesDiscounts

Invoices

Create, send, and manage invoices and credit notes

InvoicesCredit NotesComments

Subscriptions

Recurring billing, plan changes, and scheduling

LifecycleItemsSchedules

Payments

Payment intents, charges, refunds, and voids

IntentsChargesRefundsVoids

Checkout

Payment links and hosted checkout sessions

Payment LinksSessions

Usage Billing

Meters, usage events, and consumption-based billing

MetersEventsBalance

Orders

Create, pay, and fulfil orders

Transactions & Payouts

View transactions, disputes, and settlement payouts

TransactionsDisputesPayouts

Terminal

Card-present payments and terminal device management

PaymentsDevices

Analytics & Finance

Revenue metrics, customer analytics, and financial reports

MRRLTVCheckoutDSO

Webhooks & Events

Event subscriptions, webhook endpoints, and delivery tracking

EventsEndpointsDeliveries

Automations

Automated workflows with approval gates

WorkflowsRunsApprovals

Communications

Messaging threads and message delivery

ThreadsMessages

Integrations

External system connections and sync state

Data Management

Bulk import and export data

Customers

Create and manage customers, their payment methods, entitlements, and portal sessions.

Customers

POST/customersCreate a new customer GET/customersList customers GET/customers/{id}Get customer by ID PATCH/customers/{id}Update customer details GET/customers/{id}/payment-methodsGet payment methods GET/customers/{id}/invoicesList customer invoices GET/customers/{id}/subscriptionsList customer subscriptions GET/customers/{id}/ordersList customer orders GET/customers/{id}/paymentsList customer payments POST/customers/{id}/portal-sessionsCreate a portal session PUT/customers/external/batchBatch upsert customers PUT/customers/external/{source}/{id}Upsert by external ID

Entitlements

GET/customers/{id}/entitlementsList customer entitlements POST/customers/{id}/entitlementsGrant entitlement GET/customers/{id}/entitlements/checkCheck entitlement DELETE/customers/{id}/entitlements/{eid}Revoke by ID DELETE/customers/{id}/entitlementsRevoke by benefit key GET/entitlementsList entitlements GET/entitlements/checkCheck entitlement access

Customer Portal

GET/customer-portal/customerGet portal customer GET/customer-portal/invoicesList portal invoices GET/customer-portal/invoices/{id}Get portal invoice GET/customer-portal/subscriptionsList portal subscriptions GET/customer-portal/subscriptions/{id}Get portal subscription POST/customer-portal/subscriptions/{id}/cancelCancel portal subscription POST/customer-portal/sessionsCreate portal session

Products & Pricing

Manage your product catalogue, pricing tiers, and discounts.

Products

POST/productsCreate product GET/productsList products GET/products/{id}Get product by ID PATCH/products/{id}Update product PUT/products/external/{source}/{id}Upsert product by external ID PUT/products/external/batchBatch upsert products

Prices

POST/pricesCreate a price GET/pricesList prices GET/prices/{id}Retrieve a price PATCH/prices/{id}Update a price DELETE/prices/{id}Archive a price

Discounts

POST/discountsCreate a discount GET/discountsList discounts GET/discounts/{id}Get discount by ID PATCH/discounts/{id}Update a discount DELETE/discounts/{id}Delete a discount

Invoices & Credit Notes

Create, send, and manage invoices. Issue credit notes for partial or full refunds.

Invoices

POST/invoicesCreate invoice GET/invoicesList invoices GET/invoices/{id}Get invoice PATCH/invoices/{id}Update invoice DELETE/invoices/{id}Delete invoice POST/invoices/{id}/finalizeFinalize an invoice POST/invoices/{id}/sendSend an invoice POST/invoices/{id}/payRecord a payment POST/invoices/{id}/voidVoid an invoice POST/invoices/{id}/refundRefund invoice POST/invoices/{id}/rejectReject invoice GET/invoices/{id}/commentsList invoice comments POST/invoices/{id}/commentsAdd invoice comment PUT/invoices/external/batchBatch upsert invoices PUT/invoices/external/{source}/{externalId}Upsert invoice by external ID

Credit Notes

POST/credit_notesCreate a credit note GET/credit_notesList credit notes GET/credit_notes/{id}Get credit note by ID POST/credit_notes/{id}/voidVoid a credit note POST/credit_notes/previewPreview a credit note GET/credit_notes/{id}/linesList line items GET/credit_notes/invoice/{id}/eligibilityCheck credit eligibility GET/credit_notes/transaction/{id}/reversal-eligibilityCheck reversal eligibility

Subscriptions

Create and manage recurring billing, plan changes, and billing schedules.

Subscriptions

POST/subscriptionsCreate a new subscription GET/subscriptionsList subscriptions GET/subscriptions/{id}Get subscription by ID PATCH/subscriptions/{id}Update subscription details DELETE/subscriptions/{id}Delete subscription POST/subscriptions/{id}/change-planChange subscription plan POST/subscriptions/{id}/change-quantityChange quantity POST/subscriptions/{id}/pausePause subscription POST/subscriptions/{id}/resumeResume subscription POST/subscriptions/{id}/cancelCancel subscription POST/subscriptions/{id}/reactivateReactivate subscription POST/subscriptions/{id}/preview-renewalPreview renewal

Subscription Items

GET/subscriptions/{id}/itemsList subscription items POST/subscriptions/{id}/itemsAdd item to subscription PATCH/subscriptions/{id}/items/{itemId}Update subscription item DELETE/subscriptions/{id}/items/{itemId}Remove item

Subscription Schedules

POST/subscription-schedulesCreate a subscription schedule GET/subscription-schedulesList subscription schedules GET/subscription-schedules/{id}Retrieve a schedule POST/subscription-schedules/{id}Update a schedule POST/subscription-schedules/{id}/cancelCancel a schedule POST/subscription-schedules/{id}/releaseRelease a schedule

Billing

POST/billing/previewGenerate billing schedule preview GET/billing/intervalsGet billing intervals GET/billing/anchor-rulesGet billing anchor rules

Payments

Process one-time payments, capture authorized charges, and manage refunds and voids.

Payment Intents

POST/payment-intentsCreate a payment intent GET/payment-intentsList payment intents GET/payment-intents/{id}Retrieve a payment intent POST/payment-intents/{id}Update a payment intent POST/payment-intents/{id}/confirmConfirm a payment intent POST/payment-intents/{id}/captureCapture a payment intent POST/payment-intents/{id}/cancelCancel a payment intent

Charges

POST/chargesCreate a one-time charge GET/chargesList charges GET/charges/{id}Get charge POST/charges/{id}/captureCapture charge POST/charges/{id}/refundRefund charge

Payments

GET/paymentsList payments GET/payments/{id}Retrieve a payment

Refunds

POST/refundsCreate a refund GET/refundsList refunds GET/refunds/{id}Get refund by ID

Voids

POST/voidsCreate a void GET/voidsList voids GET/voids/{id}Get void by ID

Checkout

Create payment links and hosted checkout sessions for your customers.

Payment Links

POST/payment-linksCreate a new payment link GET/payment-linksList payment links GET/payment-links/{id}Get payment link by ID PATCH/payment-links/{id}/statusUpdate payment link status POST/payment-links/{id}/expireExpire a payment link POST/payment-links/{id}/activateActivate a payment link POST/payment-links/{id}/deactivateDeactivate a payment link POST/payment-links/{id}/archiveArchive a payment link

Checkout Sessions

POST/checkout-sessionsCreate a checkout session GET/checkout-sessions/{id}Retrieve a checkout session POST/checkout-sessions/{id}/expireExpire a checkout session

Usage Billing

Ingest usage events, define meters, and bill customers based on consumption.

Meters

POST/metersCreate a meter GET/metersList meters GET/meters/{id}Get a meter PATCH/meters/{id}Update a meter POST/meters/{id}/pricesCreate a meter price GET/meters/{id}/pricesList meter prices PATCH/meters/{id}/prices/{priceId}Update a meter price POST/meters/{id}/prices/{priceId}/deactivateDeactivate a meter price

Usage Events

POST/usage-eventsIngest usage events GET/usage-eventsQuery usage events POST/usage-events/dry-runDry-run usage events GET/usage-events/aggregate/{meterId}Get aggregated usage

Usage Balance

GET/usage/balanceGet current usage balance

Customer Meters

GET/customers/{id}/metersList customer meters GET/customers/{id}/meters/{meterId}Get customer meter

Orders

Create, pay for, and fulfil orders.

Orders

POST/ordersCreate an order GET/ordersList orders GET/orders/{id}Retrieve an order PATCH/orders/{id}Update an order POST/orders/{id}/payPay for an order POST/orders/{id}/cancelCancel an order POST/orders/{id}/fulfillFulfill an order

Transactions & Payouts

View transactions, disputes, and settlement payouts across all payment activity.

Transactions

GET/transactionsList transactions GET/transactions/{id}Get transaction by ID

Disputes

GET/disputesList disputes GET/disputes/openGet open disputes GET/disputes/{id}Get dispute by ID

Payouts

GET/payoutsList payouts GET/payouts/{id}Get payout by ID GET/payouts/{id}/paymentsGet payments in a payout

Terminal

Initiate and manage in-person payments through connected terminal devices.

Terminal Payments

POST/terminal-paymentsInitiate a terminal payment GET/terminal-paymentsList terminal payments GET/terminal-payments/{id}Retrieve a terminal payment POST/terminal-payments/{id}/cancelCancel a terminal payment POST/terminal-payments/{id}/refundRefund a terminal payment POST/terminal-payments/{id}/voidVoid a terminal payment

Terminal Devices

GET/terminal-devicesList terminal devices GET/terminal-devices/{id}Retrieve a terminal device

Analytics & Finance

Access revenue metrics, customer analytics, checkout funnels, and financial reports.

Revenue

GET/analytics/revenue/mrr-summaryMRR Summary GET/analytics/revenue/time-seriesRevenue Time Series

Collections & Invoices

GET/analytics/invoices/ar-agingA/R Aging Report GET/analytics/collections/dsoDays Sales Outstanding

Customer Analytics

GET/analytics/customers/ltvCustomer LTV GET/analytics/customers/{id}Customer Analytics

Checkout Analytics

GET/analytics/payment-links/conversionPayment Link Conversion GET/analytics/checkout/funnelCheckout Funnel Analytics GET/analytics/checkout/abandonment/summaryAbandonment Summary GET/analytics/checkout/abandonmentList Abandonment Alerts GET/analytics/checkout/winback/summaryWinback Summary GET/analytics/checkout/winbackList Winback Opportunities

Finance

GET/finance/incomeGet income report GET/finance/summaryGet finance summary

Webhooks & Events

Subscribe to real-time event notifications and manage webhook endpoints.

Events

GET/eventsList events GET/events/{id}Retrieve an event POST/events/{id}/resendResend webhook for an event POST/events/testCreate a test event

Webhook Endpoints

POST/webhook-endpointsCreate webhook endpoint GET/webhook-endpointsList webhook endpoints GET/webhook-endpoints/{id}Get webhook endpoint PATCH/webhook-endpoints/{id}Update webhook endpoint DELETE/webhook-endpoints/{id}Delete webhook endpoint POST/webhook-endpoints/{id}/rotate-secretRotate webhook secret

Webhook Deliveries

GET/webhook-deliveriesList webhook deliveries GET/webhook-deliveries/{id}Get webhook delivery POST/webhook-deliveries/{id}/retryRetry webhook delivery

Automations

Create and manage automated workflows with approval gates.

Automations

POST/automationsCreate an automation GET/automationsList automations GET/automations/{id}Retrieve an automation POST/automations/{id}/runsRun an automation GET/automations/{id}/runsList runs for an automation GET/automations/{id}/runs/{runId}Retrieve a run GET/automations/approvalsList approvals POST/automations/approvals/{id}/approveApprove an approval POST/automations/approvals/{id}/rejectReject an approval

Communications

Manage messaging threads and send messages to customers.

Messages

GET/comms/threadsList message threads GET/comms/messagesList messages POST/comms/messagesSend a message

Integrations

Connect RevKeen with external systems, manage sync state, and configure provider mappings.

Integrations

GET/integrationsList all integrations GET/integrations/{provider}Get integration status POST/integrations/{provider}/activateActivate integration POST/integrations/{provider}/deactivateDeactivate integration POST/integrations/{provider}/testTest integration credentials POST/integrations/{provider}/syncTrigger manual sync PUT/integrations/{provider}/statusUpdate integration status PUT/integrations/{provider}/sync-toggleToggle integration sync PUT/integrations/{provider}/sync-intervalUpdate sync interval

External Sync

GET/sync-state/{source}/{merchantId}Get sync states PUT/sync-state/{source}/{merchantId}/{type}Update sync state

Data Management

Import and export data in bulk.

Imports

POST/importsCreate an import GET/imports/{id}Get import status

Exports

POST/exportsCreate an export GET/exports/{id}Get export status

RevKeen Assistant

Ask me about RevKeen

I answer from documentation only. No account access.

Create a new customer

Next Page