Class PaddleSDK

Cancels an active subscription.

API documentation: https://developer.paddle.com/api-reference/9b808453c3216-cancel-user

Example

const result = await client.cancelSubscription(123);

Make an immediate one-off charge on top of an existing user subscription

API documentation: https://developer.paddle.com/api-reference/23cf86225523f-create-one-off-charge

Example

const result = await client.createOneOffCharge(123, 10, 'description');

Create a subscription modifier to dynamically change the subscription payment amount.

API documentation: https://developer.paddle.com/api-reference/dc2b0c06f0481-create-modifier

Example

const result = await client.createSubscriptionModifier(123, 10);
const result = await client.createSubscriptionModifier(123, 10, { recurring: false, description: 'description' });

Generate a custom pay link.

API documentation: https://developer.paddle.com/api-reference/3f031a63f6bae-generate-pay-link

Example

const custom = await client.generatePayLink({
  title: 'my custom checkout',
  custom_message: 'some custom message',
  prices: [
     'USD:19.99',
     'EUR:15.99'
   ]
});

Get the list of transactions for a checkout.

API documentation: https://developer.paddle.com/api-reference/89c1805d821c2-list-transactions

Example

const checkoutTransactions = await client.getCheckoutTransactions('123');
const checkoutTransactionsNext = await client.getCheckoutTransactions('123', 2);

Get information about an order after a transaction completes.

API documentation: https://developer.paddle.com/api-reference/fea392d1e2f4f-get-order-details

Example

const result = await client.getOrderDetails('219233-chre53d41f940e0-58aqh94971');

Get the list of transactions for an order.

API documentation: https://developer.paddle.com/api-reference/89c1805d821c2-list-transactions

Example

const orderTransactions = await client.getOrderTransactions(123);
const orderTransactionsNext = await client.getOrderTransactions(123, 2);

Get prices

API documentation: https://developer.paddle.com/api-reference/e268a91845971-get-prices

Example

const result = await client.getPrices([123, 456]);
const result = await client.getPrices([123, 456], { coupons: ['EXAMPLE'], customerCountry: 'GB', customerIp: '127.0.0.1' });

Get the current list of coupons for a product.

API documentation: https://developer.paddle.com/api-reference/6a59b795bd653-list-coupons

Example

const coupons = await client.getProductCoupons(123);

Get the list of transactions for a product.

API documentation: https://developer.paddle.com/api-reference/89c1805d821c2-list-transactions

Example

const productTransactions = await client.getProductTransactions(123);
const productTransactionsNext = await client.getProductTransactions(123, 2);

Get the current list of products.

API documentation: https://developer.paddle.com/api-reference/0f31bd7cbce47-list-products

s *

Example

const products = await client.getProducts();

Get subscription modifiers.

API documentation: https://developer.paddle.com/api-reference/f575ab89eb18c-list-modifiers

Example

const result = await client.getSubscriptionModifiers();
const result = await client.getSubscriptionModifiers({ subscriptionID: 123 });

Get the list of all payments or payments for a subscription plan.

API documentation: https://developer.paddle.com/api-reference/80462f27b2011-list-payments

Example

const payments = await client.getSubscriptionPayments();
const payments = await client.getSubscriptionPayments({ subscriptionID: 123 });
Legacy usage for backwards compatibility: pass planID as a number instead of options object
const payments = await client.getSubscriptionPayments(123);

Get the plan based on its ID.

API documentation: https://developer.paddle.com/api-reference/a835554495295-list-plans

Example

const plan = await client.getSubscriptionPlan(123);

Get a list of all the available subscription plans.

API documentation: https://developer.paddle.com/api-reference/a835554495295-list-plans

Example

const plans = await client.getSubscriptionPlans();

Get the list of transactions for a subscription.

API documentation: https://developer.paddle.com/api-reference/89c1805d821c2-list-transactions

= *

Example

const subscriptionTransactions = await client.getSubscriptionTransactions(123);
const subscriptionTransactionsNext = await client.getSubscriptionTransactions(123, 2);

Get the list of transactions for a user.

API documentation: https://developer.paddle.com/api-reference/89c1805d821c2-list-transactions

Example

const userTransactions = await client.getUserTransactions(123);
const userTransactionsNext = await client.getUserTransactions(123, 2);

Get the current list of all users or users for a subscription plan.

API documentation: https://developer.paddle.com/api-reference/e33e0a714a05d-list-users

Example

const users = await client.getUsers();
const users = await client.getUsers({ planID: 123 });
const users = await client.getUsers({ state: 'active' });
const users = await client.getUsers({ subscriptionID: 456 });

Note

If you have a large amount of active users, you will need to create paginated calls to this function.

Get the list of latest webhooks history.

API documentation: https://developer.paddle.com/api-reference/7695d655c158b-get-webhook-history

Example

const webhooksHistory = await client.getWebhooksHistory();

Change the due date of an upcoming subscription payment.

API documentation: https://developer.paddle.com/api-reference/fe93f28aa7f7e-reschedule-payment

Example

const result = await client.reschedulePayment(123, new Date('2022-12-04'));

Get the used server URL. Some of the requests go to Checkout server, while most will go to Vendor server.

Update subscription details, quantity, price and or currency.

API documentation: https://developer.paddle.com/api-reference/e3872343dfbba-update-user

Example

const result = await client.updateSubscriptionPlan(123, { quantity: 2 });

Verify a webhook alert data using signature and a public key to validate that it was indeed sent from Paddle.

For more details: https://paddle.com/docs/reference-verifying-webhooks

Example

const client = new PaddleSDK('your-vendor-id', 'your-unique-api-key', 'your-public-key');

// inside an Express handler which uses express.bodyParser middleware
const isVerified = client.verifyWebhookData(req.body);