Skip to content
ExtensionsStorefronts
extensions / Commerce extension
POST/__runtime/user/subscription/cancel

Cancel Subscription

Cancels a storefront customer's subscription at the next billing cycle and dispatches a commerce subscription-cancelled webhook.

POST

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Permissions

  • Requires an authenticated storefront session.

Headers

NameRequiredTypeDetails
HostYesNot specified
Description: Value used by this operation.
CookieYesNot specified
Description: Value used by this operation.
AuthorizationYesNot specified
Description: Bearer credential used to authenticate the request.

Path Parameters

This operation has no path parameters.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: SubscriptionRefundRequest

FieldRequiredTypeDetails
subscription_idYesinteger
Description: Identifier for subscription.

Response Body

Example 200 response

json
{
  "success": true,
  "message": "string"
}

Errors

401 UNAUTHORIZED

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified