Go to full article

Overview

This call can be used to create a new bolt-on subscription against an existing service subscription pertaining to the end user account.

Adding a Bolt-on Subscription

To add a bolt-on subscription:

  1. Create a addBoltOnSubscription request
  2. Specify the service subscription id that the bolt-on subscription is for.
  3. Specify the bolt-on plan id.
  4. Specify the login token that was returned in the authentication step.

WSDL

https://userapi.emersion.com/Services.wsdl

Operation name

Services/addBoltOnSubscription



Business Rules

  • The service subscription id must exist in the database
  • The service subscription id must be owned by the caller account
  • The bolt-on plan id must exist in the database
  • The bolt-on plan id must be owned by the parent account of the caller




SOAP Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:userapi">
 <soapenv:Header/>
 <soapenv:Body>
 <urn:addBoltOnSubscription>
 <urn:loginToken>?</urn:loginToken>
 <urn:service_subscription_id>?</urn:service_subscription_id>
 <urn:plan_bolt_on_id>?</urn:plan_bolt_on_id>
 </urn:addBoltOnSubscription>
 </soapenv:Body>
</soapenv: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 
service_subscription_id
The service subscription id where the bolt-on subscription will be added to.YesInt22

a valid service subscription id.

plan_bolt_on_id
The bolt-on plan the customer is subscribing to.YesInt22a saleable or active bolt-on plan id.
loginToken
The authentication token as it was returned by the Authentication/login API call.YesString64a valid session token.