SOAP API - AddUserPackageAttributeAdditionalBillingItem

AddUserPackageAttributeAdditionalBillingItem( userPackageID, amount, nextBillDate, serviceName, baseTimeUnitType, frequency ) : void

Since: EngageIP v25.2

The component named ‘Additional Billing Item’ allows a customer account to have a one time or recurring service associated to a package but billing independently of that package in regard to the next bill date and period.

If the associated package is upgraded, the component/additional billing item will follow the upgrade path to the new package and continue to bill.

The additional billing item will bill when the main package bills (if its next bill date is less than or equal to the package next bill date). If the next bill date of the additional billing item is greater than the package next bill date then it will not be billed until EngageIP billing runs and catches the package next bill date.

Parameters:

userPackageId (Integer) - The ID of the package to add an additional billing item. An exception will be thrown if the package ID does not exist.
amount (Double) - The amount to bill.
nextBillDate (DateTime) - Then next bill day for the additional billing item.
serviceName (String) - The service to be used for billing.
baseTimeUnitType (String) - Time measurement unit of billing frequency, for example every 3 months.
frequency (Integer) - Numeric portion of billing frequency, for example every 3 months.

Possible Exceptions:

INVALID PACKAGE ID

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <AddUserPackageAttributeAdditionalBillingItem xmlns="Logisense_EngageIP">
      <userPackageId>int</userPackageId>
      <amount>double</amount>
      <nextBillDate>dateTime</nextBillDate>
      <serviceName>string</serviceName>
      <baseTimeUnitType>string</baseTimeUnitType>
      <frequency>int</frequency>
    </AddUserPackageAttributeAdditionalBillingItem>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddUserPackageAttributeAdditionalBillingItemResponse xmlns="Logisense_EngageIP" />
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/AddUserPackageAttributeAdditionalBillingItem"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <AddUserPackageAttributeAdditionalBillingItem xmlns="Logisense_EngageIP">
      <userPackageId>int</userPackageId>
      <amount>double</amount>
      <nextBillDate>dateTime</nextBillDate>
      <serviceName>string</serviceName>
      <baseTimeUnitType>string</baseTimeUnitType>
      <frequency>int</frequency>
    </AddUserPackageAttributeAdditionalBillingItem>
  </soap:Body>
</soap:Envelope>