CheckoutPricing: Coupons #385

chrissrogers · 2017-11-02T06:40:43Z

Description

To follow CheckoutPricing: Subscriptions & Adjustments #382 -- includes CheckoutPricing subscription and adjustment framework
Adds CheckoutPricing#coupon
Adds CheckoutPricing/Calculations#coupon calculation routines

Example

var subscriptionPricing = recurly.Pricing.Subscription();
var checkoutPricing = recurly.Pricing.Checkout();

subscriptionPricing.plan('my-plan-code').done(function () {
  // One coupon may be used at a time
  checkoutPricing
    .subscription(subscriptionPricing)
    .coupon('my-coupon-code')
    .done(function (price) {
      console.log(price);
    });
});

- Manages a single coupon on the item set Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- /plans/:plan_code/coupons/:coupon_code -> /coupons/:id - optional `plan_id` as `plan` Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Vestigial IE8 support Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Still WIP: need to determine API capabilities for plan-specific and plan-agnostic coupons Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- For spreading a long set request across multiple requests Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Uses pipedRequest to spread a large number of plans - Adds expectation for invoice-level coupon properties Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Supports discounts against adjustments, single subscriptions, and free trials Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Ignores 404s until done - Immediately rejects other errors - Collects and concats array responses - Immediately resolves non-array responses Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Avoids an extraneous API call when assigning a coupon to a subscription Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- CheckoutPricing must accept SubscriptionPricing instances before they are given plans Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Checks for a subscription price before adding it to the price, since price is not guaranteed to exist Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- /v1/coupons will return coupons which may not necessarily match the requested plan codes, if they may also apply to adjustments - this adds a validity detection method to SubscriptionPricing coupon getter Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Compatible with new coupon validity checks Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Also fixes setup fee exclusion rules for discounts Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

- Fixed amount coupons - subscription-level coupons - Free trial coupons Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

chrissrogers · 2017-11-09T07:42:15Z

lib/recurly/pricing/subscription/calculations.js

+      const discountableNow = this.price.now.subtotal + this.price.now.setup_fee;
+      const discountableNext = this.price.next.subtotal;
+      this.price.now.discount = Math.min(discountableNow, coupon.discount.amount[this.items.currency]);
+      this.price.next.discount = Math.min(discountableNext, coupon.discount.amount[this.items.currency]);


This is an important change to current pricing behavior.

Previously, if a coupon with a fixed value higher than the subscription total (now + next cycle) was applied, it would apply a discount larger than the total. Now, the discount amount is limited to the total per cycle.

chrissrogers · 2017-11-09T07:44:25Z

test/pricing/subscription/subscription.test.js

