API Reference

Blog

Github

Community

X-API-KEY

Lotus

Sign Up

GitHub Repo

Tracking product usage is one of the most common operations you'll make in Lotus.
It's used to capture any event that you might want to bill on at any point.

Lotus is a powerful open-core pricing and billing engine that enables SaaS companies to deploy, monitor, and experiment with custom subscriptions and complex models like usage-based pricing.

Why Lotus

Deploy your business's flexible pricing infrastructure with a few quick steps.

Quickstart

Best if you want to keep your data local or want full control and extensibility.

Self-Hosting

👤 Self-Hosting

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Contributing

Creating billable metrics is the first step in setting up your pricing on Lotus.

Create Metrics

Much like many product analytics software, Lotus integrates into your backend and tracks usage events when you recognize them.

Ingesting Usage

Create Plans

Bespoke Plans

With Lotus' plan versioning, you can easily create new versions of your plans, and control the behavior of users who are on older versions of your plans.

Plan Versioning

Create Subscriptions

Invoicing

Managing Entitlements

Alerts

Add-Ons

Credits

Lotus lets you keep the most convenient part of Stripe (processing payments), while also letting you seamlessly transition off the products that are incurring costs you don't even think about.

Stripe

Lotus allows you to leverage the power of Braintree's payment processing technology, while offering a more intuitive and full-featured subscription management platform."

Braintree

Export your invoices and line items to your ERP.

Netsuite

Segment

Sync customers, invoices, and usage data back to Salesforce.

Salesforce

Integrating New Payment Providers

Webhooks

Backtesting

Error Responses

Ping the API to check if the API key is valid.

API Overview

Python Library

Typescript Library

Verify if events with specific idempotency events have been ingested into Lotus' record of events.

Verify Event Ingestion

Create a customer

Get a customer

List customers

Get Feature Access

Get Metric Access

Create a subscription

Cancels a subscription. You can modify the behavior of the cancellation based on the arguments passed to the call.

Cancel a subscription

Cancel auto-renew or change the end date of a subscription.

Update a subscription

Upgrade or downgrade the susbcription's plan.

Switch a subscription's plan

Change the number of prepaid usage units in a subscription.

Change Prepaid Units

Add an addon to a customer's subscription

Attach an Add-On

Cancel an addon in the customer's subscription