Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The getUsageOfSubscription operation retrieves the details usage of all campaignsthe subscription .

Code Block
languagexml
titlegetUsageOfSubscription
<killbill.getUsageOfSubscription>
    <subscriptionId>{$ctx:subscriptionId}</subscriptionId>
    <startDate>{$ctx:startDate}</startDate>
    <endDate>{$ctx:endDate}</endDate>
</killbill.getUsageOfSubscription>
Properties
  • subscriptionId: The id of the subscription.
  • startDate: The start date of the usage period.
  • endDate: The end date of the usage period.

...

Code Block
languagexml
titleSample Request for getUsageOfSubscription
{
    "apiUrl":"http://127.0.0.1:8080",
    "apiVersion":"1.0",
    "username":"admin",
    "password":"password",
    "apiKey":"bob",
    "apiSecret":"lazar",
    "subscriptionId": "15832fd4-4565-40a4-9e55-6e01f28df98b",
    "startDate": "2016-11-11",
    "endDate": "2016-11-21"
}
Related

...

Kill Bill documentation

http://killbill.io/api/#!/usages/getAllUsage

...

Following is a sample proxy service that illustrates how to connect to Kill bill with the init operation and use the getUsageOfSubscription  operation. The sample request for this proxy can be found in the  getUsageOfSubscription  sample request.

Code Block
languagexml
titleSample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse" name="getUsageOfSubscription" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
   <target>
      <inSequence>
         <property name="apiUrl" expression="//apiUrl" json-eval($.apiUrl)"/>
         <property name="emailusername" expression="//email" json-eval($.username)"/>
         <property name="password" expression="//password" json-eval($.password)"/>
         <property name="userKeyapiKey" expression="//userKey" json-eval($.apiKey)"/>
         <property name="apiVersion" expression="//apiVersion" json-eval($.apiVersion)"/>
         <property name="createdAfterapiSecret" expression="//createdAfter" json-eval($.apiSecret)"/>
         <property name="createdAfterblocking" expression="//createdAfter" json-eval($.blocking)"/>
         <property name="createdBeforesubscriptionId" expression="//createdBefore" json-eval($.subscriptionId)"/>
         <property name="idGreaterThanstartDate" expression="//idGreaterThan" json-eval($.startDate)"/>
         <property name="idLessThanendDate" expression="//idLessThan" json-eval($.endDate)"/>
         <property name="updatedAfter" expression="//updatedAfter" />
         <property name="updatedBefore" expression="//updatedBefore" />
         <property name="name" expression="//name" />
         <property name="limit" expression="//limit" />
         <property name="offset" expression="//offset" />
         <property name="sortBy" expression="//sortBy" />
         <property name="sortOrder" expression="//sortOrder" />
         <pardot<killbill.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <email><username>{$ctx:emailusername}</email>username>
            <password>{$ctx:password}</password>
            <userKey><apiKey>{$ctx:userKeyapiKey}</userKey>apiKey>
            <apiVersion><apiSecret>{$ctx:apiVersionapiSecret}</apiVersion>apiSecret>
         </pardot.init>          <pardot.getUsageOfSubscription>
            <createdAfter><apiVersion>{$ctx:createdAfterapiVersion}</createdAfter>apiVersion>
            <createdBefore><blocking>{$ctx:createdBeforeblocking}</createdBefore>
            <idGreaterThan>{$ctx:idGreaterThan}</idGreaterThan>
  blocking>
         <idLessThan>{$ctx:idLessThan}</idLessThan>killbill.init>
   		 <killbill.getUsageOfSubscription>
        <updatedAfter>{$ctx:updatedAfter}</updatedAfter>             <updatedBefore><subscriptionId>{$ctx:updatedBeforesubscriptionId}</updatedBefore>subscriptionId>
            <name>{$ctx:name}</name>
            <limit> <startDate>{$ctx:limitstartDate}</limit>
startDate>
           <offset>{$ctx:offset}</offset>
            <sortBy>  <endDate>{$ctx:sortByendDate}</sortBy>endDate>
            <sortOrder>{$ctx:sortOrder}</sortOrder>
         </pardot</killbill.getUsageOfSubscription>
         <respond />
      </inSequence>
      <outSequence>
         <send />
      </outSequence>
   </target>
   <description />
</proxy>