API Reference | cleverbridge

Want to find out about the assortment of APIs that cleverbridge offers? The cleverbridge API Reference is the place to learn about our API resources, request items, and responses. You can also try out our endpoints using the API explorer.

Get Started    

Additional Examples - Get Subscription

<?xml version="1.0"?>
<GetSubscriptionResponse xmlns="http://api.cleverbridge.com/datacontract">
    <ResultMessage>OK</ResultMessage>
    <Subscription>
        <CustomerCurrencyId>EUR</CustomerCurrencyId>
        <CustomerId>88342916</CustomerId>
        <CustomerReferenceId>UBqMyhGBdujWksmqA1i5MlFWQuya4r0HQ7TOOmcP</CustomerReferenceId>
        <CustomerReferenceNo />
        <EndDate d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
        <GracePeriodDays>2</GracePeriodDays>
        <Id>23419037</Id>
        <IntervalDayCount>0</IntervalDayCount>
        <IntervalMonthCount>12</IntervalMonthCount>
        <Items>
            <SubscriptionItem>
                <DeactivationDate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
                <EndDate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
                <IsCurrent>true</IsCurrent>
                <LastIntervalNo>0</LastIntervalNo>
                <ProductId>97770</ProductId>
                <ProductName>Internet Security Basic</ProductName>
                <ProductNameExtension>Das Basic-Sicherheitspaket für zu Hause</ProductNameExtension>
                <Quantity>1</Quantity>
                <RecurrenceCount d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
                <RunningNo>1</RunningNo>
                <StartDate>2017-11-16T12:47:38.394563</StartDate>
                <Status>Active</Status>
                <SubscriptionId>23419037</SubscriptionId>
                <VersionActiveDate>2017-11-16T12:47:38.394563</VersionActiveDate>
                <SubscriptionPurchaseItems>
                    <SubscriptionPurchaseItem>
                        <PurchaseId>123793651</PurchaseId>
                        <PurchaseItemRunningNo>1</PurchaseItemRunningNo>
                        <SubscriptionIntervalNo>0</SubscriptionIntervalNo>
                    </SubscriptionPurchaseItem>
                </SubscriptionPurchaseItems>
                <Version>1</Version>
              	<Couponcode>BD3-1KK-UN3</Couponcode>
 								<PromotionId>30362</PromotionId>
            </SubscriptionItem>
        </Items>
        <LastIntervalNo>0</LastIntervalNo>
        <NextBillingDate>2018-11-16T12:47:38.394563</NextBillingDate>
        <NextBillingDateReminder>2018-11-14T12:47:38.394563Z</NextBillingDateReminder>
        <RenewalType>Automatic</RenewalType>
        <StartDate>2017-11-16T12:47:38.394563</StartDate>
        <StartIntervalDayCount>0</StartIntervalDayCount>
        <StartIntervalMonthCount>12</StartIntervalMonthCount>
        <Subscriptionstatus>Active</Subscriptionstatus>
    </Subscription>
