ResourcesSubscriptions
Cancel at period end
Schedule a subscription to cancel at the end of the current billing period.
Use this lifecycle endpoint when the customer should keep access until the end of the paid period.
Authorization
bearerAuth storeAuth AuthorizationBearer <token>
Provide your SellApp API key as a bearer token.
In: header
X-STORE<token>
Select the SellApp store for this API request.
In: header
Path Parameters
productSubscription*integer
The productSubscription path parameter.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://sell.app/api/v2/subscriptions/0/actions/cancel-period-end" \ -H "Content-Type: application/json" \ -d '{ "reason": "Customer request" }'{
"data": {
"id": 101,
"product_subscription_id": 55,
"subscription_id": "sub_1QwertyExample",
"action": "pause",
"status": "confirmed",
"provider": "stripe",
"customer_message": null,
"confirmed_at": "2026-07-03T12:00:00.000000Z",
"failed_at": null,
"created_at": "2026-07-03T12:00:00.000000Z",
"updated_at": "2026-07-03T12:00:00.000000Z"
},
"message": "Subscription will be cancelled at the end of the current period."
}{
"message": "Unauthenticated."
}{
"message": "This action is unauthorized."
}{
"message": "Rule not found."
}{
"message": "The given data was invalid.",
"errors": {
"data": [
"The data field is required."
]
}
}