Pausing and Cancelling Subscriptions
Pausing and cancelling do different things. Pick the one that matches what you actually want.
Freezing (pausing)
A freeze pauses invoice generation for a date range you set, then resumes automatically when that range ends. Use it for a summer break, a suspended service, or any gap where the customer is staying but should not be billed.
Freezes are managed in their own right — you can list, update and delete them — so a scheduled pause can be adjusted or called off before it starts.
Events: SUBSCRIPTION_FROZEN, SUBSCRIPTION_FREEZE_NOW, SUBSCRIPTION_UNFREEZE_NOW, SUBSCRIPTION_UNFREEZE_FUTURE, SUBSCRIPTION_FREEZE_CANCEL.
Cancelling
| Status | What happens on cancel |
|---|---|
ACTIVE |
Scheduled to cancel at the end of the current period. It stays active until then, and the customer keeps what they paid for. |
INACTIVE, TRIALING, TRIAL_PENDING
|
Cancels immediately. |
Pass cancel_related_invoices if you also want ongoing invoices cancelled rather than left outstanding.
A scheduled cancellation emits SUBSCRIPTION_CANCEL_AT_PERIOD_END. If the customer changes their mind before the period ends, the Uncancel endpoint reverses it — and that also works through the API.
What cancelling does not do
- It does not refund past payments. Cancelling stops future charges only. Money back for a cycle already paid is a refund, and it is your decision under your own refund policy.
- It does not remove the customer. Their record, invoices and history stay in your account.
- A refund does not cancel a subscription either. The two are separate — refunding a renewal leaves the subscription running and it will bill again next cycle. If the customer is leaving, do both.
When your customer cancels themselves
Customers can cancel from their Payer Profile or the Customer Portal at any time before the next billing date. Future charges stop immediately and past payments are untouched. Refund requests come to you, not to Stream.
Notifications
Stream notifies your customer when a subscription is cancelled, and again on each renewal. These go out by WhatsApp by default, with SMS and email also available, and you choose which channels are active.
If you want different behaviour — a notification type switched off, or wording of your own — Stream support can override any notification setting on request. See Controlling the Messages Stream Sends Your Customers.
Your customers can sign in directly
A payment link is no longer the only way in. Your customers can go to https://billing.streampay.sa/consumer/auth, enter their mobile number, and confirm the one-time code they receive, which takes them straight to their profile.
This helps when a customer has lost the message, and it lets you put the link — or a QR code pointing at it — on a statement, a poster or a reception desk.