@@ -346,7 +346,7 @@ describe('Recurly.Pricing.Subscription', function () {
        .coupon('coop')
        .done(function (price) {
          assert.equal(price.now.discount, '20.00');
-          assert.equal(price.next.discount, '20.00');
+          assert.equal(price.next.discount, '19.99');


See https://github.com/recurly/recurly-js/pull/385/files#r149884482

chrissrogers · 2017-11-09T07:48:00Z

lib/recurly/pricing/subscription/calculations.js

@@ -63,11 +63,10 @@ export default class Calculations {
    this.price.now.subtotal += this.price.now.addons;
    this.price.next.subtotal += this.price.next.addons;

+    this.setupFee();


This was moved prior to discount calculation in order to determine whether a coupon discount amount has exceeded the discountable subtotal for the subscription cycles.

snodgrass23 · 2017-11-09T19:40:30Z

lib/recurly/apple-pay.js

@@ -1,12 +1,12 @@
 import Emitter from 'component-emitter';
 import errors from '../errors';
+import {CheckoutPricing} from './pricing/checkout';


Is this going to be used in one of the followup PR's?

Yeah. Prior to writing the CheckoutPricing/Attachment class, I'll adapt these modules to use the Pricing base class

snodgrass23 · 2017-11-09T19:44:09Z

lib/recurly.js

+   * @private
+   */
+
+  pipedRequest ({ method, route, data, by, size }) {


What about setting the default for size here like it appears in the doc block above. Since the only use of this function at this time using the default, we could remove the arg in that call. Is the method generally always going to be a GET? If so, we could set that default as well.

I actually fixed the default assignment in #393 when I added specs for this method. I'll add it here too.
+1 to setting the method default as well

snodgrass23 · 2017-11-09T20:48:04Z

lib/recurly/pricing/subscription/index.js

+  couponIsValidForSubscription (coupon) {
+    if (!coupon) return false;
+    if (!coupon.applies_to_plans) return false;
+    if (coupon.applies_to_all_plans) return true;


another option would be to consolidate these last three lines into:

return coupon.applies_to_all_plans || ~coupon.plans.indexOf(this.items.plan.code)

For business rules like this, I personally prefer the readability of the early returns

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

snodgrass23

👍

cookrn

👍

chrissrogers added the new feature label Nov 2, 2017

chrissrogers changed the title ~~CheckoutPricing: Subscriptions & Adjustments~~ CheckoutPricing: Coupons Nov 2, 2017

chrissrogers requested a review from snodgrass23 November 2, 2017 06:45

chrissrogers force-pushed the checkout-pricing-features/coupons branch from 9eb79fd to 8003c08 Compare November 2, 2017 07:27

chrissrogers added the in progress label Nov 2, 2017

chrissrogers force-pushed the checkout-pricing-features/coupons branch 3 times, most recently from d5a895a to cd31e99 Compare November 6, 2017 02:51

chrissrogers removed the in progress label Nov 6, 2017

chrissrogers mentioned this pull request Nov 6, 2017

CheckoutPricing: Gift cards #391

Merged

chrissrogers force-pushed the checkout-pricing-features/coupons branch 2 times, most recently from b51454a to 3de9002 Compare November 6, 2017 21:19

chrissrogers force-pushed the checkout-pricing branch from bed9622 to 51d443a Compare November 6, 2017 23:59

chrissrogers added 17 commits November 6, 2017 16:04

Adds CheckoutPricing#coupon

95a861e

- Manages a single coupon on the item set Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds CheckoutPricing discount calculations

e4c5f81

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Updates recurly.coupon for new endpoint

f3be292

- /plans/:plan_code/coupons/:coupon_code -> /coupons/:id - optional `plan_id` as `plan` Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Removes component-type

e26485d

- Vestigial IE8 support Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Updates coupon module structure

53b622b

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Updates CheckoutPricing for new coupon getter

75af47d

- Still WIP: need to determine API capabilities for plan-specific and plan-agnostic coupons Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Updates coupon specs for new endpoint

0f84178

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds recurly.pipedRequest

c513752

- For spreading a long set request across multiple requests Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds multiple plan code support to coupon getter

2e73e2a

- Uses pipedRequest to spread a large number of plans - Adds expectation for invoice-level coupon properties Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes argument syntax

b8df59c

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Updates CheckoutPricing coupon handler for new types

8503c99

- Supports discounts against adjustments, single subscriptions, and free trials Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Improves recurly.pipedRequest response handling

b75213f

- Ignores 404s until done - Immediately rejects other errors - Collects and concats array responses - Immediately resolves non-array responses Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds spec plans

19f22f9

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Updates SubscriptionPricing.coupon to receive objects

adb4523

- Avoids an extraneous API call when assigning a coupon to a subscription Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes CheckoutPricing plan currency handling

bd08d09

- CheckoutPricing must accept SubscriptionPricing instances before they are given plans Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes CheckoutPricing/Calculations sub calculation safety

712f670

- Checks for a subscription price before adding it to the price, since price is not guaranteed to exist Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds EmbeddedSubscriptionPricing

4430bb4

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

chrissrogers added 5 commits November 6, 2017 16:04

Fixes coupon specs

b2181c8

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes SubscriptionPricing.reprice

2fff200

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes coupon fixtures

31a01ed

- Compatible with new coupon validity checks Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes coupon validity method safety

fbb652c

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

chrissrogers force-pushed the checkout-pricing-features/coupons branch from 87e8fb5 to fbb652c Compare November 7, 2017 00:05

chrissrogers added 10 commits November 6, 2017 20:11

Fixes pipedRequest for empty sets

dc8ecdf

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes CheckoutPricing.coupon set and calculations

eb0f52f

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds CheckoutPricing.coupon specs

2aaa800

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes CheckoutPricing fixed amount discount overrun

2c5c70d

- Also fixes setup fee exclusion rules for discounts Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes CheckoutPricing subscription coupon and gift card removal

8011207

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds decimalize pass to CheckoutPricing

193bb94

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds CheckoutPricing fixed amount discount soecs

2a15d81

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes CheckoutPricing free trial application reprice

1b8eb55

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Fixes SubscriptionPricing fixed amount discounting of setup fees

2852800

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

Adds CheckoutPricing discount specs

1bbabe0

- Fixed amount coupons - subscription-level coupons - Free trial coupons Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

chrissrogers requested a review from cookrn November 9, 2017 07:35

chrissrogers commented Nov 9, 2017

View reviewed changes

snodgrass23 reviewed Nov 9, 2017

View reviewed changes

Adds recurly.pipedRequest defaults

2362f17

Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>

chrissrogers force-pushed the checkout-pricing-features/coupons branch from 9b701c1 to 2362f17 Compare November 9, 2017 22:38

snodgrass23 approved these changes Nov 10, 2017

View reviewed changes

cookrn approved these changes Nov 13, 2017

View reviewed changes

cookrn merged commit a835841 into checkout-pricing Nov 13, 2017

cookrn deleted the checkout-pricing-features/coupons branch November 13, 2017 18:45

chrissrogers mentioned this pull request Nov 18, 2017

CheckoutPricing #399

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CheckoutPricing: Coupons #385

CheckoutPricing: Coupons #385

chrissrogers commented Nov 2, 2017

chrissrogers Nov 9, 2017 •

edited

Loading

chrissrogers Nov 9, 2017 •

edited

Loading

chrissrogers Nov 9, 2017

snodgrass23 Nov 9, 2017

chrissrogers Nov 9, 2017 •

edited

Loading

chrissrogers Nov 10, 2017

snodgrass23 Nov 9, 2017

chrissrogers Nov 9, 2017

snodgrass23 Nov 9, 2017

chrissrogers Nov 10, 2017

snodgrass23 left a comment

cookrn left a comment

CheckoutPricing: Coupons #385

CheckoutPricing: Coupons #385

Conversation

chrissrogers commented Nov 2, 2017

Description

Example

chrissrogers Nov 9, 2017 • edited Loading

Choose a reason for hiding this comment

chrissrogers Nov 9, 2017 • edited Loading

Choose a reason for hiding this comment

chrissrogers Nov 9, 2017

Choose a reason for hiding this comment

snodgrass23 Nov 9, 2017

Choose a reason for hiding this comment

chrissrogers Nov 9, 2017 • edited Loading

Choose a reason for hiding this comment

chrissrogers Nov 10, 2017

Choose a reason for hiding this comment

snodgrass23 Nov 9, 2017

Choose a reason for hiding this comment

chrissrogers Nov 9, 2017

Choose a reason for hiding this comment

snodgrass23 Nov 9, 2017

Choose a reason for hiding this comment

chrissrogers Nov 10, 2017

Choose a reason for hiding this comment

snodgrass23 left a comment

Choose a reason for hiding this comment

cookrn left a comment

Choose a reason for hiding this comment

chrissrogers Nov 9, 2017 •

edited

Loading

chrissrogers Nov 9, 2017 •

edited

Loading

chrissrogers Nov 9, 2017 •

edited

Loading