CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Check our main developer changelog for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.

Versioning

When we make non-breaking changes to the Paddle API, we'll only release a new major version of the Node.js SDK when it causes problems at runtime. We won't release a new version of the SDK when we weaken TypeScript types in a way that doesn't cause existing implementations to break or malfunction. For example, if we add a new field to a request or an allowed value for a field in a response, this weakens the Typescript type but does not cause existing usages to stop working.

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.

2.2.2 - 2024-12-16

Fixed

• discount.startsAt for Subscriptions can now be null

2.2.1 - 2024-12-16

Fixed

• Added proration to transaction line items

2.2.0 - 2024-12-12

Added

• VND (Vietnamese dong) as new currency
• Added adjustment.type which is either partial which should include items or full where items are not required

2.1.3 - 2024-11-29

Changed

• paddle.webhooks.unmarshal will now return an event for unhandled event types instead of null this is only possible for legacy/no longer supported events or for new events that have not been added to the sdk yet

2.1.2 - 2024-11-26

Fixed

• Updated payment-methods export to use .js extension

Added

• ESLint rule to ensure .js extension is provided

2.1.1 - 2024-11-25

Fixed

• Updated imports to use .js extension

2.1.0 - 2024-11-21

Added

• Added customerPortalSessions resources

2.0.0 - 2024-11-20

Breaking changes: This version includes major improvements that introduce breaking changes. These are called out below.

Added

• Added support for edge runtime.
• Added simulationTypes resources
• Added simulations resources
• Added simulationRuns resources
• Added simulationRunEvents resources
• Added the trafficSource filter on notification settings
• Omitted the transactionId completely from SubscriptionNotification and created a separate SubscriptionCreatedNotification with the non-null transactionId
• Added paymentMethods resources
• Added generateAuthToken for customer

Changed

• Breaking change: Updated the minimum required Node.js version to v18.
• Breaking change: Webhooks.unmarshal and Webhooks.isSignatureValid now returns a promise.
• Enabled conditional exports based on runtimes.
• Switched from node-fetch to native fetch API.

---

1.7.0 - 2024-09-18

Fixed

• Marked paymentMethodId as nullable in TransactionPaymentAttempt as it can be null.

---

1.6.0 - 2024-09-16

Added

• Added adjustments.getCreditNotePDF() to get a credit note for an adjustment
• Added disposition query parameter to adjustments.getCreditNotePDF() and transactions.getInvoicePDF() operations, see related changelog.
• Added pagination support to notificationSettings.list() operation, see related changelog.
• Added support for Non-catalog products and prices to the subscriptions.update() and subscriptions.previewUpdate() operations, see related changelog.

Fixed

• Marked notification_id as optional in IEventsResponse interface.
• Fixed a bug where query parameters with false values were not passed correctly to the API.

---

1.5.1 - 2024-09-10

Fixed

• Fixed a bug where query parameters with special characters were not passed correctly to the API.
• Dependabot security updates.

---

1.5.0 - 2024-08-16

Added

• Updated subscription items model to include product. See related changelog.

---

1.4.1 - 2024-06-21

Fixed

• Dependabot security updates.

---

1.4.0 - 2024-06-20

Added

• Added a new option to change the logging level of the SDK. You can now set the logging level to verbose, warn, error or none. The default logging level is verbose.

---

1.3.0 - 2024-04-18

Changed

• Updated the package to export both CommonJS and ES module formats.
• Updated Collection to return hasMore and estimatedTotal properties

---

1.2.2 - 2024-04-03

Fixed

• Updated the optional properties returned by pricingPreview.preview operation to match the API response.

---

1.2.1 - 2024-03-20

Fixed

• Handled missing unitPriceOverrides in the subscriptions.getPaymentMethodChangeTransaction operation.

---

1.2.0 - 2024-03-19

Changed

• Updated ErrorCode enum in TransactionPaymentAttempt to include a new error code declined_not_retryable

---

1.1.0 - 2024-03-13

Added

• Added createdAt and updatedAt to product and price entities, see related changelog.

Changed

• Updated report API to support discounts and product_prices report, see related changelog.

Removed

• Removed ISharedProductResponse and ISharedPriceResponse interfaces as they were redundant. Please use IProductResponse and IPriceResponse instead.

---

1.0.2 - 2024-03-12

Added

• Exported ApiError class for usage in try/catch block.

Changed

• Added customerId property to Address and Business entities, see related changelog.

---

1.0.1 - 2024-02-20

Changed

• Removed early access notice from README and Changelog.

---

1.0.0 - 2024-02-20

Changed

• Updated Package version to 1.0.0

---

0.6.0 - 2024-02-20

Breaking changes: This version includes major improvements that introduce breaking changes. These are called out below.

Removed

• Breaking change: Removed *Includes entity in favour of standard entities.

  • Use Price instead of PriceWithIncludes
  • Use Product instead of ProductWithIncludes
  • Use Subscription instead of SubscriptionIncludes
  • Use Transaction instead of TransactionIncludes

---

0.5.0 - 2024-02-16

Breaking changes: This version includes major improvements that introduce breaking changes. These are called out below.

Changed

• We removed the shared entities between API and Notification as we foresee them diverging. No Action required for this change

---

