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

Update Subscription Item Price

Purpose

The UpdateSubscriptionItemPrice API function is used to:

Guidelines for When to Use UpdateSubscriptionItemPrice vs. UpdateSubscriptionItem

It's possible to use either the UpdateSubscriptionItem or the UpdateSubscriptionItemPrice functions if the only subscription item properties to be changed are the price, the quantity, or both. The following guidelines should be kept in mind when making this decision:

  • UpdateSubscriptionItemPrice should be used for new development in which only the subscription item’s price and (optionally) quantity will change.
  • UpdateSubscriptionItem should be used for new development or for modifying existing client code in cases where subscription data in addition to price and (optionally) quantity will be changed.

Considerations

The following are considerations for this function:

  • Changes made by this function, including the price and/or quantity, apply to all future billing events unless changed subsequently.
  • Use of the CustomerPrice parameter in the API response is required. Before doing so, see Understanding Customer Price.
  • Use of the SubscriptionAlignmentSettings parameter in the API response is required. Before doing so, see Alignment Settings.

Required Parameter Settings by Use Case

Certain parameters for use cases that use this function require specific values. Set the values for the parameters as shown in the tables below.


Note

The UpdateAction parameter is currently used for documentation and tracking only. The value set does not affect transaction processing.

The supported values are as follows:

  • For upgrades, set the parameter to upgrade (or 1 for JSON)
  • For downgrades, set the parameter to downgrade, (or 2 for JSON)
  • For all other changes, set the parameter to update (or 0 for JSON)