Go to full article


Overview

This call is used to immediately trigger pre-billing process against a preactive service subscription and take access fees.

WSDL

https://api.emersion.com.au/Services.wsdl

Operation name

ProcessPreBillingOnPreactiveServiceSubscription



Business Rules

  • Service subscription must be preactive
  • Service subscription must be owned by caller account
  • Service subscription must be at the bottom tier (i.e. at the end user account level)
  • Pre-billing should not have been already processed against the service
  • Service type, of the service, must support Preactive Billing




SOAP Example


Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ProcessPreBillingOnPreactiveServiceSubscription>
         <urn:ServiceSubscriptionID>100805</urn:ServiceSubscriptionID>
         <!--Optional:-->
         <urn:IncludePackageSubscription>true</urn:IncludePackageSubscription>
      </urn:ProcessPreBillingOnPreactiveServiceSubscription>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns1:ProcessPreBillingOnPreactiveServiceSubscriptionResponse/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information..

NameDescriptionRequired?Field Type

Character

limit

Values
ServiceSubscriptionID
ID of the service subscription, for which, the pre-billing process is being triggeredYesInteger

e.g. 100000

IncludePackageSubscription
If this field is set to true, the pre-billing process will also be run against the related package subscriptionNoBoolean
true, false



Error Handling


Error MessageDescription
Service Subscription ID must be provided

Service Subscription ID must be integer

Service Subscription ID not found
When the ID is not found in Emersion database
Service Subscription is not Preactive

Service Subscription is not the bottom level
subscription against the associated service

Service Subscription is not owned by the 
caller account

Service Subscription is not valid for 
preactive billing
When the related service type does not support Preactive Billing
Pre-Billing has already been processed against the service subscription