KwitKwit Docs

Core concepts

Organizations, customers, collection methods, and hosted sessions

llms.txtOrganizations, customers, collection methods, and hosted sessions

Organization

Your company account in Kwit. Team members, billing configuration, payment provider credentials, products, and API keys are all scoped to one organization.

Customer

An end-user of your SaaS product, billed through Kwit. Customers have:

  • Contact and billing details
  • externalId for your own identifier
  • collectionMethod: CHARGE_AUTOMATICALLY or SEND_INVOICE
  • Payment methods (tokenized via zahls when charging automatically)

Product & price

A product defines what you sell: name, active flag, metadata, and pricing (flat, per-unit, tiered, volume) with a billing interval (monthly, yearly, one-time, etc.).

Subscription

Links a customer to a product on a recurring (or scheduled) basis. Statuses include active, past due, canceled, and more. Renewals generate invoices; failed payments enter dunning.

Invoice

Bill for a period or one-off charge. Finalized invoices can include Swiss QR slips. Status tracks draft → open → paid / void / uncollectible.

Checkout session

Short-lived hosted flow (cs_…) where a customer pays for a product. Created via POST /v1/checkout or the SDK’s kwit.checkout.create.

Portal session

Self-service page (ps_…, ~1 hour) for subscription management, invoices, and billing details. Created via POST /v1/portal/sessions.

API keys & webhooks

  • API keys - Server-to-server access to /v1; prefix kwit_live_
  • Webhooks - Kwit notifies your app on lifecycle events (invoice.paid, subscription.canceled, etc.) with HMAC verification via the SDK

Usage billing

Meters define what you measure (API calls, seats, etc.). Usage events are ingested in batch. Meter credits grant prepaid units. Product meter prices attach usage rates to products.

On this page