BizKitHub
DocsAPI ReferenceSubscription/bff/subscription/set-state
postSubscriptionAdmin BFF

/bff/subscription/set-state

Cancel or re-instate a subscription. Cancel disables auto-renew, stops the retry cron on the pending renewal order, and sends the "subscription-cancelled" e-mail to the customer. Re-instate flips auto-renew back on without sending anything. Access is never revoked immediately.

SubscriptionpostBffSubscriptionSet-state

Parameters

JSON body

Request body

application/json
customerIdstringRequired

Contact external ID.

Exampleabc123def456ghij
subscriptionIdstringRequired

Subscription external ID.

Exampled9DfQL3ZF01t7Ykk
state"cancelled" | "active"Required

Response schema

1 status code documented

200Success
success"true"Required
state"cancelled" | "active"Required
alreadyInStatebooleanRequired

Response example

application/json
{
  "success": true,
  "alreadyInState": false
}

Request example

POST /bff/subscription/set-state

post
curl -X POST "https://api.bizkithub.com/bff/subscription/set-state" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "customerId": "abc123def456ghij",
  "subscriptionId": "d9DfQL3ZF01t7Ykk"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key