feat: Add support for non-catalog discounts (#191)

Author: davidgrayston-paddle

CHANGELOG.md

@@ -24,7 +24,8 @@ adding additional type guards.
 
 ### Added
 
-- Added support for new payment methods `blik`, `mb_way`, `pix` and `upi`. See [related changelog](https://developer.paddle.com/changelog/2025/blik-mbway-payment-methods).
+- Added support for new payment methods `blik`, `mb_way`, `pix` and `upi`. See [related changelog](https://developer.paddle.com/changelog/2025/blik-mbway-payment-methods?utm_source=dx&utm_medium=paddle-node-sdk).
+- Non-catalog discounts on Transactions, see [changelog](https://developer.paddle.com/changelog/2025/custom-discounts?utm_source=dx&utm_medium=paddle-node-sdk)
 - Support `retained_fee` field on totals objects to show the fees retained by Paddle for the adjustment.
 
 ### Changed

src/__tests__/resources/transactions.test.ts

@@ -24,6 +24,8 @@ import {
   ReviseTransactionRequestBody,
   TransactionsResource,
   UpdateTransactionRequestBody,
+  NonCatalogDiscount,
+  TransactionPreviewRequestBody,
 } from '../../resources/index.js';
 import { QueryParameters } from '../../internal/base/index.js';
 import { convertToSnakeCase } from '../../internal/index.js';
@@ -108,6 +110,33 @@ describe('TransactionsResource', () => {
     expect(convertToSnakeCase(CreateTransactionMock)).toEqual(CreateTransactionExpectation);
   });
 
+  test('create includes NonCatalogDiscount with custom_data and restrict_to', async () => {
+    const paddleInstance = getPaddleTestClient();
+    paddleInstance.post = jest.fn().mockResolvedValue(TransactionMockResponse);
+
+    const transactionsResource = new TransactionsResource(paddleInstance);
+
+    const discount: NonCatalogDiscount = {
+      amount: '250',
+      description: 'NCD for create',
+      type: 'flat',
+      recur: false,
+      maximum_recurring_intervals: null,
+      custom_data: { internal_reference: 'create_ref' },
+      restrict_to: ['pri_123'],
+    };
+
+    const body: CreateTransactionRequestBody = {
+      ...CreateTransactionMock,
+      discountId: null,
+      discount,
+    };
+
+    await transactionsResource.create(body);
+
+    expect(paddleInstance.post).toHaveBeenCalledWith(`/transactions?`, body);
+  });
+
   test('should update an existing transaction', async () => {
     const transactionId = TransactionMock.id;
     const transactionToBeUpdated: UpdateTransactionRequestBody = UpdateTransactionMock;
@@ -123,6 +152,34 @@ describe('TransactionsResource', () => {
     expect(convertToSnakeCase(UpdateTransactionMock)).toEqual(UpdateTransactionExpectation);
   });
 
+  test('update includes NonCatalogDiscount with custom_data and restrict_to', async () => {
+    const transactionId = TransactionMock.id;
+    const paddleInstance = getPaddleTestClient();
+    paddleInstance.patch = jest.fn().mockResolvedValue(TransactionMockResponse);
+
+    const transactionsResource = new TransactionsResource(paddleInstance);
+
+    const discount: NonCatalogDiscount = {
+      amount: '300',
+      description: 'NCD for update',
+      type: 'percentage',
+      recur: true,
+      maximum_recurring_intervals: 5,
+      custom_data: { internal_reference: 'update_ref' },
+      restrict_to: ['pri_456', 'pri_789'],
+    };
+
+    const body: UpdateTransactionRequestBody = {
+      ...UpdateTransactionMock,
+      discountId: null,
+      discount,
+    };
+
+    await transactionsResource.update(transactionId, body);
+
+    expect(paddleInstance.patch).toHaveBeenCalledWith(`/transactions/${transactionId}?`, body);
+  });
+
   test('should get an link to download invoice PDF for an existing transaction', async () => {
     const transactionId = TransactionMock.id;
 
@@ -147,6 +204,32 @@ describe('TransactionsResource', () => {
     expect(updatedTransaction).toBeDefined();
   });
 
+  test('preview accepts NonCatalogDiscount with custom_data and restrict_to', async () => {
+    const paddleInstance = getPaddleTestClient();
+    paddleInstance.post = jest.fn().mockResolvedValue(TransactionPreviewMockResponse);
+
+    const transactionsResource = new TransactionsResource(paddleInstance);
+
+    const discount: NonCatalogDiscount = {
+      amount: '150',
+      description: 'NCD for preview',
+      type: 'flat',
+      recur: false,
+      maximum_recurring_intervals: null,
+      custom_data: { internal_reference: 'preview_ref' },
+      restrict_to: ['pri_123'],
+    };
+
+    const body: TransactionPreviewRequestBody = {
+      ...PreviewTransactionMock,
+      discount,
+    };
+
+    await transactionsResource.preview(body);
+
+    expect(paddleInstance.post).toHaveBeenCalledWith(`/transactions/preview`, body);
+  });
+
   test('should be able to revise an existing transaction', async () => {
     const transactionId = TransactionMock.id;
     const transactionToBeRevised: ReviseTransactionRequestBody = ReviseTransactionMock;

src/resources/transactions/operations/create-transaction-request-body.ts

@@ -12,6 +12,7 @@ import {
   type ITransactionsTimePeriod,
 } from '../../../types/index.js';
 import { type CollectionMode, type CurrencyCode, type TransactionStatus } from '../../../enums/index.js';
+import { NonCatalogDiscount } from './non-catalog-discount.js';
 
 export interface CreateTransactionRequestBody {
   items: ITransactionItemWithNonCatalogPrice[];
@@ -26,4 +27,5 @@ export interface CreateTransactionRequestBody {
   billingDetails?: IBillingDetailsCreate | null;
   billingPeriod?: ITransactionsTimePeriod | null;
   checkout?: ITransactionCheckout;
+  discount?: NonCatalogDiscount | null;
 }

src/resources/transactions/operations/index.ts

@@ -13,3 +13,4 @@ export * from './update-transaction-request-body.js';
 export * from './transaction-preview-request-body.js';
 export * from './get-transaction-invoice-pdf-query-parameters.js';
 export * from './revise-transaction-request-body.js';
+export * from './non-catalog-discount.js';

src/resources/transactions/operations/non-catalog-discount.ts

@@ -0,0 +1,18 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { DiscountType } from '../../../enums/index.js';
+import { type ICustomData } from '../../../types/index.js';
+
+export interface NonCatalogDiscount {
+  amount: string;
+  description: string;
+  type: DiscountType;
+  recur?: boolean;
+  maximum_recurring_intervals?: number | null;
+  custom_data?: ICustomData | null;
+  restrict_to?: string[] | null;
+}

src/resources/transactions/operations/transaction-preview-request-body.ts

@@ -6,6 +6,7 @@
 
 import { type CountryCode, type CurrencyCode } from '../../../enums/index.js';
 import { type ITransactionItemPreviewRequest } from '../../../types/index.js';
+import { NonCatalogDiscount } from './non-catalog-discount.js';
 
 export interface IAddressPreviewResponse {
   postal_code?: string | null;
@@ -27,4 +28,5 @@ export interface TransactionPreviewRequestBody {
   customerIpAddress?: string | null;
   address?: IAddressPreview | null;
   ignoreTrials?: boolean | null;
+  discount?: NonCatalogDiscount | null;
 }

src/resources/transactions/operations/update-transaction-request-body.ts

@@ -12,6 +12,7 @@ import {
   type ITransactionItemWithNonCatalogPrice,
   type ITransactionsTimePeriod,
 } from '../../../types/index.js';
+import { NonCatalogDiscount } from './non-catalog-discount.js';
 
 export interface UpdateTransactionRequestBody {
   status?: TransactionStatus;
@@ -26,4 +27,5 @@ export interface UpdateTransactionRequestBody {
   billingPeriod?: ITransactionsTimePeriod | null;
   items?: ITransactionItemWithNonCatalogPrice[];
   checkout?: ITransactionCheckout | null;
+  discount?: NonCatalogDiscount | null;
 }