Subscription
Cancel an entitlement plan
delete/1.0/kb/subscriptions/{subscriptionId}
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
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
subscriptionIdstring uuid required
Query parameters
requestedDatestring date
callCompletionboolean
callTimeoutSecinteger
entitlementPolicy'IMMEDIATE' | 'END_OF_TERM'
billingPolicy'START_OF_TERM' | 'END_OF_TERM' | 'IMMEDIATE' | 'ILLEGAL'
useRequestedDateForBillingboolean
pluginPropertystring[]
Headers
X-Killbill-CreatedBystring required
X-Killbill-Reasonstring
X-Killbill-Commentstring
Response
Successful operation
Changes
No recorded changes to this operation across all 4 revisions of this API.