Docs API Reference Subscription/api/v1/subscription/cancel

/api/v1/subscription/cancel

Disables auto-renew for a customer subscription. Does NOT end access immediately: subscription stays active until activeToDate, but will not renew on renewalDate (sets autoRenew=false). Throws if subscription is not owned by the customer.

subscriptionpostApiV1SubscriptionCancel

Parameters

1 query · JSON body

Query parameters

· 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json

identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg

subscriptionIdstringRequired

Exampled9DfQL3ZF01t7Ykk

Response schema

1 status code documented

200Success

success"true"Required

Response example

application/json

{
  "success": true
}

Request example

POST /api/v1/subscription/cancel

post

curl -X POST "https://api.bizkithub.com/api/v1/subscription/cancel?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "identityId": "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg",
  "subscriptionId": "d9DfQL3ZF01t7Ykk"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key