Completed Subscriptions section of Kaui Guide #310
Conversation
ghost
requested a review
from 
|
|
||
| [NOTE] | ||
| *Note:* To add an add-on to a subscription, the add-on must exist in the catalog. For information on adding an add-on to the catalog, see <<part_6_tenants_and_admin>>. | ||
|
|
There was a problem hiding this comment.
Minor correction: The add-on must exist in the catalog and be available in the base plan.
| Use one of the other two options – *Specify Policy* or *Specify a date* – to alter when this change takes effect: | ||
|
|
||
| * *Specify Policy*: You can select either `IMMEDIATE` or `END_OF_TERM`. For information on these two policies, see the https://docs.killbill.io/latest/userguide_subscription.html#\_subscription_alignment_rules["Subscription Alignment Rules"] section of the \_Subscription Guide_. | ||
|
|
There was a problem hiding this comment.
Might be worth mentioning that these rules can be specified in the catalog under the plan change timing section but the values specified here override the catalog values.
|
|
||
| | Cancel end of term (no credit) | ||
| | Cancels the subscription immediately with no refund to the customer. Note that after using this option to cancel, you can still reinstate the customer (i.e., reverse the cancellation). | ||
|
|
There was a problem hiding this comment.
Is there a typo here? Shouldn't this be Cancels the subscription at the end of the billing period?
There was a problem hiding this comment.
You are great! That was an error. Fixed - line 1101
| . In the *New plan* field, select a different plan. | ||
| . If you need to override the price for the plan you've selected, enter the amount in the *Price Override* field. | ||
| . To accept the default policy for when this change takes effect, leave *Default policy* selected and click *Save.* | ||
|
|
There was a problem hiding this comment.
Added to line 1042 (just general info) and addressed END_OF_TERM in line 1058.
| Follow the steps below to update the billing cycle day (BCD) defined for a subscription. These steps assume the subscription is billed on a monthly basis. | ||
|
|
||
| For information on how changing the BCD affects the subscription, see the https://docs.killbill.io/latest/userguide_subscription.html#\_billing_alignment_rules["Billing Alignment Rules"] section of the \_Subscription Guide_. | ||
|
|
There was a problem hiding this comment.
The Billing Alignment Rules specify whether billing occurs at the account/subscription or bundle level. Updating a subscription BCD in Kaui results in the system using the new BCD irrespective of what is specified in the billing alignment rules in the catalog. In other words, the BCD specified in Kaui overrides the catalog billing alignment rules. Might be useful to add this context here.
There was a problem hiding this comment.
Removed reference to Billing Alignment Rules. Added your info to line 118.
| | To define a specific date on which the subscription begins, select this option, and choose a date from the *Date* field that appears. | ||
|
|
||
| |=== | ||
|
|
There was a problem hiding this comment.
Below the "Add Add-on", there are other options like "Transfer Ownership" and "Pause/Resume". Are these intentionally left out?
There was a problem hiding this comment.
See the ALL NEW Pause/Resume section below (1040). Pierre said to not document the Transfer Ownership feature for now.
There was a problem hiding this comment.
@reshmabidikar - All of your comments have been addressed. Let me know if I missed anything. Thanks for catching all of that.
| . In the *New plan* field, select a different plan. | ||
| . If you need to override the price for the plan you've selected, enter the amount in the *Price Override* field. | ||
| . To accept the default policy for when this change takes effect, leave *Default policy* selected and click *Save.* | ||
|
|
There was a problem hiding this comment.
Added to line 1042 (just general info) and addressed END_OF_TERM in line 1058.
| Use one of the other two options – *Specify Policy* or *Specify a date* – to alter when this change takes effect: | ||
|
|
||
| * *Specify Policy*: You can select either `IMMEDIATE` or `END_OF_TERM`. For information on these two policies, see the https://docs.killbill.io/latest/userguide_subscription.html#\_subscription_alignment_rules["Subscription Alignment Rules"] section of the \_Subscription Guide_. | ||
|
|
|
|
||
| | Cancel end of term (no credit) | ||
| | Cancels the subscription immediately with no refund to the customer. Note that after using this option to cancel, you can still reinstate the customer (i.e., reverse the cancellation). | ||
|
|
There was a problem hiding this comment.
You are great! That was an error. Fixed - line 1101
|
|
||
| [NOTE] | ||
| *Note:* To add an add-on to a subscription, the add-on must exist in the catalog. For information on adding an add-on to the catalog, see <<part_6_tenants_and_admin>>. | ||
|
|
| Follow the steps below to update the billing cycle day (BCD) defined for a subscription. These steps assume the subscription is billed on a monthly basis. | ||
|
|
||
| For information on how changing the BCD affects the subscription, see the https://docs.killbill.io/latest/userguide_subscription.html#\_billing_alignment_rules["Billing Alignment Rules"] section of the \_Subscription Guide_. | ||
|
|
There was a problem hiding this comment.
Removed reference to Billing Alignment Rules. Added your info to line 118.
| | To define a specific date on which the subscription begins, select this option, and choose a date from the *Date* field that appears. | ||
|
|
||
| |=== | ||
|
|
There was a problem hiding this comment.
See the ALL NEW Pause/Resume section below (1040). Pierre said to not document the Transfer Ownership feature for now.
| OR | ||
|
|
||
| You can select one of two other options: *Specify Policy* or *Specify a date*. This will override the policy defined in the catalog for the plan. (For information on this topic, see see https://docs.killbill.io/latest/userguide_subscription.html#_plan_change_timing["Plan Change Timing"] in the _Subscription Guide_.) | ||
|
|
There was a problem hiding this comment.
The URL is not rendered properly in the asciidoc file. See https://github.com/FlowWriter/killbill-docs/blob/kaui-only-5/userguide/kaui/Kaui_Guide_Draft.adoc#change-a-subscription
|
|
||
| OR | ||
|
|
||
| You can select one of two other options: *Specify Policy* or *Specify a date*. This will override the policy defined in the catalog for the plan. (For information on this topic, see see https://docs.killbill.io/latest/userguide_subscription.html#_plan_change_timing["Plan Change Timing"] in the _Subscription Guide_.) |
|
Merging so we can check the rendering. |
I don't know if I got all of this right, so keep a sharp eye out. :-0
There's a PDF available if you want to read it that way. See page 35 - 41.