Overview

This call creates a new bolt-on add-on subscription.

Create a Bolt-on Add-On Subscription

 To create a new bolt-on add-on subscription:

  1. Create a addBoltOnAddOnSubscription request
  2. Specify the login token that was returned in the authentication step.
  3. Specify the existing service bolt-on subscription id, against which, the add-on subscription needs to be created
  4. Specify the bolt-on add-on plan id which needs to be subscribed against the existing service bolt-on subscription

WSDL

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

Operation name

Services/addBoltOnAddOnSubscription



Business Rules

  • The bolt-on subscription must exist.
  • The bolt-on subscription id must belong to a service subscription that is owned by the caller account.
  • Bolt-on add-on plan id must exist in the database.
  • Bolt-on add-on plan id must be flagged as saleable via the API.
  • Bolt-on add-on plan id must be owned by the parent of the caller account.
  • If the bolt-on add-on plan does not allow concurrent preactive subscriptions, there must be no preactive add-on subscription against the bolt-on.




SOAP Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:userapi">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:addBoltOnAddOnSubscription>
         <urn:loginToken>?</urn:loginToken>
         <urn:service_bolt_on_subscription_id>?</urn:service_bolt_on_subscription_id>
         <urn:plan_bolt_on_add_on_id>?</urn:plan_bolt_on_add_on_id>
      </urn:addBoltOnAddOnSubscription>
   </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_bolt_on_subscription_id
The current bolt-on subscription ID.YesInt22

a valid bolt-on subscription id

plan_bolt_on_add_on_id
The Bolt-on Add-On Plan ID.YesInt22a saleable or active bolt-on add-on plan id.
loginToken
The authentication token as it was returned by the Authentication/login API call.YesString64a valid session token.