Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Tiered Unit Pricing Labels #790

Merged
merged 4 commits into from
Feb 27, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions lib/recurly/pricing/subscription/calculations.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import find from 'component-find';
import isEmpty from 'lodash.isempty';
import decimalizeMember from '../../../util/decimalize-member';
import taxRound from '../../../util/tax-round';
import { getTieredPricingTotal, isTieredAddOn } from './tiered-pricing-calculator';
import { getTieredPricingTotal, getTieredPricingUnitAmount, isTieredAddOn } from './tiered-pricing-calculator';

/**
* Subscription pricing calculation handler
Expand Down Expand Up @@ -168,23 +168,25 @@ export default class Calculations {
// exclude usage addons
if (addon.add_on_type !== 'fixed') return;

let price = addon.price[this.items.currency].unit_amount;
const selectedQuantity = find(this.items.addons, { code: addon.code })?.quantity || 0;

this.price.base.addons[addon.code] = price;
this.price.addons[addon.code] = price; // DEPRECATED
let unitPrice; // Price per unit, displayed on the label
let totalPrice; // Total price for the addon

const selectedQuantity = find(this.items.addons, { code: addon.code })?.quantity;
if (selectedQuantity) {
if (isTieredAddOn(addon)) {
const currencyCode = this.pricing.currencyCode;
price = getTieredPricingTotal(addon, selectedQuantity, currencyCode);
} else {
price = price * selectedQuantity;
}

if (!this.isTrial()) this.price.now.addons += price;
this.price.next.addons += price;
if (isTieredAddOn(addon)) {
const currencyCode = this.pricing.currencyCode;
totalPrice = getTieredPricingTotal(addon, selectedQuantity, currencyCode);
unitPrice = getTieredPricingUnitAmount(addon, selectedQuantity, currencyCode);
} else {
unitPrice = addon.price[this.items.currency].unit_amount;
totalPrice = unitPrice * selectedQuantity;
}

this.price.base.addons[addon.code] = unitPrice;
this.price.addons[addon.code] = totalPrice; // DEPRECATED

if (!this.isTrial()) this.price.now.addons += totalPrice;
this.price.next.addons += totalPrice;
});
}

Expand Down
13 changes: 13 additions & 0 deletions lib/recurly/pricing/subscription/tiered-pricing-calculator.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/* eslint-disable no-param-reassign */
import find from 'component-find';

