Cancel a customer’s subscription
Say "cancel this customer’s subscription" and it stops renewing at the end of the paid period, with access kept until then.
Cancelling ends a Subscription at the close of its current period: it stops renewing, and the Customer keeps access until then. To stop billing for a while without ending it, pause it.
Needs Charge monthly · Open a bank account
What you get
- 1Subscription that stops renewing at the end of the paid periodSubscription
- 1access kept until that dateEntitlement
- 1Customer record kept, with the reason they gaveCustomer
Your agent does
You, to your agent
Cancel a customer’s subscription.
Cancel Riverside’s plan.
Stop billing this customer.
# Subscription.unsubscribe
curl -X POST https: //api.sb/ leaseline.app/ subscriptions/ subscription_riverside/ unsubscribe \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
-H "Content-Type: application/ json" \
-d '{"reason": "Moving to a property manager with its own software."}'
import { $ } from 'startup-builder'
await $.Subscription.unsubscribe({ subscription: 'subscription_riverside', reason: 'Moving to a property manager with its own software.' })
npx startup-builder do Subscription.unsubscribe --json '{"subscription": "subscription_riverside", "reason": "Moving to a property manager with its own software."}'
{
"name": "do",
"arguments": {
"code": "return await $.Subscription.unsubscribe({ subscription: 'subscription_riverside', reason: 'Moving to a property manager with its own software.' })"
}
}
Change it
- Pause it for a month instead.
- Refund their last invoice too.
- Ask why they are leaving before it ends.
Under the hood
- Systems
- Billing
- Nouns
- Subscription, Customer, Entitlement
- Events
Subscription.unsubscribed- Stripe objects
Subscription