[Release] v3.5.0 (#203)

Author: danbillson

CHANGELOG.md

@@ -20,10 +20,13 @@ in a response, this weakens the Typescript type but does not cause existing usag
 This means when upgrading minor versions of the SDK, you may notice type errors. You can safely ignore these or fix by
 adding additional type guards.
 
-## [unreleased]
+## 3.5.0 - 2025-12-16
 
 ### Added
 
+- Added support for `location` value in `tax_mode` enum to automatically present prices as inclusive or exclusive of tax based on customer location. See [related changelog](https://developer.paddle.com/changelog/2025/default-automatic-tax-setting?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added support for `requiresPaymentMethod` field in trial period to specify whether a payment method is required during trial
+- Added `remittanceReference` field to payout notification entity
 - Added new report filter names `remittance_reference` and `transaction_updated_at`. See [related changelog](https://developer.paddle.com/changelog/2025/payout-reconciliation-report?utm_source=dx&utm_medium=paddle-node-sdk).
 - Added `payout_reconciliation` report type. See [related changelog](https://developer.paddle.com/changelog/2025/payout-reconciliation-report?utm_source=dx&utm_medium=paddle-node-sdk).
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
   "main": "dist/cjs/index.cjs.node.js",
   "module": "dist/esm/index.esm.node.js",

src/entities/price/price.ts

@@ -5,7 +5,7 @@
  */
 
 import { type CatalogType, type Status, type TaxMode } from '../../enums/index.js';
-import { ImportMeta, Money, TimePeriod, UnitPriceOverride } from '../shared/index.js';
+import { ImportMeta, Money, TimePeriod, TrialPeriod, UnitPriceOverride } from '../shared/index.js';
 import { PriceQuantity } from './price-quantity.js';
 import { type ICustomData, type IPriceResponse } from '../../types/index.js';
 import { Product } from '../product/index.js';
@@ -17,7 +17,7 @@ export class Price {
   public readonly name: string | null;
   public readonly type: CatalogType;
   public readonly billingCycle: TimePeriod | null;
-  public readonly trialPeriod: TimePeriod | null;
+  public readonly trialPeriod: TrialPeriod | null;
   public readonly taxMode: TaxMode;
   public readonly unitPrice: Money;
   public readonly unitPriceOverrides: UnitPriceOverride[];
@@ -36,7 +36,7 @@ export class Price {
     this.type = price.type;
     this.name = price.name ? price.name : null;
     this.billingCycle = price.billing_cycle ? new TimePeriod(price.billing_cycle) : null;
-    this.trialPeriod = price.trial_period ? new TimePeriod(price.trial_period) : null;
+    this.trialPeriod = price.trial_period ? new TrialPeriod(price.trial_period) : null;
     this.taxMode = price.tax_mode;
     this.unitPrice = new Money(price.unit_price);
     this.unitPriceOverrides =

src/entities/shared/index.ts

@@ -5,6 +5,7 @@
  */
 
 export * from './time-period.js';
+export * from './trial-period.js';
 export * from './money.js';
 export * from './unit-price-override.js';
 export * from './billing-details.js';

src/entities/shared/trial-period.ts

@@ -0,0 +1,20 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { type Interval } from '../../enums/index.js';
+import { type ITrialPeriodResponse } from '../../types/index.js';
+
+export class TrialPeriod {
+  public readonly interval: Interval;
+  public readonly frequency: number;
+  public readonly requiresPaymentMethod: boolean | undefined;
+
+  constructor(trialPeriod: ITrialPeriodResponse) {
+    this.interval = trialPeriod.interval;
+    this.frequency = trialPeriod.frequency;
+    this.requiresPaymentMethod = trialPeriod.requires_payment_method;
+  }
+}

src/enums/shared/tax-mode.ts

@@ -4,4 +4,4 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-export type TaxMode = 'account_setting' | 'external' | 'internal';
+export type TaxMode = 'account_setting' | 'external' | 'internal' | 'location';

src/notifications/entities/payout/payout-notification.ts

@@ -9,12 +9,14 @@ import { type IPayoutNotificationResponse } from '../../types/index.js';
 
 export class PayoutNotification {
   public readonly id: string;
+  public readonly remittanceReference: string;
   public readonly status: PayoutStatus;
   public readonly amount: string;
   public readonly currencyCode: CurrencyCode;
 
   constructor(payout: IPayoutNotificationResponse) {
     this.id = payout.id;
+    this.remittanceReference = payout.remittance_reference;
     this.status = payout.status;
     this.amount = payout.amount;
     this.currencyCode = payout.currency_code;

src/notifications/entities/price/price-notification.ts

@@ -9,6 +9,7 @@ import {
   ImportMetaNotification,
   MoneyNotification,
   TimePeriodNotification,
+  TrialPeriodNotification,
   UnitPriceOverrideNotification,
 } from '../shared/index.js';
 import { PriceQuantityNotification } from './price-quantity-notification.js';
@@ -22,7 +23,7 @@ export class PriceNotification {
   public readonly name: string | null;
   public readonly type: CatalogType | null;
   public readonly billingCycle: TimePeriodNotification | null;
-  public readonly trialPeriod: TimePeriodNotification | null;
+  public readonly trialPeriod: TrialPeriodNotification | null;
   public readonly taxMode: TaxMode;
   public readonly unitPrice: MoneyNotification;
   public readonly unitPriceOverrides: UnitPriceOverrideNotification[];
@@ -40,7 +41,7 @@ export class PriceNotification {
     this.type = price.type ? price.type : null;
     this.name = price.name ? price.name : null;
     this.billingCycle = price.billing_cycle ? new TimePeriodNotification(price.billing_cycle) : null;
-    this.trialPeriod = price.trial_period ? new TimePeriodNotification(price.trial_period) : null;
+    this.trialPeriod = price.trial_period ? new TrialPeriodNotification(price.trial_period) : null;
     this.taxMode = price.tax_mode;
     this.unitPrice = new MoneyNotification(price.unit_price);
     this.unitPriceOverrides =

src/notifications/entities/shared/index.ts

@@ -5,6 +5,7 @@
  */
 
 export * from './time-period-notification.js';
+export * from './trial-period-notification.js';
 export * from './money-notification.js';
 export * from './unit-price-override-notification.js';
 export * from './billing-details-notification.js';

src/notifications/entities/shared/trial-period-notification.ts

@@ -0,0 +1,20 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { type Interval } from '../../../enums/index.js';
+import { type ITrialPeriodNotificationResponse } from '../../types/index.js';
+
+export class TrialPeriodNotification {
+  public readonly interval: Interval;
+  public readonly frequency: number;
+  public readonly requiresPaymentMethod: boolean | undefined;
+
+  constructor(trialPeriod: ITrialPeriodNotificationResponse) {
+    this.interval = trialPeriod.interval;
+    this.frequency = trialPeriod.frequency;
+    this.requiresPaymentMethod = trialPeriod.requires_payment_method;
+  }
+}