15 docs tagged with "Explanation"

Learn about Odus API and its features with usage examples.

Odus Checkout SDK provides two integration paths for accepting payments in your application. Both are part of the @odus/checkout package and share the same backend APIs, 3DS handling, and payment lifecycle — they differ in how much control you have over the UI.

Customers are reusable records in Odus that represent the people or organizations you charge. Each customer holds contact information and serves as the central reference point for payments, subscriptions, and saved payment methods.

The Odus Dashboard is a web interface that allows you to manage your account. Learn how to use the Dashboard to configure your settings. Most dashboard operations can also be performed via the API assuming your Secret API Key has the necessary permissions.

Learn about how payment flows work in Odus and the different participants involved in the process. Your application needs to be ready to handle these flows to ensure a smooth payment experience for your customers.

A cascade is a named configuration that defines which gateway profiles Odus uses to process a payment and in what order. When one gateway fails or is no longer available, Odus automatically routes the payment to the next gateway in the cascade — without any action required from you.

Many Odus API resources support a metadata field that lets you attach custom key-value data to objects. This is useful for storing additional structured information that's relevant to your business logic that is not captured by the standard fields.

Learn how to use Odus in your projects with examples and step-by-step guides.

When a customer has multiple active subscriptions, Odus can charge them in a single payment instead of separate charges per subscription. This reduces transaction fees and simplifies billing statements for your customers.

A payment in Odus carries two separate status fields: status and displayStatus. Understanding the difference between them — and how they relate to the boolean lifecycle flags — helps you build integrations that correctly handle every payment outcome.

This section covers how products and prices work in Odus. A product represents something you sell, and a price defines the billing terms for that product — the amount, the currency, and whether the charge is one-time or recurring. Together, products and prices are the foundation for creating subscriptions.

The Routing section explains how Odus decides which payment gateway to use for each payment.

A subscription in Odus is a recurring billing agreement between a merchant and a customer for a specific product and price. Once created, Odus automatically charges the customer at each renewal date according to the pricing plan's billing schedule — no further action is required from your backend.

Learn about Odus subscriptions and how to manage them using the API.

In Odus, products and prices are the building blocks for billing. Before you can create a subscription or charge a customer, you need at least one product with at least one price attached to it.