Skip to main content
Submit a request Service Status

How to transfer a subscription to another distributor

Ari Flavell
  • Updated

Summary

To transfer a subscription using the API, you must send an InitiateTransfer request, then the receiving distributor must send a ClaimTransfer request using a Transfer Token generated at initiation. 

Process

Step 1: Current distributor must initiate transfer

For the current distributor:

    1. Construct an API call using the following information:

      Method POST
      URL https://cloudapi.exclaimer.com
      Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided
      Version 1.0
      Resource subscriptions

       

    2. Construct your request by adding your subscription ID. For help locating your subscription ID, see How to locate your subscription ID in the Exclaimer portal.

    3. Enter transfer.

    4. Copy the string value generated after TransferToken. This will be required during the ClaimSubscription request.
Step 2: New distributor must claim transfer

For the receiving distributor:

    1. Construct an API call using the following information:

      Method POST
      URL https://cloudapi.exclaimer.com
      Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided
      Version 1.0
      Resource subscriptions

       

    2. Construct your request by entering transfer, then claim.

    3. Construct the body of the request using the following information:

      EITHER

      EndUser

      OR

      EndUserID

      EITHER

      A custom user record

      OR

      An existing user record

      EITHER

      Reseller

      OR

      ResellerID

      EITHER
      A custom reseller record

      OR

      An existing reseller record
      SubscriptionID

      The subscription ID. For help locating a subscription ID, see How to locate your subscription ID in the Exclaimer portal.
      TransferToken

      The string value given at the InitiateTransfer request.

       

      NOTE: A TransferToken value can only be used for one valid request. The value will remain usable if a request is invalid.

      A valid request will return either the Subscription ID used in the body, or a generated subscription ID if an identical ID exists or an ID was not specified.
Responses

The SUCCESS response is:

  • 200 Success

The FAILURE responses are:

  • 400 Bad Request / Missing Field
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 415 Unsupported Media Type
  • 500 Internal Server Error
NOTE: For JSON and cURL examples, see the Initiate Subscription Transfer and Claim Subscription Transfer data.