API ReferenceSubscriptions

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.

PayPal has no cancellation at period end of its own. On a PayPal subscription, this endpoint cancels the subscription with PayPal straight away, so PayPal stops billing, and SellApp keeps the customer's access running until the current period ends. It can't be undone: Keep a subscription is refused afterwards, and the customer has to subscribe again to continue. The capabilities response reports cancel_at_period_end as available on PayPal, and its reasons say it can't be undone. A paused PayPal subscription, or one whose current period has ended before PayPal's renewal is recorded, is refused here: cancel it immediately instead.

POST
/v2/subscriptions/{productSubscription}/actions/cancel-period-end

Authorization

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

productSubscription*integer

The productSubscription path parameter.

Header Parameters

Idempotency-Key?string

A caller-generated key, unique per store and subscription lifecycle request. Sending it here is the same as sending idempotency_key in the body.

Lengthlength <= 128
Idempotency-Key?string

Caller-generated key for safely retrying this operation. The JSON idempotency_key field is also accepted; when both are sent, the header takes precedence.

Lengthlength <= 128
X-STORE?string

Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.

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

application/json

application/json

application/json

curl -X POST "https://sell.app/api/v2/subscriptions/55/actions/cancel-period-end" \  -H "X-STORE: launch-lab" \  -H "Content-Type: application/json" \  -d '{    "reason": "Customer request"  }'
{
  "data": {
    "id": 101,
    "product_subscription_id": 55,
    "subscription_id": "sub_1QwertyExample",
    "action": "cancel_at_period_end",
    "status": "confirmed",
    "provider": "stripe",
    "proration_order_id": null,
    "error": null,
    "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."
}
{
  "type": "invalid_request_error",
  "code": "bad_request",
  "message": "The request could not be understood.",
  "status": 400,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#bad-request"
}
{
  "type": "authentication_error",
  "code": "unauthenticated",
  "message": "Unauthenticated.",
  "status": 401,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}
{
  "type": "authorization_error",
  "code": "forbidden",
  "message": "This action is unauthorized.",
  "status": 403,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#forbidden"
}
{
  "type": "not_found_error",
  "code": "resource_not_found",
  "message": "Not Found.",
  "status": 404,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}
{
  "type": "validation_error",
  "code": "validation_failed",
  "message": "The selected product variant id is invalid.",
  "status": 422,
  "param": "product_variant_id",
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#validation-failed",
  "errors": {
    "product_variant_id": [
      "The selected product variant id is invalid."
    ]
  }
}
{
  "type": "rate_limit_error",
  "code": "rate_limit_exceeded",
  "message": "Too Many Attempts.",
  "status": 429,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}
{
  "type": "api_error",
  "code": "api_error",
  "message": "Server Error",
  "status": 500,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#api-error"
}