Was this article helpful?

How do I amend subscriptions? (Upgrades, downgrades, add-ons)

Overview

In Z-Billing, amendments are used to make changes to an active subscription.

Solution

Use amendments to make subscription changes including adding products, updating products, removing products, upgrades, downgrades, renewals and changing terms and conditions. Amendments can be executed via the UI or API

Add a Product

Use the following steps to add a product to a subscription. These steps must be followed for each product you want to add.

Add a Product via UI

  1. Click on the subscription you want to change.
  2. Click on the Amendment button.                                        amend button.png
  3. Enter in an Amendment Name, Change Description (optional).
  4. Select New Product from the Amendment Type drop down, and click Save.   add_amendment.png                                                                                                         
  5. Click Add New Product & Rate Plan, using the Select Product drop down, choose the product you want to add, and click Select to choose a rate plan. add_product_2.png
  6. Click the Contract effective button, enter a Contract effective Date and click Save.
    • The contract effective date should be set to the date you want the new product to take effect.
    • Most companies make product additions effective immediately during an invoice period.
      • If proration is enabled the next invoice will include a prorated charge for any recurring fees for the partial period and full charges for any usage and one time fees for the partial period.
      • If proration is disabled, the next invoice will only include one time fees for the partial period and will not include and recurring or usage fees for the partial period.
    • If you want to make product additions effective for the next invoice period or next term,  set the contract effective date to the first day of the next invoice period or the first day of the next term.                      
  7. If you have Service Activation and Customer Acceptance dates enabled then click the Service Activation button, enter the Service Activation Date and click Save, then click the Customer Acceptance button, enter the Customer Acceptance Date and click Save.

Add a Product via API

Refer to the API Documentation for Adding a Product and follow the instructions based on your WSDL version. 

The contract effective, effective, service activation and customer acceptance dates should be set to the date you want the new product to take effect.

  • Most companies make product additions effective immediately during an invoice period.
    • If proration is enabled the next invoice will include a prorated charge for any recurring fees for the partial period and full charges for any usage and one time fees for the partial period.
    • If proration is disabled, the next invoice will only include one time fees for the partial period and will not include and recurring or usage fees for the partial period.
  • If you want to make product additions effective for the next invoice period or next term, set the contract effective date to the first day of the next invoice period or the first day of the next term.                 

Update a Product

Use the following steps to update a product on a subscription. These steps must be followed for each product you want to update.

Update a Product via UI

  1. Click on the subscription you want to change.
  2. Click on the Amendment button.                                        amend button.png
  3. Enter in an Amendment Name, Change Description (optional).
  4. Select Update a Product from the Amendment Type drop down, and click Save.                    update_amendment.png                                                                                        
  5. Using the Select Product drop down, choose the product and rate plan you want to update.
  6. In the Original section click on the Charge Name to view current product details.
  7. In the New section click on the Charge Name to view and edit the product details and click Save.         update_amendment_2.png        
  8. Click the Contract effective button, enter a Contract effective Date and click Save.
    • The contract effective date should be set to the date you want the product update to take effect.
    • Most companies make product updates effective immediately during an invoice period.
      • If proration is enabled the next invoice will include a prorated charge for any recurring fees for the partial period and full charges for any usage and one time fees for the partial period.
      • If proration is disabled, the next invoice will only include one time fees for the partial period and will not include and recurring or usage fees for the partial period.
    • If you want to make product updates effective for the next invoice period or next term,  set the contract effective date to the first day of the next invoice period or the first day of the next term.                      
  9. If you have Service Activation and Customer Acceptance dates enabled then click the Service Activation button, enter the Service Activation Date and click Save, then click the Customer Acceptance button, enter the Customer Acceptance Date and click Save.

Update a Product via API

Refer to the API Documentation for Updating a Product and follow the instructions based on your WSDL version. 

The contract effective, effective, service activation and customer acceptance dates should be set to the date you want the product update to take effect.

  • Most companies make product updates effective immediately during an invoice period.
    • If proration is enabled the next invoice will include a prorated charge for any recurring fees for the partial period and full charges for any usage and one time fees for the partial period.
    • If proration is disabled, the next invoice will only include one time fees for the partial period and will not include and recurring or usage fees for the partial period.
  • If you want to make product updates effective for the next invoice period or next term,  set the contract effective date to the first day of the next invoice period or the first day of the next term.                 

