SOAP API - GetUserPackageAttributeAdditionalBillingItem

GetUserPackageAttributeAdditionalBillingItem( userPackageId ) : UserPackageAttributeAdditionalBillingItem []

Since: EngageIP v25.2

Returns a list of additional billing items for the user package

This method returns an array of UserPackageAttributeAdditionalBillingItem objects which have the following properties:

ID (Integer) - The unique ID for the additonal billing item
UserPackageID (Integer) - The unique ID for the user package
ServiceID (Integer) - The service to be used for billing
Amount (Double) - The amount to charge for this additional
Frequency (Integer) - Numeric portion of billing frequency, for example every 3 months
BaseTimeUnitTypeID(Integer) - The ID that references the time measurement unit of billing frequency, for example every 3 months
NextBillDate (DateTime) - The date/time for the next billing cycle
NonRefundable(Boolean) - Indicates if the additional billing item transaction is refundable

Parameters:

userPackageId (Integer) - The ID of the user package to get the additional billing item details for

Returns:

An array of UserPackageAttributeAdditionalBillingItem objects

Possible Exceptions:

INVALID USER 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: localhost
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>
    <GetUserPackageAttributeAdditionalBillingItem xmlns="Logisense_EngageIP">
      <userPackageId>int</userPackageId>
    </GetUserPackageAttributeAdditionalBillingItem>
  </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>
    <GetUserPackageAttributeAdditionalBillingItemResponse xmlns="Logisense_EngageIP">
      <GetUserPackageAttributeAdditionalBillingItemResult>
        <UserPackageAttributeAdditionalBillingItem>
          <Validate />
          <ID>int</ID>
          <UserPackageID>int</UserPackageID>
          <ServiceID>int</ServiceID>
          <Amount>double</Amount>
          <Frequency>int</Frequency>
          <BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
          <NextBillDate>dateTime</NextBillDate>
          <NonRefundable>boolean</NonRefundable>
        </UserPackageAttributeAdditionalBillingItem>
        <UserPackageAttributeAdditionalBillingItem>
          <Validate />
          <ID>int</ID>
          <UserPackageID>int</UserPackageID>
          <ServiceID>int</ServiceID>
          <Amount>double</Amount>
          <Frequency>int</Frequency>
          <BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
          <NextBillDate>dateTime</NextBillDate>
          <NonRefundable>boolean</NonRefundable>
        </UserPackageAttributeAdditionalBillingItem>
      </GetUserPackageAttributeAdditionalBillingItemResult>
    </GetUserPackageAttributeAdditionalBillingItemResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.2
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: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetUserPackageAttributeAdditionalBillingItem"

<?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>
    <GetUserPackageAttributeAdditionalBillingItem xmlns="Logisense_EngageIP">
      <userPackageId>int</userPackageId>
    </GetUserPackageAttributeAdditionalBillingItem>
  </soap:Body>
</soap:Envelope>