Subscription

Block a subscription

post/1.0/kb/subscriptions/{subscriptionId}/block

Request

The document declares no server URL.
Auth
- HTTP basic
- or API key in header X-Killbill-ApiKey
- or API key in header X-Killbill-ApiSecret
TypeScript
https://skmtc.dev/killbill/apis/kill-bill/docs/1.0/kb/subscriptions/:subscriptionId/block/post.ts
A function with typed inputs. Its response is checked against the schema.

subscriptionIdstring uuid required

requestedDatestring date

pluginPropertystring[]

X-Killbill-CreatedBystring required

X-Killbill-Reasonstring

X-Killbill-Commentstring

blockedIdstring uuid

stateNamestring

servicestring

isBlockChangeboolean

isBlockEntitlementboolean

isBlockBillingboolean

effectiveDatestring date-time

type'SUBSCRIPTION' | 'SUBSCRIPTION_BUNDLE' | 'ACCOUNT'

Blocking state created successfully