Skip to main content
These guides each take one integration task — accepting a payment, opening the customer portal, creating a subscription, metering usage, selling credits, receiving webhooks — from zero to a working implementation. Each one names the endpoints involved, shows the request and response shapes, and links to the concept and reference pages behind them. If you want the whole quote-to-revenue picture first, read How Alguna works; if you want the API basics in one place, start with the Developer quick start.

Guides

Integrate from code

SDKs and CLI

Pick a client, install it, connect, and make a first call in TypeScript, Python, Go, Rust or the terminal.

MCP server

Let an AI assistant do the same work in plain language, under your permissions.

Payment and checkout

Hosted checkout

Take a card or bank payment on a hosted page and create the subscription.

Customer portal

Let customers see invoices, update payment methods and manage their plan.

Subscriptions

Create your first subscription

Customer → product → subscription → activation.

Subscription lifecycle

Upgrades, downgrades, renewals and cancellations.

Usage-based billing

Usage metering

Define a metric, price it, and send usage events.

Credits and prepaid

Prepaid credits, wallets and real-time consumption.

Events and self-serve

Webhooks

Receive notifications for billing events.

Launch self-serve

Trials, credits, checkout and portal in one flow.

Before you start

Get an API key

  1. Sign in to the dashboard — or sandbox while you build
  2. Go to Settings → Connections → Developers → API keys
  3. Create a key and keep it server-side

Base URLs

Authentication and versioning

Send the key as a Bearer token and pin the API version on every request:
Bodies are snake_case JSON; webhook payloads are camelCase. Details in the API overview.

Common integration patterns

Pattern 1: Checkout → subscription → invoice

The usual self-serve flow:

Pattern 2: API-first subscription

When your application already knows the customer and plan — sales-led deals, or self-serve with a stored payment method:

Pattern 3: Usage-based billing


Need help?

API reference

Every endpoint, generated from the OpenAPI spec.

Support

Include the X-Request-Id of any failed request.