Check out the new features, minor fixes, and updates we've made to our platform and APIsChangelog
Home >

Get Subscription

Purpose

The GetSubscription API endpoint is used to retrieve data for a subscription by using the subscription ID.

Considerations

None

Required Parameter Settings by Use Case

There is only one parameter passed when calling this function, SubscriptionID.

This function is used in the following use cases:

Retrieving the Quantity of Users

The following use cases assume that the current subscription itemA subscription item is component of a subscription with its own set of attributes including price, description and feature set. quantity is being retrieved for display:

To do so:

  1. Call the function as specified above.
  2. In the SubscriptionItem array data returned in the response, locate the single instance in the array for which both of the following statements are true:
    • RunningNumber matches the running number of the subscription item for which the quantity is needed.
    • The IsCurrent parameter is true.
  3. Retrieve the current quantity for the Users subscription item from this instance of the array.