API/Services/CancelAccountDiscountSubscription

From Emersion
Jump to: navigation, search

Purpose

This method allows the provider to cancel an account discount subscription.

Inputs

 <soapenv:Header/>
  <soapenv:Body>
     <ser:CancelAccountDiscountSubscription>
        <ser:AccountDiscountSubscriptionID>?</ser:AccountDiscountSubscriptionID>
        <ser:DateCancel>?</ser:DateCancel>
     </ser:CancelAccountDiscountSubscription>
  </soapenv:Body>


Important notes:

- AccountDiscountSubscriptionID needs to be the ID of an Account Discount Subscription in the Emersion system

- DateCancel has to be a valid date, it’s an optional field, defaults to now


Example Validation Error:

 <SOAP-ENV:Body>
     <SOAP-ENV:Fault>
        <faultcode>SOAP-ENV:Client</faultcode>
        <faultstring>Validation Error</faultstring>
        <faultactor>http://emersion.com.au/Services</faultactor>
        <detail>Account Discount Subscription specified does not exist in the database!</detail>
     </SOAP-ENV:Fault>
  </SOAP-ENV:Body>


Validation rules:

- Account Discount Subscription Id exists

- Account Discount Subscription Account Owner's parent equals calling Account

- Account Discount Subscription has no end_date and is of status 'active'

- Account Discount Subscription has a start date


Output

  <SOAP-ENV:Body>
     <ns1:CancelAccountDiscountSubscriptionResponse/>
  </SOAP-ENV:Body>

Error String:

- Invalid or Missing Discount Subscription ID

- Account Discount Subscription specified does not exist in the database!

- You do not have permission to modify this Account Discount Subscription!

- This Account Discount Subscription has already been cancelled!