This article applies to Contextual Commerce. (Looking for Classic Commerce documentation?)
Active subscription instances purchased by your customers can be modified, canceled or even uncanceled via the Dashboard or via the /subscriptions endpoint of the FastSpring API. This article describes how to manage subscription instances via the Dashboard.
- Accessing Active Subscription Instances
- Modifying an Active Subscription Instance
- Modifying Reminder and Cancellation Settings
- Canceling and Uncanceling Active Subscription Instances
Accessing Active Subscription Instances
To access an active subscription instance, first select the Activity menu in the Dashboard. The Events tab will be selected by default.
Use the Search Orders and Subscriptions field to enter search criteria for the order that created the subscription (or any billing transaction on the subscription). For example, you can search using the customer's last name or email address, or the order reference for an order associated with the subscription. In the search results, click
Then, locate the Items section of the order's detail page and click View Subscription under the specific subscription you want to manage.
The subscription's detail page will load and display a variety of information and options for managing the subscription.
Beta Testing Note
If the subscription has a manual renewal policy - meaning the customer's payment information has not been stored for the subscription - that will be indicated below the billing terms on the subscription's details, as illustrated in the following example:
Modifying an Active Subscription Instance
To modify the products, pricing, quantity, discounts, coupons, or billing dates for an existing subscription, simply click the name of the subscription product. The subscription Edit page will load.
Now, make the desired changes to the subscription. For example, if you want to modify the quantity of the subscription, you can change the Quantity field, and then click.
A subscription edit review page will load, showing you a comparison of the subscription's settings before your edit and after your edit. Items that have changed will be shaded in red in the Subscription Now section and shaded in green in the Subscription After Changes section. To continue the example, notice that changing the Quantity also changes what the Next Billing Amount will be.
Click CONFIRM to confirm the change, or click CANCEL to cancel the changes (not the subscription).
If the edit you have made will result in a new total price, the new price will take effect upon the Next Billing Date. However, upon confirming the edit, you may be given the option to generate a prorated charge for the remainder of the current subscription period.
Note about subscriptions older than six months
If you click PRORATE, FastSpring can automatically generate a refund for the prorated, unused portion of the original subscription payment, and automatically generate a new charge to the customer's payment method for the prorated value of the remaining subscription duration based on the updated total price. However, if the subscription is currently in its free trial period, you will not be to generate prorated refunds and charges since there has not been an actual charge yet.
Clicking PRORATE will display a review page where you can see the breakdown of the prorated refund and the new prorated charge that will be processed. In the example below, the subscription quantity was changed on the same day the subscription order had been placed, so there was $0 to keep for the already-used portion of the subscription, and the result was a complete refund and a new charge at full price.
For more details on prorated adjustments, please see Prorating when Upgrading or Downgrading Subscriptions.
Modifying Reminder and Cancellation Settings
If you need to change the timing of payment reminders, overdue reminders, or subscription cancellation for an existing subscription, you can click any enabled event in the Notification and Cancellation section of the subscription's details to modify that event.
For example, if you wanted to change the Overdue Notification setting for the subscription above so that a total of two notifications would be sent rather than one, you could click anywhere on the Overdue Notification line:
...change the total from 1 to 2:
...and then click SAVE.
Canceling and Uncanceling Subscriptions
Check out our guided walk-through
To cancel a subscription, simply click the CANCEL command.
You will be prompted to select whether the subscription will remain active for the remainder of the current, paid period, or will be deactivated immediately.
Select the desired option and then click CONFIRM.
If you need to uncancel a subscription that has been canceled but has not yet been deactivated, simply click the UN-CANCEL command, and the subscription will be uncanceled (that is, it will resume normal scheduled charges).
Updating Pricing of All Subscription Instances for a Given Product
As an example, suppose you change the price of a subscription product, and you want to charge the new price for all future billings of that subscription product, including for customers who had subscribed prior to the price change.
You would start by using the /orders endpoint to retrieve all orders for a given subscription-based product by product path (e.g. GET /orders?products=product1). In the API response, record the "subscription" ID for each instance. Then, use the /subscriptions endpoint to update each of the subscription IDs with the new price.
Changing an Automatic Renewal Subscription to Manual Renewal
If you need to change a subscription with automatic renewal into a manual renewal subscription, this can be done via the Dashboard, or by POSTing to the /subscriptions endpoint of the FastSpring API with a POST body that includes the subscription ID and "manualRenew":"true".
Via the Dashboard
On the subscription's detail page, click the green Renews automatically badge and select Switch to Renews manually.
A confirmation dialog will remind you that payment details for the subscription will be removed and that this cannot be undone. Click OK to proceed.
The green Renews automatically badge will be replaced by an orange Renews manually badge to confirm that the change has been made.
Via the FastSpring API
Simply POST to the /subscriptions endpoint with a payload such as in the following example: