CreddotDocsCreddot Docs

Subscriptions

Recurring billing with plans, renewals, reminders and grace periods.

A subscription is what you sell (for example "Gym membership"); its plans are the prices customers choose from (Basic monthly, Premium yearly). Customers who join are subscribers.

Set up

  1. Create plans with POST /subscription-plans and a subscription with POST /subscriptions (subscriptions:manage), or set them up in the dashboard.
  2. Activate it with POST /subscriptions/{id}/activate.
  3. Share its subscribe link from the dashboard, or add an existing customer with POST /subscriptions/{id}/subscribers. Creddot emails them a link to pay.

Renewals

Before each billing date Creddot emails the subscriber a reminder with a link to pay the next cycle. Customers manage their own plan and can cancel from a private link in their emails.

WebhookMeaning
subscription.activatedThe first payment succeeded; give access
subscription.renewedA renewal was paid; extend access
subscription.overdueThe billing date passed without payment; the grace period started
subscription.lapsedThe grace period ended; remove access
subscription.cancelledThe customer or your team cancelled

The grace period is set per subscription (3 days by default). Read a subscriber's current state with GET /subscriptions/subscribers/{subscriberId}.

On this page