👥 Customers

Manage customer accounts, onboarding, and subscription relationships.

The Customers endpoints allow you to manage your customer base and their subscription relationships.
You can onboard new customers, update their information, check customer existence, and view their subscription history.

This section covers:

  • Checking if customers exist by email
  • Onboarding new customers with Stripe integration
  • Retrieving customer lists with optional subscription data
  • Getting individual customer details
  • Updating customer information

Available Endpoints

MethodEndpointDescription
GET/public/customers/checkCheck if customer exists by email
POST/public/customers/onboardOnboard new customer with Stripe account
GET/public/customersGet paginated list of customers
GET/public/customers/:idGet customer details by ID
PUT/public/customers/:idUpdate customer information
📘

Pro tip

The onboard endpoint is idempotent - if a customer with the same email already exists, it will return the existing customer instead of creating a duplicate.

📘

API Refs