Using RevKeen

These guides walk you through common workflows and best practices for using RevKeen's billing platform. Whether you are integrating via the API or managing everything from the dashboard, the sections below cover every core concept.

Core Concepts

Customers -- Create and manage customer profiles with billing information and payment methods.
Products and Pricing -- Define your product catalog with flexible pricing models and discount codes.

Checkout and Payments

Checkout -- Use hosted checkout links, API-created sessions, and RevKeen display modes for secure payment collection.
Subscriptions -- Manage recurring billing with trials, discounts, and plan changes.
Invoices and Orders -- Generate and send professional invoices with automatic payment collection.

Operations and Recovery

Payments and Refunds -- Process payments, handle declines, and issue refunds.
Dunning -- Automatic payment retry and recovery for failed subscription payments.
Disputes -- Handle chargebacks and payment disputes effectively.
Benefits -- Attach digital benefits and entitlements to products and subscriptions.
Customer Portal -- Give customers self-service access to manage their accounts.

Object Relationships

Understanding how RevKeen objects relate to each other is essential for building effective billing workflows.

Products to Prices -- A product can have multiple prices (e.g., monthly at $29 and annual at $290).
Prices to Checkout Links -- A checkout link references one or more prices to create a purchasable offering.
Checkout to Invoices to Orders/Subscriptions -- Completing checkout creates an Invoice. For recurring products, a Subscription is created. For products with fulfillment, an Order is created when the invoice is paid.
Subscriptions to Invoices to Orders -- Subscriptions generate invoices at each billing period. Paid invoices with fulfillable items create orders.
Invoices to Payments -- Invoices track payment attempts, success, refunds, and disputes.
Everything to Events -- All actions generate events for a complete audit trail.

Quick Reference

Object Summary

Object	Purpose	Key Relationship
Product	Define what you sell	Has many Prices
Price	Define how much and how often	Belongs to Product
Checkout Link	Shareable purchase URL	References Prices
Customer	Who you bill	Has many Orders, Subscriptions
Order	Fulfillment tracking	Created from paid Invoice
Subscription	Recurring billing	Generates Invoices periodically
Invoice	Payment request	Has many Line Items
Discount	Promotional pricing	Applied to Orders/Subscriptions
Event	Audit trail	References all objects

Billing Intervals

Interval	Description	Example
`day`	Daily billing	Every day, every 3 days
`week`	Weekly billing	Every week, every 2 weeks
`month`	Monthly billing	Every month, quarterly
`year`	Yearly billing	Every year, every 2 years

Supported Currencies

Code	Currency	Minor Unit
`USD`	US Dollar	Cents (100)
`EUR`	Euro	Cents (100)
`GBP`	British Pound	Pence (100)
`CAD`	Canadian Dollar	Cents (100)
`AUD`	Australian Dollar	Cents (100)

User Roles

Role	Description	Permissions
`owner`	Account owner	Full access, billing, team management
`admin`	Administrator	Full access except billing
`member`	Team member	Read/write customers, products, invoices
`viewer`	Read-only	View-only access to all data