Endpoints

The interactive reference at /docs on your API instance is still the best place to inspect schemas. This page summarizes the implemented route surface and auth model.

Publishable key (pk_)

Method	Endpoint	Description
GET	/api/v1/access/check	Evaluate access for a URL and identity
POST	/api/v1/events	Send up to 100 events

Any API key (pk_ or sk_)

Method	Endpoint	Description
POST	/api/v1/auth/customers/register	Register a customer with email and password
POST	/api/v1/auth/customers/login	Log in and receive JWT + refresh token
POST	/api/v1/auth/customers/refresh	Exchange a refresh token for a new token pair
POST	/api/v1/auth/customers/logout	Revoke a refresh token
GET	/api/v1/auth/customers/me	Get customer profile (requires Bearer JWT)
GET	/api/v1/subscriptions/me	Get a customer’s active subscription (JWT or customerId param)
POST	/api/v1/subscriptions/checkout	Create a checkout session (JWT, customerId, or email)
POST	/api/v1/subscriptions/portal	Create a Stripe customer-portal session (JWT or customerId)

Secret key (sk_)

Method	Endpoint	Description
POST	/api/v1/subscriptions/cancel	Mark an active subscription to cancel at period end

Dashboard admin session

Method	Endpoint	Description
GET	/api/v1/products	List products with prices
POST	/api/v1/products	Create a product
PATCH	/api/v1/products/:id	Update a product
DELETE	/api/v1/products/:id	Delete a product
POST	/api/v1/products/:id/prices	Add a price
PATCH	/api/v1/products/:id/prices/:priceId	Update a price
DELETE	/api/v1/products/:id/prices/:priceId	Delete a price
GET	/api/v1/paywalls	List paywall rules
POST	/api/v1/paywalls	Create a paywall rule
PATCH	/api/v1/paywalls/:id	Update a paywall rule
DELETE	/api/v1/paywalls/:id	Delete a paywall rule
GET	/api/v1/customers	List customers
POST	/api/v1/customers	Create a customer
GET	/api/v1/customers/:id	Get a customer
PATCH	/api/v1/customers/:id	Update a customer
DELETE	/api/v1/customers/:id	Delete a customer
POST	/api/v1/customers/:id/subscription	Assign a manual subscription
DELETE	/api/v1/customers/:id/subscription	Remove an active subscription
GET	/api/v1/segments	List segments
POST	/api/v1/segments	Create a segment
PATCH	/api/v1/segments/:id	Update a segment
DELETE	/api/v1/segments/:id	Delete a segment
GET	/api/v1/segments/:id/customers	List matching members
GET	/api/v1/api-keys	List API keys
POST	/api/v1/api-keys	Create an API key pair
DELETE	/api/v1/api-keys/:id	Delete one API key
GET	/api/v1/stats/overview	Overview counters
GET	/api/v1/stripe/status	Stripe connection status
POST	/api/v1/stripe	Save Stripe settings
POST	/api/v1/stripe/sync	Re-sync all products and prices to Stripe
DELETE	/api/v1/stripe	Remove Stripe settings

Other

Method	Endpoint	Description
GET	/health	Health check
POST	/api/v1/webhooks/stripe	Stripe webhook endpoint