Subscriptions overview
Bill customers on a schedule with a subscription and a payment link.
A subscription is a billing schedule: how often to charge (weekly, monthly or annually), how many intervals between charges, and when to start and stop. On its own it charges nobody. Customers sign up by paying a payment link that the subscription is attached to; each customer who does becomes a subscriber, and Mamo charges their saved card on every billing date.
How it fits together
- Create the schedule with Create Subscription.
- Attach it to a payment link by passing its identifier as
subscription_idto Create Payment Link, withlink_typeset toinline. - The customer pays the link. That first payment signs them up and saves their card.
- Mamo charges them on schedule. You get a
subscription.succeededorsubscription.failedwebhook for every renewal.
Managing subscriptions
| You want to | Use |
|---|---|
| See who's subscribed | Fetch Subscribers |
| See every renewal payment | Fetch Subscription Payments |
| Move a subscriber to another plan | Change Customer Subscription |
| Stop billing one customer | Unsubscribe subscription |
| Retire the whole plan | Cancel Subscription |
Unsubscribe vs. cancelUnsubscribing stops billing for one subscriber. Cancelling deletes the subscription itself, so no one can sign up to it again.
The Subscription Object page describes the subscription webhook payload field by field.
Try it
Follow the Bill a customer every month recipe in the sandbox.
Updated about 3 hours ago
Did this page help you?