Ingram Marketplace API v1.4.6

Ingram.Marketplace.SubscriptionManagement (Ingram Marketplace API v1.4.6) View Source

API calls for all endpoints tagged SubscriptionManagement.

Link to this section Summary

Functions

get_subscription(id, opts \\ [], connection \\ Connection.new())

Get full details of a specific subscription Get extended details of a specific subscription from the platform.

get_subscriptions(opts \\ [], connection \\ Connection.new())

Retrieve a list of subscriptions Get a list of subscriptions belonging to the customers of the reseller that sends the request.

Link to this section Functions

Link to this function

get_subscription(id, opts \\ [], connection \\ Connection.new())

View Source

Specs

get_subscription(String.t(), keyword(), Tesla.Env.client() | nil) ::
  {:ok, Ingram.Marketplace.Model.SubscriptionDetails.t()}
  | {:error, Tesla.Env.t()}

Get full details of a specific subscription Get extended details of a specific subscription from the platform.

Parameters

  • id (String.t): This is the ID of the subscription that must be processed by the request.
  • opts (KeywordList): [optional] Optional parameters
  • connection (Ingram.Marketplace.Connection): Connection to server

    Returns

} on success {:error, info} on failure

Link to this function

get_subscriptions(opts \\ [], connection \\ Connection.new())

View Source

Specs

get_subscriptions(keyword(), Tesla.Env.client() | nil) ::
  {:ok, Ingram.Marketplace.Model.InlineResponse2003.t()}
  | {:error, Tesla.Env.t()}

Retrieve a list of subscriptions Get a list of subscriptions belonging to the customers of the reseller that sends the request.

Parameters

  • opts (KeywordList): [optional] Optional parameters
    • :customer_id (String.t): The ID of the subscription owner.
    • :status (String.t): The Subscription status filter. Available statuses: pending active hold terminated * removed
    • :creation_date_from (Date.t): Find subscriptions that were created after the specified date.
    • :creation_date_to (Date.t): Find subscriptions that were created before the specified date.
    • :offset (integer()): The number of items to skip before starting to collect the result set.
    • :limit (integer()): The number of items to return.
  • connection (Ingram.Marketplace.Connection): Connection to server

    Returns

} on success {:error, info} on failure