/**
*
Expand Down Expand Up @@ -118,3 +119,15 @@ export function getTieredPricingTotal (
initialUnitAmount,
);
}

/**
* returns the unit amount for a tiered pricing model in the current tier based on selectedNumUnits
* @param {object} addOn
* @param {int} selectedNumUnits
* @param {string} currencyCode
* @returns number
*/
export function getTieredPricingUnitAmount (addOn, selectedNumUnits, currencyCode) {
const tier = find(addOn.tiers, (tier) => (selectedNumUnits || 1) <= tier.ending_quantity);
return find(tier.currencies, (currency) => currency.currency_code === currencyCode).unit_amount;
}
194 changes: 110 additions & 84 deletions test/server/fixtures/plans/tiered-plan.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,93 +13,119 @@
"length": 1
},
"tax_exempt": true,
"addons": [{
"code": "flat",
"name": "flat",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [],
"tier_type": "flat",
"price": {
"USD": {
"unit_amount": 1.0
"addons": [
{
"code": "flat",
"name": "flat",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [],
"tier_type": "flat",
"price": {
"USD": {
"unit_amount": 1.0
}
}
}
}, {
"code": "tiered",
"name": "tiered",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [{
"ending_quantity": 5,
"currencies": [{
"currency_code": "USD",
"unit_amount": 2.00
}]
}, {
"ending_quantity": 999999999,
"currencies": [{
"currency_code": "USD",
"unit_amount": 4.00
}]
}],
"tier_type": "tiered",
"price": {
"USD": {
"unit_amount": 4.00
},
{
"code": "tiered",
"name": "tiered",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [
{
"ending_quantity": 5,
"currencies": [
{
"currency_code": "USD",
"unit_amount": 2.00
}
]
},
{
"ending_quantity": 999999999,
"currencies": [
{
"currency_code": "USD",
"unit_amount": 4.00
}
]
}
],
"tier_type": "tiered",
"price": {
"USD": {
"unit_amount": 4.00
}
}
}
}, {
"code": "volume",
"name": "volume",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [{
"ending_quantity": 5,
"currencies": [{
"currency_code": "USD",
"unit_amount": 2.00
}]
}, {
"ending_quantity": 999999999,
"currencies": [{
"currency_code": "USD",
"unit_amount": 4.00
}]
}],
"tier_type": "volume",
"price": {
"USD": {
"unit_amount": 4.00
},
{
"code": "volume",
"name": "volume",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [
{
"ending_quantity": 5,
"currencies": [
{
"currency_code": "USD",
"unit_amount": 2.00
}
]
},
{
"ending_quantity": 999999999,
"currencies": [
{
"currency_code": "USD",
"unit_amount": 4.00
}
]
}
],
"tier_type": "volume",
"price": {
"USD": {
"unit_amount": 4.00
}
}
}
}, {
"code": "stairstep",
"name": "stairstep",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [{
"ending_quantity": 5,
"currencies": [{
"currency_code": "USD",
"unit_amount": 2.00
}]
}, {
"ending_quantity": 999999999,
"currencies": [{
"currency_code": "USD",
"unit_amount": 4.00
}]
}],
"tier_type": "stairstep",
"price": {
"USD": {
"unit_amount": 4.00
},
{
"code": "stairstep",
"name": "stairstep",
"quantity": 1,
"add_on_type": "fixed",
"optional": true,
"tiers": [
{
"ending_quantity": 5,
"currencies": [
{
"currency_code": "USD",
"unit_amount": 2.00
}
]
},
{
"ending_quantity": 999999999,
"currencies": [
{
"currency_code": "USD",
"unit_amount": 4.00
}
]
}
],
"tier_type": "stairstep",
"price": {
"USD": {
"unit_amount": 4.00
}
}
}
}]
]
}
31 changes: 29 additions & 2 deletions test/unit/pricing/subscription/tiered-pricing-calculator.test.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import assert from 'assert';
import { getTieredPricingTotal } from '../../../../lib/recurly/pricing/subscription/tiered-pricing-calculator';
import {
getTieredPricingTotal,
getTieredPricingUnitAmount
} from '../../../../lib/recurly/pricing/subscription/tiered-pricing-calculator';
import { initRecurly } from '../../support/helpers';
import TIERED_PLAN from '../../../server/fixtures/plans/tiered-plan.json';

describe('Recurly.Pricing.Subscription.TieredPricingCalendar', function () {
describe('Recurly.Pricing.Subscription.TieredPricingCalculator', function () {
beforeEach(function () {
this.recurly = initRecurly();
this.pricing = this.recurly.Pricing.Subscription();
Expand All @@ -30,5 +33,29 @@ describe('Recurly.Pricing.Subscription.TieredPricingCalendar', function () {
assert.strictEqual(getTieredPricingTotal(volumeAddon, 6, 'USD'), 24.00);
done();
});

describe('unit pricing for current unit amount', () => {
it('should return the current tier price for tiered pricing', function (done) {
const tieredAddon = TIERED_PLAN.addons.filter((addon) => { return addon.code === 'tiered'; })[0];

assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 1, 'USD'), 2.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 2, 'USD'), 2.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 5, 'USD'), 2.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 6, 'USD'), 4.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 50, 'USD'), 4.00);
done();
});

it('should return the current tier price for stairstep pricing', function (done) {
const tieredAddon = TIERED_PLAN.addons.filter((addon) => { return addon.code === 'stairstep'; })[0];

assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 1, 'USD'), 2.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 2, 'USD'), 2.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 5, 'USD'), 2.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 6, 'USD'), 4.00);
assert.strictEqual(getTieredPricingUnitAmount(tieredAddon, 50, 'USD'), 4.00);
done();
});
});
});
});