Documentation

Atomically acquire a named resource and assess its current UTC service day.

Create a Polar checkout link for product purchase. Returns a checkout URL where users can complete payment. Supports monthly, yearly, and one-time (lifetime) billing cycles. For credits products with custom pricing ("Pay What You Want"), pass custom_amount to pre-fill the amount. The checkout link includes user email pre-fill and custom metadata for tracking.

Create a Polar customer portal link for the signed-in user's paid plan, where they can upgrade, downgrade, switch billing cycle or cancel. Returns { available: false } for gift or credits-only accounts.

Get all available products for a specific project (SaaS). Returns product listings with pricing details for monthly, yearly, and one-time purchases.

Get the authenticated user's active subscription for a specific project. Returns subscription status, billing cycle, and product details.

List active resource holdings owned by the authenticated payer.

Project every held resource against the contract active at a timestamp; use for cancellation and renewal previews.

Quote plan coverage and credit-funded overflow without changing state.

Release a named resource; future daily billing stops and the product resource is not deleted.

Deduct credits from the authenticated user's balance for feature usage. Validates sufficient balance before deduction. Automatically calculates balance_after and sets transaction_type to 'usage'. Supports reference_type and reference_id for linking to external records.

Get the authenticated user's credit transaction history with pagination. Can optionally filter by project_id to show only transactions for a specific SaaS. Returns all credit transactions including purchases, usage, refunds, bonuses, and admin adjustments. Shows which project consumed credits and when.

Get the authenticated user's current credit balance. Credits are shared across all LOTS products and never expire.