Documentation You are here: start » v » 2.0 » cheat_sheet

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
v:2.0:cheat_sheet [2020/02/28 00:57]
foxybrett [Subscription Product Options]
v:2.0:cheat_sheet [2020/04/02 00:29]
foxybrett [Subscription Product Options]
Line 235: Line 235:
     * Foxy native email receipts will include links for the customer to be able to update or cancel their subscription. The cancel link will by default be set to ''​sub_cancel=true'',​ so the subscription will end the following day. If you want to instead default these links to cancel on the next transaction date, you can edit the language strings for your store. On the "​language"​ page of the Foxy administration,​ expand the "​email"​ section and search for "​sub_cancel=true"​. There will be two instances of it - simply update ''​true''​ to ''​next_transaction_date''​ to change the links.     * Foxy native email receipts will include links for the customer to be able to update or cancel their subscription. The cancel link will by default be set to ''​sub_cancel=true'',​ so the subscription will end the following day. If you want to instead default these links to cancel on the next transaction date, you can edit the language strings for your store. On the "​language"​ page of the Foxy administration,​ expand the "​email"​ section and search for "​sub_cancel=true"​. There will be two instances of it - simply update ''​true''​ to ''​next_transaction_date''​ to change the links.
  
- ; ''​sub_restart''​ +  ​; ''​sub_restart''​ 
- : **Description:​** A flag that makes the subscription products payable "​now",​ when used with a ''​sub_token''​ URL. This can (and generally //should//) be used instead of relying on past-due amounts. +  : **Description:​** A flag that makes the subscription products payable "​now",​ when used with a ''​sub_token''​ URL. This can (and generally //should//) be used instead of relying on past-due amounts. 
- : **Accepts:​** ''​true''​ +  : **Accepts:*
- : **Notes:​** +    ​* ''​true''​: Collect payment "right now"​. 
- * This must be passed in with a ''​sub_token''​ or it will have no effect. +    * ''​auto'':​ Collect payment "right now" if and only if the subscription'​s past-due amount is greater than 0. Adding ''​sub_restart=auto''​ will eventually be the default Foxy behavior for updating subscriptions. 
- * Normally if you load up a ''​sub_token''​ URL, it will allow modifying the subscription,​ but will //not// change the subscription'​s next date, **nor will it charge the customer immediately** for the products in the cart. (A past-due amount will still be payable "​now",​ but the rest of the products will simply bill according to the subscription'​s next transaction date.) This flag makes the subscription charge "​now"​. +  : **Notes:​** 
- * This flag is almost always going to be preferable to customers paying the single lump sum past-due amount, as it ensure taxes, shipping, and product details are maintained. +    * This must be passed in with a ''​sub_token''​ or it will have no effect. 
-  +    * Normally if you load up a ''​sub_token''​ URL, it will allow modifying the subscription,​ but will //not// change the subscription'​s next date, //nor will it charge the customer immediately// for the products in the cart. (A past-due amount will still be payable "​now",​ but the rest of the products will simply bill according to the subscription'​s next transaction date.) This flag makes the subscription charge "​now"​. 
- ; ''​sub_modify''​ +    * This flag is almost always going to be preferable to customers paying the single lump sum past-due amount, as it ensure taxes, shipping, and product details are maintained. 
- : **Description:​** Allows the "add to cart" link or form to completely replace the existing subscription loaded (in the same or a previous cart request) via the ''​sub_token''​. (The default behavior is to add new products to the existing subscription,​ and set the frequency and dates to match.) + 
- : **Accepts:*+ 
- * ''​replace''​ +  ​; ''​sub_modify''​ 
- * Defaults to "​append",​ which adds new subscription items to the existing subscription. +  : **Description:​** Allows the "add to cart" link or form to completely replace the existing subscription loaded (in the same or a previous cart request) via the ''​sub_token''​. (The default behavior is to add new products to the existing subscription,​ and set the frequency and dates to match.) 
- : **Notes:​** +  : **Accepts:​** ''​replace''​ 
- **Upgrading/​Downgrading:​** This can beuseful ​in upgrading or downgrading subscriptions,​ or otherwise modifying subs. For instance, if you had a monthly membership service, you could create an upgrade link that replaces the currently loaded subscription (loaded via the ''​sub_token''​) with the upgraded subscription. +  : **Notes:​** 
- * **Changing "​Auto-Ship"​ Subscriptions:​** Similarly, you could use this functionality to replace an auto-ship order that may have multiple different products. Let's say the customer has a subscription for Product A and B, and wants to change it to Product B and 2 Product Cs, you could build an order form that includes the ''​sub_modify=replace''​ param, and it would replace the customer'​s currently loaded subscription. +    This is an //​optional//​ parameter. If omitted, it will default to an "​append"​ behavior. 
- The default beha +    ​* Upgrading/​Downgrading:​ This can be useful ​in upgrading or downgrading subscriptions,​ or otherwise modifying subs. For instance, if you had a monthly membership service, you could create an upgrade link that replaces the currently loaded subscription (loaded via the ''​sub_token''​) with the upgraded subscription. 
- * <wrap round note>​Prorating?</​wrap>​ At present, this //does not prorate// a subscription. So if you're halfway through a subscription period and replace the subscription,​ any change in the price between the old and new subscription total //will not// be prorated. We may add an additional possibilities for this parameter in the future.+    * Changing "​Auto-Ship"​ Subscriptions:​ Similarly, you could use this functionality to replace an auto-ship order that may have multiple different products. Let's say the customer has a subscription for Product A and B, and wants to change it to Product B and 2 Product Cs, you could build an order form that includes the ''​sub_modify=replace''​ param, and it would replace the customer'​s currently loaded subscription. 
 +    Removing End Dates: To //clear// an end-date from a subscription you're replacing, pass ''​sub_enddate=00000000''​. 
 +    * <wrap round note>​Prorating?</​wrap>​ At present, this //does not prorate// a subscription. So if you're halfway through a subscription period and replace the subscription,​ any change in the price between the old and new subscription total //will not// be prorated. We may add an additional possibilities for this parameter in the future. 
 + 
 + 
  
 ==== Product Option Modifiers ==== ==== Product Option Modifiers ====

Site Tools