RevKeenRevKeen Docs

API Reference

v2

Complete reference documentation for the RevKeen API v2

The RevKeen API v2 is organized around REST. Built with OpenAPI 3.1, our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Environments

Production

Live transactions, real money

https://api.revkeen.com/v2
SandboxRecommended for testing

Test environment, no real charges

https://sandbox-api.revkeen.com/v2
Mock Server

Schema validation with mock responses

https://mock-api.revkeen.com/v2

Authentication

The RevKeen API uses API keys to authenticate requests. Include your API key in the x-api-key header:

x-api-key: rk_sandbox_your_api_key
rk_live_*

Production API key

rk_sandbox_*

Sandbox API key

Core Resources

📄

Customers

Customer management and payment methods
📄

Products

Product catalog and pricing
📄

Prices

Fixed, PWYW, and free pricing models
📄

Subscriptions

Recurring billing management
📄

Invoices

Invoice creation and payment processing
📄

Orders

One-off purchases with lifecycle ops

Payments & Billing

📄

Charges

One-time charges for existing customers
📄

Payment Links

Shareable payment pages
📄

Checkout Sessions

Hosted checkout experiences
📄

Refunds

Refund management and tracking
📄

Disputes

Chargeback handling with evidence
📄

Payouts

Settlement batches and tracking

Configuration & Analytics

📄

Discounts

Percentage and fixed amount discounts
📄

Tax Rates

Manual tax rate overrides
📄

Webhooks

Event notifications

Interactive API Reference

Explore our complete API with interactive examples, try requests directly from the documentation, and generate code snippets for multiple languages.

Full API Reference with Code Samples

Interactive documentation with request/response examples, SDK code snippets in TypeScript, Python, PHP, and more. Try API calls directly in your browser.

Open API Reference
Download OpenAPI SpecOpen in API Client

Developer Tools

Tools to accelerate your integration with RevKeen.

Mock Server

Test your integration with realistic mock responses without affecting real data.

https://mock-api.revkeen.com/v2

OpenAPI Spec

Import our OpenAPI 3.1 spec into your favorite API tools like Postman or Insomnia.

Download JSON spec

API Client

Use Scalar API Client to test endpoints interactively with your API key.

Open API Client

Code Generation

Generate type-safe SDKs in TypeScript, Python, Go, and more from our OpenAPI spec.

View SDKs

Response Codes

CodeDescription
200OK - The request was successful
201Created - A new resource was created
400Bad Request - The request was malformed
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource does not exist
422Unprocessable Entity - Validation failed
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Something went wrong

Rate Limiting

The RevKeen API implements rate limiting to ensure fair usage. Rate limits are applied per API key:

  • Standard tier: 1,000 requests per minute
  • Pro tier: 5,000 requests per minute
  • Enterprise: Custom limits available
Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

SDKs & Libraries

Use our official SDKs for easier integration. All SDKs are auto-generated from our OpenAPI specification using Fern.

📄

TypeScript SDK

@revkeen/sdk on npm
📄

Python SDK

revkeen on PyPI
📄

PHP SDK

revkeen/sdk-php on Packagist