</GetSubscriptionResponse>
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://api.cleverbridge.com/datacontract" elementFormDefault="qualified" targetNamespace="http://api.cleverbridge.com/datacontract">
   <xs:element name="GetSubscriptionResponse" nillable="true" type="tns:GetSubscriptionResponse" />
   <xs:complexType name="GetSubscriptionResponse">
      <xs:complexContent mixed="false">
         <xs:extension base="tns:BaseResponseMessage">
            <xs:sequence>
               <xs:element minOccurs="0" maxOccurs="1" name="Subscription" type="tns:Subscription" />
            </xs:sequence>
         </xs:extension>
      </xs:complexContent>
   </xs:complexType>
   <xs:complexType name="BaseResponseMessage">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="ResultMessage" type="xs:string" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="Subscription">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="CustomerCurrencyId" type="xs:string" />
         <xs:element minOccurs="1" maxOccurs="1" name="CustomerId" nillable="true" type="xs:long" />
         <xs:element minOccurs="0" maxOccurs="1" name="CustomerReferenceId" type="xs:string" />
         <xs:element minOccurs="0" maxOccurs="1" name="CustomerReferenceNo" type="xs:string" />
         <xs:element minOccurs="1" maxOccurs="1" name="EndDate" nillable="true" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="GracePeriodDays" nillable="true" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="Id" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="IntervalDayCount" nillable="true" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="IntervalMonthCount" nillable="true" type="xs:long" />
         <xs:element minOccurs="0" maxOccurs="1" name="Items" type="tns:ArrayOfSubscriptionItem" />
         <xs:element minOccurs="1" maxOccurs="1" name="LastIntervalNo" nillable="true" type="xs:int" />
         <xs:element minOccurs="1" maxOccurs="1" name="NextBillingDate" nillable="true" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="NextBillingDateReminder" nillable="true" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="StartDate" nillable="true" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="StartIntervalDayCount" nillable="true" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="StartIntervalMonthCount" nillable="true" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="Subscriptionstatus" type="tns:ApiSubscriptionstatus" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="ArrayOfSubscriptionItem">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="unbounded" name="SubscriptionItem" nillable="true" type="tns:SubscriptionItem" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="SubscriptionItem">
      <xs:sequence>
         <xs:element minOccurs="1" maxOccurs="1" name="DeactivationDate" nillable="true" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="EndDate" nillable="true" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="IsCurrent" type="xs:boolean" />
         <xs:element minOccurs="1" maxOccurs="1" name="LastIntervalNo" type="xs:int" />
         <xs:element minOccurs="1" maxOccurs="1" name="ProductId" type="xs:long" />
         <xs:element minOccurs="0" maxOccurs="1" name="ProductName" type="xs:string" />
         <xs:element minOccurs="0" maxOccurs="1" name="ProductNameExtension" type="xs:string" />
         <xs:element minOccurs="1" maxOccurs="1" name="Quantity" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="RecurrenceCount" nillable="true" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="RunningNo" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="StartDate" nillable="true" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="Status" type="tns:ApiSubscriptionitemstatus" />
         <xs:element minOccurs="1" maxOccurs="1" name="SubscriptionId" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="VersionActiveDate" nillable="true" type="xs:dateTime"/>
         <xs:element minOccurs="0" maxOccurs="1" name="SubscriptionPurchaseItems" type="tns:ArrayOfSubscriptionPurchaseItem" />
         <xs:element minOccurs="1" maxOccurs="1" name="Version" type="xs:int" />
         <xs:element minOccurs="0" maxOccurs="1" name="Couponcode" type="xs:string"/>
         <xs:element minOccurs="1" maxOccurs="1" name="PromotionId" nillable="true" type="xs:long"/>
      </xs:sequence>
   </xs:complexType>
   <xs:simpleType name="ApiSubscriptionitemstatus">
      <xs:restriction base="xs:string">
         <xs:enumeration value="Undefined" />
         <xs:enumeration value="Active" />
         <xs:enumeration value="Deactivated" />
         <xs:enumeration value="AwaitingReinstate" />
         <xs:enumeration value="Finished" />
         <xs:enumeration value="Removed" />
      </xs:restriction>
   </xs:simpleType>
   <xs:complexType name="ArrayOfSubscriptionPurchaseItem">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="unbounded" name="SubscriptionPurchaseItem" nillable="true" type="tns:SubscriptionPurchaseItem" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="SubscriptionPurchaseItem">
      <xs:sequence>
         <xs:element minOccurs="1" maxOccurs="1" name="PurchaseId" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="PurchaseItemRunningNo" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="SubscriptionIntervalNo" type="xs:long" />
      </xs:sequence>
   </xs:complexType>
   <xs:simpleType name="ApiSubscriptionstatus">
      <xs:restriction base="xs:string">
         <xs:enumeration value="All" />
         <xs:enumeration value="Active" />
         <xs:enumeration value="AwaitingReinstate" />
         <xs:enumeration value="Deactivated" />
         <xs:enumeration value="Finished" />
         <xs:enumeration value="Grace" />
         <xs:enumeration value="Hold" />
         <xs:enumeration value="New" />
      </xs:restriction>
   </xs:simpleType>
</xs:schema>