0.4.0 - 2024-02-14

Added

• Added availablePaymentMethods as an include Parameter to all transaction operations.
• Added importMeta to Subscription webhooks.

Changed

• Filter customers by email address in customers.list() operation, see related changelog.
• New payment method ID field for transaction payments, see related changelog.

Fixed

• Fixed effective_from enum in Resume subscription operations.

Deprecated

• Deprecated storedPaymentMethodId from transaction payments in favour of paymentMethodId field.

---

0.3.0 - 2024-01-11

Changed

• The repo and the npm package is now generally available.

---

0.2.9 - 2024-01-11

Fixed

• Marked endsAt as optional in discount under Subscriptions entity.

---

0.2.8 - 2024-01-09

Fixed

• Marked unitPriceOverrides as optional in Price entity.

---

0.2.7 - 2024-01-04

Fixed

• Marked all properties in ListNotificationQueryParameters as optional.
• Removed additional ? from URLS in List Reports and List Notifications functions.
• Fixed incorrect enum in Adjustment type

---

0.2.6 - 2023-12-22

Added

• Added support for address.imported, business.imported, customer.imported, price.imported and product.imported notifications.

Changed

• Added support to get available payment methods when previewing prices or transactions, see related changelog.
• Added support to bill a one time non-catalog products and prices to subscription, see related changelog.
• Added support for non-catalog products and prices to transaction, see related changelog.
• Added subscription.onPaymentFailure to update subscriptions and preview update subscription operations, see related changelog.

---

0.2.5 - 2023-12-15

Added

• Added reports.list() to list reports
• Added reports.create() to create a new report
• Added reports.get() to get a report
• Added reports.getReportCsv() to get a CSV file for a report

---

0.2.4 - 2023-12-14

Changed

• Added importMeta to address, business, customer, discount and subscription entities
• Added creditToBalance to transaction.details.payoutTotals and transaction.details.totals
• Added origin query parameter to list transactions, see related changelog.

---

0.2.3 - 2023-12-12

Added

• Added eventTypes.list() to list all event types
• Added notificationSettings.list() to list all notification settings
• Added notificationSettings.create() to create a notification settings
• Added notificationSettings.get() to get a notification settings
• Added notificationSettings.update() to update a notification settings
• Added notificationSettings.delete() to delete a notification settings
• Added notifications.list() to list all notifications
• Added notifications.get() to get a notification
• Added notifications.replay() to replay a notification
• Added notifications.getLogs() to get all logs for a notification

Fixed

• Fixed incorrect type of action in subscriptions.scheduled_change

---

0.2.2 - 2023-12-01

Added

• Added events.list() to list all events
• Added helper function paddle.webhooks.unmarshal to validate and parse webhook events

---

0.2.1 - 2023-11-29

Added

• Added helper function to archive supported entities
• Added pricingPreview.preview() to preview calculations for one or more prices

Changed

• Breaking change: Converted all list operations to be synchronous. They did not have any async operation within them, and it was incorrectly typed to return a Promise.

---

0.2.0 - 2023-11-28

Breaking changes: This version includes major improvements that introduce breaking changes. These are called out below.

Added

• Added lodash as a dependency.
• Added customData to discount entity, see: related changelog.
• Added name to price entity, see related changelog.
• Added importMeta to product and price entities.

Fixed

• Fixed list credit balances for a customer response entity.
• Fixed adjustments array in next_transaction object in subscription entity.

Changed

• Breaking change: Converted all properties from snake_case to camelCase. This matches JavaScript conventions for field names.

Removed

• Breaking change: Removed toJson function from all entities.

---

0.1.8 - 2023-11-24

Added

• Added transactions.preview() to preview a transaction operation.

---

0.1.7 - 2023-11-23

Added

• Added changelog.

---

0.1.6 - 2023-11-22

Fixed

• Fixed optional management URL object in subscription entities.

---

0.1.5 - 2023-11-14

Added

• Added transactions.getInvoicePDF() for the get a PDF invoice for a transaction operation.
• Enabled request and response logging.

---

0.1.4 - 2023-11-09

Removed

• Removed unused dependency lodash.

---

0.1.3 - 2023-11-08

Fixed

• Added missing query parameters for the list transactions operation.

---

0.1.2 - 2023-11-06

Fixed

• Fixed incorrect update subscription request body TypeScript definition.

---

0.1.1 - 2023-11-06

Added

• Added customers.getCreditBalance() for the list credit balances for a customer operation.
• Added subscriptions.previewUpdate() for the preview an update to a subscription operation.
• Added subscriptions.activate() for the activate a trialing subscription operation.
• Added subscriptions.pause() for the pause a subscription operation.
• Added subscriptions.resume() for the resume a paused subscription operation.
• Added subscriptions.cancel() for the cancel a subscription operation.
• Added subscriptions.createOneTimeCharge() for the create a one-time charge for a subscription operation.
• Added subscriptions.previewOneTimeCharge() for the preview a one-time charge for a subscription operation.
• Added subscriptions.getPaymentMethodChangeTransaction() for the get a transaction to update payment method operation.

---

0.1.0 - 2023-11-03

Added

• Initial early access release. Added support for the most frequently used Paddle Billing entities and API operations. Check the README for more information.