This page introduces the main entities in the Revolv3 API and how they fit together. Use it as a map before you read the detailed guides for each concept.Documentation Index
Fetch the complete documentation index at: https://docs.revolv3.com/llms.txt
Use this file to discover all available pages before exploring further.
Entities at a Glance
| Entity | Role | Learn more |
|---|---|---|
| Merchant | Your Revolv3 account and its settings (processors, defaults, order channels). | Merchant Settings, Order Processing Channels |
| Customer | Optional record for a payer; links payments, subscriptions, and payment methods. | Customer |
| PaymentMethod | Stored payment credentials (card, ACH, etc.) used to charge a customer. | Payment Method Guide, ACH Direct Debit |
| Invoice | Billing document for a charge; holds amount, line items, and state. | Invoice Status, Get Invoices API |
| Attempt | A single try to pay an invoice (e.g. one card charge or one ACH pull). One invoice can have multiple attempts. | Get Invoice Details |
| Subscription | Recurring billing plan; creates invoices on a schedule and optionally links to a customer and payment method. | Create a Subscription, Billing Plans |