KIkillbill
Subscription

Retrieve a subscription by external key

Changed on
get/1.0/kb/subscriptions

Request

Query parameters

externalKeystring required
audit'FULL' | 'MINIMAL' | 'NONE'

Response

successful operation

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

Changes