Overview

Retrieve a summary information of any services under a given package subscription for the current period. It includes:

• service ID, service identifiers, the service type.
• period information: the ID, start and end dates.
• included value information.
• information pertaining to any bolt-ons and bolt-on periods.
• information pertaining to any add-ons and add-on periods.
• data usage summary.

Return the Usage Period Summary

 To retrieve a list of service types:

1. Create a GetCurrentUsagePeriodSummary request
2. Specify the package subscription ID
3. Specify the login token that was returned in the authentication step.

Business Rules

• Package subscription id must exist in the database
• Package subscription id must be linked to an account
• Package subscription id must be owned by the caller account
• If the package subscription id contains service subscriptions and there is existing usage against any of these services in the current period, the service and usage data will be returned
• If the package subscription id does not contain service subscriptions or it does but none of these service subscriptions have any usage in the current period, a blank response will be returned

SOAP Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:userapi">
 <soapenv:Header/>
 <soapenv:Body>
 <urn:GetCurrentUsagePeriodSummary>
 <urn:PackageSubscriptionID>2164100</urn:PackageSubscriptionID>
 <urn:loginToken>75d99763a21a30b5b6c97e0b511205affae5f4482a7074c091263a6ba5a8f48e</urn:loginToken>
 </urn:GetCurrentUsagePeriodSummary>
 </soapenv:Body>
</soapenv:Envelope>