delete
https://www.pelcro.com/api/v1/core/subscriptions/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Cancel an active subscription. You can cancel immediately or at the end of the current billing period.
Example: A customer requests to cancel their subscription. Cancel it at the end of the period so they retain access until their paid time expires.
Conditional Requirements
| Condition | Required Fields |
|---|---|
| Always | mode (period_end or now) |
| Optional | reason (cancellation reason, max 255 chars) |
| Gift recipient subscriptions | Cannot be canceled |
| Agency-managed subscriptions | Cannot be canceled |
| Pending payment subscriptions | Cannot be canceled |
Webhooks
Both modes trigger the subscription.canceled webhook event.
Immediate cancellation (mode: now) additionally triggers the subscription.expired webhook event.