...
Code Block |
---|
language | xml |
---|
title | createSubscription |
---|
|
<killbill.createSubscription>
<accountId>{$ctx:accountId}</accountId>
<externalKey>{$ctx:externalKey}</externalKey>
<bundleId>{$ctx:bundleId}</bundleId>
<subscriptionId>{$ctx:subscriptionId}</subscriptionId>
<startDate>{$ctx:startDate}</startDate>
<productName>{$ctx:productName}</productName>
<productCategory>{$ctx:productCategory}</productCategory>
<billingPeriod>{$ctx:billingPeriod}</billingPeriod>
<phaseType>{$ctx:phaseType}</phaseType>
<priceList>{$ctx:priceList}</priceList>
<sourceType>{$ctx:sourceType}</sourceType>
<cancelledDate>{$ctx:cancelledDate}</cancelledDate>
<chargedThroughDate>{$ctx:chargedThroughDate}</chargedThroughDate>
<billingStartDate>{$ctx:billingStartDate}</billingStartDate>
<state>{$ctx:state}</state>
<billingEndDate>{$ctx:billingEndDate}</billingEndDate>
<events>{$ctx:events}</events>
<priceOverrides>{$ctx:priceOverrides}</priceOverrides>
<requestedDate>{$ctx:requestedDate}</requestedDate>
<callCompletion>{$ctx:callCompletion}</callCompletion>
<callTimeoutSec>{$ctx:callTimeoutSec}</callTimeoutSec>
<pluginProperty>{$ctx:pluginProperty}</pluginProperty>
<auditLogs>{$ctx:auditLogs}</auditLogs>
<createdBy>{$ctx:createdBy}</createdBy>
<reason>{$ctx:reason}</reason>
<comment>{$ctx:comment}</comment>
</killbill.createSubscription> |
Properties
accountId:
The id of the account. externalKey:
The external key for the subscription. bundleId:
The bundle id for the subscription. subscriptionId:
The id for the subscription. startDate:
The start date for the subscription. productName:
The product name for the subscription. productCategory:
The product category for the subscription. billingPeriod:
The billing period for the subscription. phaseType:
The phase type for the subscription. priceList:
The price list for the subscription. sourceType:
The source type for the subscription. cancelledDate:
The cancel date for the subscription. chargedThroughDate:
The charged through date for the subscription. billingStartDate:
The billing start date for the subscription. state:
The state for the subscription. billingEndDate:
The billing end date for the subscription.. events:
The events for the subscription. priceOverrides:
The price overrides for the subscription. requestedDate:
The requested date for the subscription. callCompletion:
The call completion for the subscription call. callTimeoutSec:
The call timeout sec for this subscription call. pluginProperty:
The plugin property for the subscription. auditLogs:
The audit logs for the subscription. createdBy:
The creator of this subscription call. reason:
The reason for the creation of subscription. comment:
The comment for the creation of subscription.
...
Sample request
Following is a sample REST/JSON request that can be handled by the createsubscription
operation.
...
Code Block |
---|
language | xml |
---|
title | updateSubscription |
---|
|
<killbill.updateSubscription>
<accountId>{$ctx:accountId}</accountId>
<externalKey>{$ctx:externalKey}</externalKey>
<bundleId>{$ctx:bundleId}</bundleId>
<subscriptionId>{$ctx:subscriptionId}</subscriptionId>
<startDate>{$ctx:startDate}</startDate>
<productName>{$ctx:productName}</productName>
<productCategory>{$ctx:productCategory}</productCategory>
<billingPeriod>{$ctx:billingPeriod}</billingPeriod>
<phaseType>{$ctx:phaseType}</phaseType>
<priceList>{$ctx:priceList}</priceList>
<sourceType>{$ctx:sourceType}</sourceType>
<cancelledDate>{$ctx:cancelledDate}</cancelledDate>
<chargedThroughDate>{$ctx:chargedThroughDate}</chargedThroughDate>
<billingStartDate>{$ctx:billingStartDate}</billingStartDate>
<state>{$ctx:state}</state>
<billingEndDate>{$ctx:billingEndDate}</billingEndDate>
<events>{$ctx:events}</events>
<priceOverrides>{$ctx:priceOverrides}</priceOverrides>
<requestedDate>{$ctx:requestedDate}</requestedDate>
<callCompletion>{$ctx:callCompletion}</callCompletion>
<callTimeoutSec>{$ctx:callTimeoutSec}</callTimeoutSec>
<pluginProperty>{$ctx:pluginProperty}</pluginProperty>
<auditLogs>{$ctx:auditLogs}</auditLogs>
<createdBy>{$ctx:createdBy}</createdBy>
<reason>{$ctx:reason}</reason>
<comment>{$ctx:comment}</comment>
</killbill.updateSubscription> |
Properties
accountId:
The id of the account. externalKey:
The external key for the subscription. bundleId:
The bundle id for the subscription. subscriptionId:
The id for the subscription. startDate:
The start date for the subscription. productName:
The product name for the subscription. productCategory:
The product category for the subscription. billingPeriod:
The billing period for the subscription. phaseType:
The phase type for the subscription. priceList:
The price list for the subscription. sourceType:
The source type for the subscription. cancelledDate:
The cancel date for the subscription. chargedThroughDate:
The charged through date for the subscription. billingStartDate:
The billing start date for the subscription. state:
The state for the subscription. billingEndDate:
The billing end date for the subscription. events:
The events for the subscription. priceOverrides:
The price overrides for the subscription. requestedDate:
The requested date for the subscription. callCompletion:
The call completion for the subscription call. callTimeoutSec:
The call timeout sec for the subscription call. pluginProperty:
The plugin property for the subscription. auditLogs:
The audit logs for the subscription. createdBy:
The creator of this subscription call. reason:
The reason for updating the subscription. comment:
The comment for the updation of subscription.
Sample request
Following is a sample REST/JSON request that can be handled by the updateSubscription
operation.
...
Code Block |
---|
language | xml |
---|
title | deleteSubscription |
---|
|
<killbill.deleteSubscription>
<subscriptionId>{$ctx:subscriptionId}</subscriptionId>
<requestedDate>{$ctx:requestedDate}</requestedDate>
<callCompletion>{$ctx:callCompletion}</callCompletion>
<callTimeoutSec>{$ctx:callTimeoutSec}</callTimeoutSec>
<pluginProperty>{$ctx:pluginProperty}</pluginProperty>
<createdBy>{$ctx:createdBy}</createdBy>
<reason>{$ctx:reason}</reason>
<comment>{$ctx:comment}</comment>
<entitlementPolicy>{$ctx:entitlementPolicy}</entitlementPolicy>
<billingPolicy>{$ctx:billingPolicy}</billingPolicy>
<useRequestedDateForBilling>{$ctx:useRequestedDateForBilling}</useRequestedDateForBilling>
</killbill.deleteSubscription> |
Properties
subscriptionId:
The id of the subscription. requestedDate:
The ID of the project to which the story belongs. callCompletion:
The call completion of the subscription call. callTimeoutSec:
The call timeout sec of the subscription call. entitlementPolicy:
The entitlement policy of the subscription. billingPolicy:
The billing policy of the subscription. useRequestedDateForBilling:
The use requested date for billing of the subscription. pluginProperty:
The plugin property of the subscription. createdBy:
The creator of this subscription call. reason:
The reason for deleting the subscription. comment:
The comment for the subscription.
...
Sample request
Following is a sample REST/JSON request that can be handled by the deleteSubscription
operation.
...
Code Block |
---|
language | xml |
---|
title | getSubscriptionById |
---|
|
<killbill.getSubscriptionById>
<subscriptionId>{$ctx:subscriptionId}</subscriptionId>
</killbill.getSubscriptionById> |
Properties
subscriptionId:
The id of the subscription.
Sample requestFollowing is a sample REST/JSON request that can be handled by the getSubscriptionById
operation.
...