BizKitHub
DocsAPI ReferenceSubscription/api/v1/subscription/cancel
postSubscriptionPublic API v1

/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 · 2 body

3 total
Query · 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

Body · 2
identityIdstringRequired

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

subscriptionIdstringRequired

Request

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"
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key