Subscription

Retrieve a subscription by id

get/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
TypeScript
https://skmtc.dev/killbill/apis/kill-bill/docs/1.0/kb/subscriptions/:subscriptionId/get.ts
A function with typed inputs. Its response is checked against the schema.

subscriptionIdstring uuid required

audit'FULL' | 'MINIMAL' | 'NONE'

successful operation

accountIdstring uuid

bundleIdstring uuid

bundleExternalKeystring

subscriptionIdstring uuid

externalKeystring

startDatestring date

productNamestring required

productCategory'BASE' | 'ADD_ON' | 'STANDALONE'

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

No recorded changes to this operation across all 4 revisions of this API.