Sign in

v1

latestSwagger 2.0Apache License, Version 2.02026-07-1725867524.8 KB
Subscription

Create an entitlement with addOn products

post/1.0/kb/subscriptions/createSubscriptionWithAddOns

Query parameters

entitlementDatestring date
billingDatestring date
migratedboolean
renameKeyIfExistsAndUnusedboolean
callCompletionboolean
callTimeoutSecinteger
pluginPropertystring[]

Headers

X-Killbill-CreatedBystring required
X-Killbill-Reasonstring
X-Killbill-Commentstring

Request body

accountIdstring uuid
bundleIdstring uuid
bundleExternalKeystring
subscriptionIdstring uuid
externalKeystring
startDatestring date
productNamestring required
productCategory'BASE' | 'ADD_ON' | 'STANDALONE'
billingPeriod'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'THIRTY_DAYS' | 'SIXTY_DAYS' | 'NINETY_DAYS' | 'MONTHLY' | 'BIMESTRIAL' | 'QUARTERLY' | 'TRIANNUAL' | 'BIANNUAL' | 'ANNUAL' | 'BIENNIAL' | 'NO_BILLING_PERIOD' required
phaseType'TRIAL' | 'DISCOUNT' | 'FIXEDTERM' | 'EVERGREEN'
priceListstring required
planNamestring required
state'PENDING' | 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'EXPIRED'
sourceType'NATIVE' | 'MIGRATED' | 'TRANSFERRED'
cancelledDatestring date
chargedThroughDatestring date
billingStartDatestring date
billingEndDatestring date
billCycleDayLocalinteger

Response

Subscriptions created successfully

accountIdstring uuid required
bundleIdstring uuid
externalKeystring