Turn Off Automatic Renewal

The following contains relevant information about this use case:

๐Ÿ“˜

Note

This use case uses different API endpoints depending on the Subscription Management version you're using. If you are unsure which version you are on, contact Client Experience.

๐Ÿšง

Important

For more information about managing subscriptions, see Subscription Management 1.0 and 2.0.

Preconditions and Considerations

  1. Each subscription item must have the status Active.
  2. If all items in a subscription are deactivated, the status of the entire subscription automatically changes to deactivated.
  1. Subscription products have an Automatic renewal type by default.
  2. When customers sign up for a subscription, they must confirm that they will be automatically billed in regular intervals by selecting a check box. This results in a subscription with an Automatic renewal type.
  3. When a customer does not confirm automatic renewal, but still signs up, the subscription has a Manual renewal type. For more information, see About Subscription Billing Intervals.

Description

You company offers a subscription product, Extreme Sports Training Portal, that includes real-time tracking of customer fitness training activities using the customer's smartwatch.

  1. On June 2nd, a customer of the product gets injured and must withdraw from sporting activities for three months. Intending to cancel the subscription, the customer logs into the portal and clicks a link to access the subscription information. The portal uses the Get Subscription API endpoint to retrieve the subscription details from the Cleverbridge platform.
  2. The portal offers the customer the option to turn off automatic renewal of the subscription, which does the following:
  • Prevents the customer's fitness tracking data from being deleted
  • Changes the status of the customer's subscription to Deactivated
  • Stops billing until automatic renewal is reactivated
  1. The customer clicks the button to turn off automatic renewal of the subscription. This triggers the portal to use:
  • the Deactivate Subscription Items API endpoint, if you're using Subscription Management 1.0 , to update the subscription in the Cleverbridge platform, deactivating it.
  • the Update Subscription Renewal Type API endpoint, if you're using Subscription Management 2.0, to update the subscription in the Cleverbridge platform, changing its renewal type to Manual.

๐Ÿšง

Important

If the customer's subscription contains more than one subscription item (multi-item subscription), you must offer a "turn off automatic renewal" option for every subscription item. Customers can then decide for which subscription items they want to turn off automatic renewal: one item, several items, or all items.

To turn off the automatic renewal of a subscription while on Subscription Management 1.0, set the parameters in the Deactivate Subscription Items API call for to the values listed in the table.

ParameterSet to Value
RunningNumbers1 (This subscription has only one item.)
SubscriptionIdThe unique identifier of the subscription.

Turn On Automatic Renewal (Subscription Management 1.0)

๐Ÿ‘

Tip

To turn on automatic renewal of a subscription while on Subscription Management 1.0, set the parameters in the Reinstate Subscription Items API call to the values listed in the table.

ParameterSet to Value
SubscriptionIdThe unique identifier of the subscription.
RunningNumbers1 (This subscription has only one item.)

To turn off the automatic renewal of a subscription while on Subscription Management 2.0, set the parameters in the Update Subscription Renewal Type API call for the values listed in the table.

ParameterSet to Value
SubscriptionIdThe unique identifier of the subscription.
RenewalTypeManual

Turn On Manual Renewal (Subscription Management 2.0)

๐Ÿ‘

Tip

To turn on manual renewal of a subscription while on Subscription Management 2.0, set the parameters in the Update Subscription Renewal Type API call for to the values listed in the table.

ParameterSet to Value
SubscriptionIdThe unique identifier of the subscription.
RenewalTypeAutomatic

Illustration

Subscription Management 1.0

Subscription Management 2.0