Correct me if I am wrong but I didn't see a refund function in the library implementing this endpoint.

I think it can be a fairly simple refundPayment({orderId, reason, amount}) kind of function. Let me know if you want me to open a PR for it.

Hi, any plans to add methods to list/create/delete price modifiers to the SDK?

https://developer.paddle.com/api-reference/subscription-api/modifiers

Thanks!

Synk scan is showing the following vunerabilities for this package. Axios needs updating.

https://security.snyk.io/vuln/SNYK-JS-AXIOS-6144788

https://security.snyk.io/vuln/SNYK-JS-AXIOS-6124857

Dear @avaly , am I seeing this right that Paddle has a new API which is not compatible with this SDK or am I missing something?

It appears to me that they changed a lot this year (frontend & backend api and sdk) and thus this needs a major overhaul?

If this is the case, do you plan on updating the SDK to the new API?

Cheers,
Chris

I think you should upgrade dependencies 'got' and 'keyv' to latest one.

WARNING in ../node_modules/paddle-sdk/node_modules/got/source/request-as-event-emitter.js 72:18-25
Critical dependency: require function is used in a way in which dependencies cannot be statically extracted
@ ../node_modules/paddle-sdk/node_modules/got/source/as-stream.js
@ ../node_modules/paddle-sdk/node_modules/got/source/create.js
@ ../node_modules/paddle-sdk/node_modules/got/source/index.js
@ ../node_modules/paddle-sdk/sdk.js
@ ../node_modules/babel-loader/lib!../node_modules/vue-loader/lib??vue-loader-options!./components/PopupPage.vue?vue&type=script&lang=js&
@ ./components/PopupPage.vue?vue&type=script&lang=js&
@ ./components/PopupPage.vue
@ ./popup.js

WARNING in ../node_modules/keyv/src/index.js 18:14-40
Critical dependency: the request of a dependency is an expression
@ ../node_modules/paddle-sdk/node_modules/cacheable-request/src/index.js
@ ../node_modules/paddle-sdk/node_modules/got/source/request-as-event-emitter.js
@ ../node_modules/paddle-sdk/node_modules/got/source/as-stream.js
@ ../node_modules/paddle-sdk/node_modules/got/source/create.js
@ ../node_modules/paddle-sdk/node_modules/got/source/index.js
@ ../node_modules/paddle-sdk/sdk.js
@ ../node_modules/babel-loader/lib!../node_modules/vue-loader/lib??vue-loader-options!./components/PopupPage.vue?vue&type=script&lang=js&
@ ./components/PopupPage.vue?vue&type=script&lang=js&
@ ./components/PopupPage.vue
@ ./popup.js

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch [email protected] for the project I'm working on.

Looks like the type for sandbox was incorrect (should be boolean instead of string). I was using sandbox: 'false' which was incorrect because Boolean(false) === true

Here is the diff that solved my problem:

