The complete Core API reference is generated from Nozle’s OpenAPI contract. Nozle-specific workflow endpoints are documented alongside it.
Typical integration
- Create or update a customer using your application’s stable external identifier.
- Define typed Features and plans in the dashboard or Core API.
- Create a subscription or start a payment-gated checkout.
- Send idempotent usage events from your backend.
- Process signed webhooks and reconcile subscription, invoice, and payment state.
Authentication
Server endpoints require a secret key in the Bearer authorization header:Identifiers
Useexternal_id, external_customer_id, and external_subscription_id for identifiers owned by your application. Treat Nozle-generated UUIDs as opaque values and preserve exact compatibility field names shown in each endpoint schema.
Next steps
- Review API Standards for requests, pagination, errors, and idempotency.
- Start with Customers, Plans, or Usage Events.
- Use the Node.js SDK or Python SDK for typed server integrations.