API Reference

Create a payment. Routes through configured gateways based on your routing rules.

Retrieve a single payment by ID.

Return a paginated list of payments. Supports search, status, page, pageSize, sortField, and sortDirection query params.

Update payment metadata or description.

Issue a full or partial refund on a succeeded payment.

Create a new checkout session. Returns the session object including the hosted checkout URL.

Return a list of checkout sessions. Filter by status (open, complete, expired) or mode query parameters.

Retrieve a single checkout session by ID. Requires authentication.

Public endpoint for the hosted checkout page. Returns session data without requiring authentication. Used by the checkout UI.

Process payment for a checkout session. Called by the hosted checkout form. This is a public endpoint.

Create a new customer record.

Retrieve a single customer by ID.

Return a paginated list of customers ordered by creation date descending.

Update writable fields on an existing customer. Only provided fields are changed (partial update).

Create a new subscription for a customer against a recurring price. The subscription's first billing period is computed from the price interval. Dispatches subscription.created webhook on success.

Return a paginated list of subscriptions. Filter by customerId or status query parameter.

Retrieve a single subscription including period dates and plan details.

Update a subscription's plan, billing anchor, or metadata. Plan changes are prorated by default.

Pause a subscription. Billing stops immediately and only resumes when explicitly resumed via the resume endpoint.

Resume a paused subscription. Billing restarts from the current date.

Cancel a subscription immediately or at the end of the current billing period.

Preview the proration charges that would be applied if a plan change were committed. Does not mutate the subscription.

Force a retry of the most recent failed invoice payment for a past_due subscription. Returns a checkout session the customer can use to update the payment method and complete payment.

Return all invoices associated with a subscription, ordered by creation date descending.

Return all payments associated with a subscription's invoices, ordered by creation date descending.

Return the raw gateway transactions for a subscription, useful for reconciliation against your gateway dashboard.

Create a new invoice with one or more line items. Created in draft status.

Retrieve a single invoice including all line items and payment status.

Return a paginated list of invoices. Filter by customerId or status.

Send the invoice to the customer's email. Transitions status from draft to sent.

Manually mark an invoice as paid for out-of-band payments (wire, cash, etc.). No request body required.

Download the invoice as a PDF. Returns a binary stream with Content-Type: application/pdf.

Create a new payment link. Returns the link object with a shareable URL.

Return a paginated list of payment links. Supports search, status, page, pageSize, sortField, and sortDirection query params.

Retrieve a single payment link by ID.

Update a payment link's name, description, or status.

Public endpoint. Resolve a payment link by its URL slug. Returns 410 if the link is inactive.

Process payment for a payment link. Public endpoint — same parameters as checkout session pay.

Register a new webhook endpoint. The signing secret is returned only once — store it securely.

Return all registered webhook endpoints for your account.

Update a webhook endpoint's URL, subscribed events, or description.