diff --git a/node_modules/paddle-sdk/sdk.d.ts b/node_modules/paddle-sdk/sdk.d.ts
index e8fd3d7..edd2865 100644
--- a/node_modules/paddle-sdk/sdk.d.ts
+++ b/node_modules/paddle-sdk/sdk.d.ts
@@ -7,7 +7,7 @@ declare class PaddleSDK {
      * @param {string} apiKey - The API key for a Paddle account
      * @param {string} [publicKey] - The public key for a Paddle account used to verify webhooks, only required for `verifyWebhookData`
      * @param {object} [options]
-     * @param {string} [options.sandbox=false] - Whether to use the sandbox server URL
+     * @param {boolean} [options.sandbox=false] - Whether to use the sandbox server URL
      * @param {string} [options.server=vendors.paddle.com/api/2.0] - The server URL prefix for all requests
      *
      * @example
@@ -15,7 +15,7 @@ declare class PaddleSDK {
      * const client = new PaddleSDK('your-vendor-id', 'your-unique-api-key', 'your-public-key');
      */
     constructor(vendorID: string, apiKey: string, publicKey?: string, options?: {
-        sandbox?: string;
+        sandbox?: boolean;
         server?: string;
     });
     vendorID: string;

This issue body was partially generated by patch-package.

The SDK is missing the param passthrough on the updateSubscription function. (https://developer.paddle.com/api-reference/e3872343dfbba-update-user#request-body)

This param is very useful when receiving webhooks or looking up the subscription. Important data can be stored inside.

Hello,

From your documentation, it seems that the Update Subscription functionality of Paddle's API is not implemented.

Asking here in case it is implemented, just not documented.

If for some reason you can not implement it, let me know and I'll make a merge request for it.

Cheers

What do you think about adding feature for updating subscription price?

This is how it could be:

 /**
   * Update subscription price
   *
   * @method
   * @param {number} subscriptionID
   * @param {number} price
   * @param {string} currency
   * @param {boolean} immediately
   * @returns {Promise}
   * @fulfill {object} - The result of the operation
   *
   * @example
   * const result = await client.updateSubscriptionPrice(123, 44, 'USD');
   */
  updateSubscriptionPrice (subscriptionID, price, currency, immediately = true) {
    return this._request('/subscription/users/update', {
      body: {
        subscription_id: subscriptionID,
	bill_immediately: immediately,
	prorate: immediately,
      	quantity: 1,
      	recurring_price: price,
      	currency
      }
    });
  }

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore: Replace standard-version with commit-and-tag-version 9.5.0
• chore: Upgrade ts-node to v10.9.2
• chore: Upgrade eslint to v8.57.0
• chore: Upgrade eslint-config-prettier to v8.10.0
• chore: Upgrade lint-staged to v13.3.0
• chore: Upgrade nock to v11.9.1
• chore: Upgrade ts-jest to v29.1.3
• chore: Upgrade typedoc to v0.25.13
• chore: Upgrade typescript to v5.4.5
• chore: Upgrade typescript-eslint monorepo to v5.62.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• chore: Upgrade @types/node to v20
• chore: Upgrade actions/cache action to v4
• chore: Upgrade actions/checkout action to v4
• chore: Upgrade actions/deploy-pages action to v4
• chore: Upgrade actions/setup-node action to v4
• chore: Upgrade actions/upload-pages-artifact action to v3
• chore: Upgrade eslint to v9
• chore: Upgrade eslint-config-prettier to v9
• chore: Upgrade husky to v9
• chore: Upgrade lint-staged to v15
• chore: Upgrade nock to v13
• chore: Upgrade typescript-eslint monorepo to v7 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• 🔐 Create all rate-limited PRs at once 🔐

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

• chore: Upgrade @types/node to v14.18.63
• chore: Upgrade actions/deploy-pages action to v2.0.5
• chore: Upgrade actions/upload-pages-artifact action to v1.0.10
• chore: Upgrade jest monorepo (@types/jest, jest)
• chore: Upgrade prettier to v2.8.8
• chore: Upgrade actions/cache action to v3.3.3
• chore: Upgrade actions/checkout action to v3.6.0
• chore: Upgrade actions/setup-node action to v3.8.2
• chore: Upgrade axios to v1.7.2
• chore: Upgrade prettier to v3

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

I just upgraded to the latest version and got this error:

Error [ERR_REQUIRE_ESM]: require() of ES Module /app/node_modules/.pnpm/[email protected]/node_modules/paddle-sdk/esm/sdk.js from /app/dist/utilities/paddle.js not supported.

I am not asking for a fix, just checking what the intention of the major upgrade is, since the change log doesn't acknowledge dropping of CJS support.

You should implement subscription methods, like update subscription, change plans.

Overview

These boolean fields will never be included in the payload if the value is false.

Suggestion: replace if (billImmediately) with if (billImmediately !== undefined)

Reference:

cancellation_effective_date is always equal to the date when request to cancel subscription was submitted but it should be equal to the end of payment period.
Can it be due to subscription cost is 0$?

Omitting getProductPlans argument fetches all subscirptions