Remove a Product

Use the following steps to remove a product from a subscription. These steps must be followed for each product you want to remove.

Remove a Product via UI

  1. Click on the subscription you want to change.
  2. Click on the Amendment button.                                        amend button.png
  3. Enter in an Amendment Name, Change Description (optional).
  4. Select Remove Product from the Amendment Type drop down, and click Save.                                                                                                             remove_seats.png
  5. Using the Select Product drop down, choose the product you want to remove and click Save.     select removal.png                     
  6. Click the Contract effective button, enter a Contract effective Date and click Save.
    • The contract effective date should be set to the date you want the cancellation or downgrade to take effect.
    • If proration is enabled and the amendment contract effective date is not set to the start of the next invoice period or next term, the customer will receive a proration credit for the unused portion of a recurring fee. One time charges and usage charges will never prorate.
    • In order to ensure no proration for a recurring charge set the contract effective date to the first day of the next invoice period or the first day of the next term, depending on if you want to cancel at the end of the last invoice period or end of term.
    • In this example the current invoice period for this product extends from 10/01/2011-10/31/2011 and the next invoice period for this product begins on 11/01/2001, so we set the contract effective date to 11/01/2001 and the charge will not prorate.                             effective.png
  7. If you have Service Activation and Customer Acceptance dates enabled then click the Service Activation button, enter the Service Activation Date and click Save, then click the Customer Acceptance button, enter the Customer Acceptance Date and click Save.

Remove a Product via API

Refer to the API Documentation for Removing a Product  and follow the instructions based on your WSDL version. 

The contract effective, effective, service activation and customer acceptance dates should be set to the date you want the cancellation or downgrade to take effect.

  • If proration is enabled and the amendment contract effective date is not set to the start of the next invoice period or next term, the customer will receive a proration credit for the unused portion of a recurring fee. One time charges and usage charges will never prorate.
  • In order to ensure no proration this should be the first day of the next invoice period or the first day of the next term, depending on if you want to cancel at the end of the last invoice period or end of term.
  • If the current invoice period for the product extends from 10/01/2011-10/31/2011 and the next invoice period for this product begins on 11/01/2001, if you do not want proration set the contract effective date to 11/01/2001.       

Upgrade a Product

Upgrades require a Remove Product amendment and an Add Product amendment. These steps must be followed for each product you want to upgrade.

Upgrade a Product via UI

  1. Follow the Remove a Product via UI steps.
  2. Once the product is removed, follow the Add a Product via UI steps. Use the same dates as the Remove Product amendment, which makes the new product effective the day the old product is removed.

Upgrade a Product via API

Refer to the API Documentation for Removing a Product  and follow the instructions based on your WSDL version. 

When the Remove Product amendment is succesful, follow the Adding a Product instructions using the date used in the Remove Product amendment.

Downgrade a Product

Downgrades require a Remove Product amendment and an Add Product amendment. These steps must be followed for each product you want to downgrade.

Downgrade a Product via UI

  1. Follow the Remove a Product via UI steps. If you do not want a proration credit for the downgrade, make the Remove Product amendment effective on the first day of the next Invoice period or next term.
  2. Once the product is removed, follow the Add a Product via UI steps. Use the same dates as the Remove Product amendment, which makes the new product effective the day the old product is removed.

Downgrade a Product via API

Refer to the API Documentation for Removing a Product  and follow the instructions based on your WSDL version. 

You must set the ContractEffectiveDate and EffectiveDate fields (and also the ServiceActivationDate and CustomerAcceptanceDate fields if enabled) to the correct date to ensure there are no refunds, credits or prorations.

  • The contract effective, effective, service activation and customer acceptance dates should be set to the date you want the cancellation or downgrade to take effect.
  • In order to ensure no proration this should be the first day of the next invoice period or the first day of the next term, depending on if you want to downgrade at the end of the last invoice period or end of term.
  • If the current invoice period for the product extends from 10/01/2011-10/31/2011 and the next invoice period for this product begins on 11/01/2001, set the contract effective date to 11/01/2001.       

