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 - Update Subscription Item

<UpdateSubscriptionItemRequest xmlns="http://api.cleverbridge.com/datacontract">
  <SubscriptionId>S18577447</SubscriptionId>
  <RunningNumber>1</RunningNumber>
  <ProductId>97771</ProductId>
  <Quantity>1</Quantity>
  <AlignmentSettings>
    <AlignToCurrentInterval>false</AlignToCurrentInterval>
    <GetCustomerPricePreviewOnly>true</GetCustomerPricePreviewOnly>
  </AlignmentSettings>
  <UpdateAction>Update</UpdateAction>
  <ProductName>Internet Security Basic Extended</ProductName>
  <ProductNameEn>For your home</ProductNameEn>
  <ProductNameExtension>Internet Security Basic Extended</ProductNameExtension>
  <Couponcode>BD3-1KK-UN3</Couponcode>
  <RecommendationsetId>14665</RecommendationsetId>
  <GenerateMail>true</GenerateMail>
  <CustomerPrice>
    <CurrencyId>EUR</CurrencyId>
    <IsGross>true</IsGross>
    <Value>9.99</Value>
  </CustomerPrice>
  <TriggerImmediateRenewal>false</TriggerImmediateRenewal>
</UpdateSubscriptionItemRequest>
<?xml version="1.0"?>
<UpdateSubscriptionItemResponse xmlns="http://api.cleverbridge.com/datacontract">
  <ResultMessage>OK</ResultMessage>
  <AlignmentCustomerGrossPrice>0</AlignmentCustomerGrossPrice>
  <AlignmentCustomerVatPrice>0</AlignmentCustomerVatPrice>
  <AlignmentCustomerNetPrice>0</AlignmentCustomerNetPrice>
  <NextBillingCustomerGrossPrice>9.99</NextBillingCustomerGrossPrice>
  <NextBillingCustomerVatPrice>1.6</NextBillingCustomerVatPrice>
  <NextBillingCustomerNetPrice>8.39</NextBillingCustomerNetPrice>
  <PriceCurrencyId>EUR</PriceCurrencyId>
  <NextBillingDate>0001-01-01T00:00:00</NextBillingDate>
</UpdateSubscriptionItemResponse>
<?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="UpdateSubscriptionItemRequest" nillable="true" type="tns:UpdateSubscriptionItemRequest" />
   <xs:complexType name="UpdateSubscriptionItemRequest">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="SubscriptionId" type="xs:string" />
         <xs:element minOccurs="1" maxOccurs="1" name="RunningNumber" type="xs:int" />
         <xs:element minOccurs="1" maxOccurs="1" name="ProductId" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="Quantity" type="xs:int" />
         <xs:element minOccurs="0" maxOccurs="1" name="AlignmentSettings" type="tns:SubscriptionAlignmentSettings" />
         <xs:element minOccurs="1" maxOccurs="1" name="UpdateAction" type="tns:UpdateSubscriptionItemAction" />
         <xs:element minOccurs="0" maxOccurs="1" name="ProductName" type="xs:string" />
         <xs:element minOccurs="0" maxOccurs="1" name="ProductNameEn" type="xs:string" />
         <xs:element minOccurs="0" maxOccurs="1" name="ProductNameExtension" type="xs:string" />
         <xs:element minOccurs="0" maxOccurs="1" name="Couponcode" type="xs:string" />
         <xs:element minOccurs="1" maxOccurs="1" name="RecommendationsetId" type="xs:int" />
         <xs:element minOccurs="1" maxOccurs="1" name="GenerateMail" type="xs:boolean" />
         <xs:element minOccurs="0" maxOccurs="1" name="CustomerPrice" type="tns:CustomerPrice" />
         <xs:element minOccurs="1" maxOccurs="1" name="TriggerImmediateRenewal" type="xs:boolean" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="SubscriptionAlignmentSettings">
      <xs:sequence>
         <xs:element minOccurs="1" maxOccurs="1" name="AlignToCurrentInterval" type="xs:boolean" />
         <xs:element minOccurs="1" maxOccurs="1" name="GetCustomerPricePreviewOnly" type="xs:boolean" />
      </xs:sequence>
   </xs:complexType>
   <xs:simpleType name="UpdateSubscriptionItemAction">
      <xs:restriction base="xs:string">
         <xs:enumeration value="Update" />
         <xs:enumeration value="Upgrade" />
         <xs:enumeration value="Downgrade" />
      </xs:restriction>
   </xs:simpleType>
   <xs:complexType name="CustomerPrice">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="CurrencyId" type="xs:string" />
         <xs:element minOccurs="1" maxOccurs="1" name="IsGross" type="xs:boolean" />
         <xs:element minOccurs="1" maxOccurs="1" name="Value" type="xs:decimal" />
      </xs:sequence>
   </xs:complexType>
</xs:schema>
<?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="UpdateSubscriptionItemResponse" nillable="true" type="tns:UpdateSubscriptionItemResponse" />
   <xs:complexType name="UpdateSubscriptionItemResponse">
      <xs:complexContent mixed="false">
         <xs:extension base="tns:AlignmentSubscriptionResponseBase">
            <xs:sequence>
               <xs:element minOccurs="1" maxOccurs="1" name="NextBillingDate" type="xs:dateTime" />
               <xs:element minOccurs="0" maxOccurs="1" name="TransactionStatus" type="xs:string" />
               <xs:element minOccurs="0" maxOccurs="1" name="ContinueUrl" type="xs:string" />
            </xs:sequence>
         </xs:extension>
      </xs:complexContent>
   </xs:complexType>
   <xs:complexType name="AlignmentSubscriptionResponseBase">
      <xs:complexContent mixed="false">
         <xs:extension base="tns:SubscriptionResponseBase">
            <xs:sequence>
               <xs:element minOccurs="1" maxOccurs="1" name="AlignmentCustomerGrossPrice" type="xs:decimal" />
               <xs:element minOccurs="1" maxOccurs="1" name="AlignmentCustomerVatPrice" type="xs:decimal" />
               <xs:element minOccurs="1" maxOccurs="1" name="AlignmentCustomerNetPrice" type="xs:decimal" />
               <xs:element minOccurs="1" maxOccurs="1" name="NextBillingCustomerGrossPrice" type="xs:decimal" />
               <xs:element minOccurs="1" maxOccurs="1" name="NextBillingCustomerVatPrice" type="xs:decimal" />
               <xs:element minOccurs="1" maxOccurs="1" name="NextBillingCustomerNetPrice" type="xs:decimal" />
               <xs:element minOccurs="0" maxOccurs="1" name="PriceCurrencyId" type="xs:string" />
            </xs:sequence>
         </xs:extension>
      </xs:complexContent>
   </xs:complexType>
   <xs:complexType name="SubscriptionResponseBase">
      <xs:complexContent mixed="false">
         <xs:extension base="tns:BaseResponseMessage" />
      </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:schema>