When the Remove Product amendment is succesful, follow the Adding a Product instructions using the date used in the Remove Product amendment.

Renew a Subscription

Use the following steps to renew a subscription. These steps must be followed for each subscription you want to renew.

Renew a Subscription via UI

  1. Click on the subscription you want to renew.
  2. Click on the Amendment button.                                        amend button.png
  3. Enter in an Amendment Name, Change Description (optional).
  4. Select Renewal from the Amendment Type drop down, and click Save.        renewal.png
  5. The Amendment Detail section outlines the effect of the renewal. renewal_detail.png
  6. Click Active, enter a Customer Acceptance Date, and click Save.

Renew a Subscription via API

Refer to the API Documentation for Renewing a Subscription and follow the instructions based on your WSDL version. 

Change Subscription Terms and Conditions

Use the following steps to change the terms and conditions on a subscription. These steps must be followed for each subscription you want to change.

Change Subscription Terms and Conditions via UI

  1. Click on the subscription you want to renew.
  2. Click on the Amendment button.                                        amend button.png
  3. Enter in an Amendment Name, Change Description (optional).
  4. Select Terms and Conditions from the Amendment Type drop down, and click Save.        terms.png
  5. In the New Value section edit the terms and conditions and click Saveterms_2.png
  6. Click the Contract effective button, enter a Contract effective Date and click Save.
  7. If you have Service Activation and Customer Acceptance dates enabled then click the Service Activation button, enter the Service Activation Date and click Save, then click the Customer Acceptance button, enter the Customer Acceptance Date and click Save.

Change Subscription Terms and Conditions via API

Refer to the API Documentation for Changing the Terms and Conditions and follow the instructions based on your WSDL version. 

Related

Topics
Subscription Charge Display
In the subscription, under Product & Charges, you can view your charges grouped by product, trigger condition, or key statistics. You can also view the date in which the charge was invoiced through and the history for that charge.
Subscription Views
Use the Subscription Views area (located in the upper-right of the Subscriptions page) to quickly see the status of your subscriptions, and view subscriptions by status.
Creating Subscriptions
You must first create your customer accounts before you can create your subscription. Once you have a customer account, you can create subscriptions for that account in three different ways. The easiest way to create a subscription is from the Customer Accounts page. You can also create a subscription from the Subscriptions page or from a product page.
Previewing a Subscription
You can preview a subscription at any time (when the subscription is in draft, active, or canceled status) to see the invoice charges that will be generated by the subscription.
Changing Subscriptions (Amendments)
In Z-Billing, amendments are used to make changes to an active subscription.
Amendment Types
Z-Billing offers multiple types of amendments: Terms and Conditions (T&Cs) New Product Update a Product Remove a Product Renewal Each amendment type describes an action you can take to modify an existing subscription.
Amendment Fields
Every amendment type shares the following fields: Amendment Name Subscription Version Change Description Effective Date Amendment Code Amendment Type
Invoice Subscriptions to Different Accounts
Using the Invoice Subscription to Different Accounts feature, you can configure a subscription in an account to be rated and billed by a billing run initiated from a different account. This is typically used to create a hierarchical billing situation for larger companies with many departments, divisions, or subsidiaries.
Subscription and Amendment Dates
Making Changes: Amendment Use Cases
Once a subscription is set up, you can make changes to that subscription. For example, you can change the terms and conditions, or change or delete a product. In such cases, you would identify the subscription, then make the desired changes. The Amendment object carries the primary fields for making these kinds of changes. The following topics provide specific information about the types of changes you can make using the Amendment object.
Tutorials
Troubleshooting
References
Was this article helpful?
Page statistics
1253 view(s), 9 edit(s) and 22551 character(s)

Tags

Comments

You must to post a comment.

Attach file

Attachments

FileVersionSizeModifiedOptions
  • v1
  • 49.87 KiB
  • 16:24, 15 Nov 2011
  •