Class PaddleSDK

constructor

• new PaddleSDK(
      vendorID: string,
      apiKey: string,
      publicKey?: string,
      options?: Options,
  ): PaddleSDK

  Parameters

  • vendorID: string

    The vendor ID for a Paddle account

  • apiKey: string

    The API key for a Paddle account

  • OptionalpublicKey: string

    The public key for a Paddle account used to verify webhooks, only required for verifyWebhookData

  • Optionaloptions: Options

  Returns PaddleSDK

  Example

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

apiKey

Optionaloptions

publicKey

vendorID

cancelSubscription

• cancelSubscription(subscriptionID: number): Promise<boolean>

  Cancels an active subscription.

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

  Parameters

  • subscriptionID: number

  Returns Promise<boolean>

  Example

  const result = await client.cancelSubscription(123);
  Copy

createOneOffCharge

• createOneOffCharge(
      subscriptionID: number,
      amount: number,
      chargeName: string,
  ): Promise<CreateOneOffChargeResponse>

  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

  Parameters

  • subscriptionID: number
  • amount: number
  • chargeName: string

  Returns Promise<CreateOneOffChargeResponse>

  Example

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

createSubscriptionModifier

• createSubscriptionModifier(
      subscriptionID: number,
      amount: number,
      options?: { description?: string; recurring?: boolean },
  ): Promise<CreateSubscriptionModifierResponse>

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

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

  Parameters

  • subscriptionID: number
  • amount: number
  • Optionaloptions: { description?: string; recurring?: boolean }

  Returns Promise<CreateSubscriptionModifierResponse>

  Example

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

deleteSubscriptionModifier

• deleteSubscriptionModifier(modifierId: number): Promise<true>

  Delete an existing subscription modifier.

  API documentation: https://developer.paddle.com/classic/api-reference/dcdd0db5b20a1-delete-modifier

  Parameters

  • modifierId: number

  Returns Promise<true>

  Example

  const result = await client.deleteSubscriptionModifier(123);
  Copy

generatePayLink

• generatePayLink(body: GeneratePaylinkBody): Promise<GeneratePaylinkResponse>

  Generate a custom pay link.

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

  Parameters

  • body: GeneratePaylinkBody

  Returns Promise<GeneratePaylinkResponse>

  Example

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

getCheckoutTransactions

• getCheckoutTransactions(
      checkoutID: string,
      page?: number,
  ): Promise<GetTransactionsResponse>

  Get the list of transactions for a checkout.

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

  Parameters

  • checkoutID: string
  • Optionalpage: number

  Returns Promise<GetTransactionsResponse>

  Example

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

getOrderDetails

• getOrderDetails(checkoutID: string): Promise<unknown>

  Get information about an order after a transaction completes.

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

  Parameters

  • checkoutID: string

  Returns Promise<unknown>

  Example

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

getOrderTransactions

• getOrderTransactions(
      orderID: number,
      page?: number,
  ): Promise<GetTransactionsResponse>

  Get the list of transactions for an order.

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

  Parameters

  • orderID: number
  • Optionalpage: number

  Returns Promise<GetTransactionsResponse>

  Example

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

getPrices

• getPrices(
      productIDs: number[],
      options?: {
          coupons?: string[];
          customerCountry?: string;
          customerIp?: string;
      },
  ): Promise<GetPricesResponse>

  Get prices

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

  Parameters

  • productIDs: number[]
  • Optionaloptions: { coupons?: string[]; customerCountry?: string; customerIp?: string }

  Returns Promise<GetPricesResponse>

  Example

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

getProductCoupons

• getProductCoupons(productID: number): Promise<GetProductCouponsResponse>

  Get the current list of coupons for a product.

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

  Parameters

  • productID: number

  Returns Promise<GetProductCouponsResponse>

  Example

  const coupons = await client.getProductCoupons(123);
  Copy

getProducts

• getProducts(): Promise<GetProductsResponse>

  Get the current list of products.

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

  Returns Promise<GetProductsResponse>

  Example

  const products = await client.getProducts();
  Copy

getProductTransactions

• getProductTransactions(
      productID: number,
      page?: number,
  ): Promise<GetTransactionsResponse>

  Get the list of transactions for a product.

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

  Parameters

  • productID: number
  • Optionalpage: number

  Returns Promise<GetTransactionsResponse>

  Example

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

getSubscriptionModifiers

• getSubscriptionModifiers(
      options?: { planID?: number; subscriptionID?: number },
  ): Promise<GetSubscriptionModifiersResponse>

  Get subscription modifiers.

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

  Parameters

  • Optionaloptions: { planID?: number; subscriptionID?: number }

  Returns Promise<GetSubscriptionModifiersResponse>

  Example

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

getSubscriptionPayments

• getSubscriptionPayments(
      options?:
          | number
          | {
              from?: Date;
              isOneOffCharge?: boolean;
              isPaid?: boolean;
              planID?: number;
              subscriptionID?: number;
              to?: Date;
          },
  ): Promise<GetSubscriptionPaymentsResponse>

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

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

  Parameters

  • Optionaloptions:
        | number
        | {
            from?: Date;
            isOneOffCharge?: boolean;
            isPaid?: boolean;
            planID?: number;
            subscriptionID?: number;
            to?: Date;
        }

  Returns Promise<GetSubscriptionPaymentsResponse>

  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);
  Copy

getSubscriptionPlan

• getSubscriptionPlan(planID: number): Promise<SubscriptionPlan>

  Get the plan based on its ID.

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

  Parameters

  • planID: number

  Returns Promise<SubscriptionPlan>

  Example

  const plan = await client.getSubscriptionPlan(123);
  Copy

getSubscriptionPlans

• getSubscriptionPlans(): Promise<GetSubscriptionPlansResponse>

  Get a list of all the available subscription plans.

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

  Returns Promise<GetSubscriptionPlansResponse>

  Example

  const plans = await client.getSubscriptionPlans();
  Copy

getSubscriptionTransactions

• getSubscriptionTransactions(
      subscriptionID: number,
      page?: number,
  ): Promise<GetTransactionsResponse>

  Get the list of transactions for a subscription.

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

  = *

  Parameters

  • subscriptionID: number
  • Optionalpage: number

  Returns Promise<GetTransactionsResponse>

  Example

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

getUsers

• getUsers(
      options?: {
          page?: number;
          planID?: string | number;
          resultsPerPage?: number;
          state?: SubscriptionUserState;
          subscriptionID?: number;
      },
  ): Promise<GetSubscriptionUsersResponse>

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

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

  Parameters

  • Optionaloptions: {
        page?: number;
        planID?: string | number;
        resultsPerPage?: number;
        state?: SubscriptionUserState;
        subscriptionID?: number;
    }

  Returns Promise<GetSubscriptionUsersResponse>

  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 });
  Copy

  Note

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

getUserTransactions

• getUserTransactions(
      userID: number,
      page?: number,
  ): Promise<GetTransactionsResponse>

  Get the list of transactions for a user.

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

  Parameters

  • userID: number
  • Optionalpage: number

  Returns Promise<GetTransactionsResponse>

  Example

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

getWebhooksHistory

• getWebhooksHistory(): Promise<GetWebhookHistoryResponse>

  Get the list of latest webhooks history.

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

  Returns Promise<GetWebhookHistoryResponse>

  Example

  const webhooksHistory = await client.getWebhooksHistory();
  Copy

reschedulePayment

• reschedulePayment(paymentID: number, date: Date): Promise<boolean>

  Change the due date of an upcoming subscription payment.

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

  Parameters

  • paymentID: number
  • date: Date

  Returns Promise<boolean>

  Example

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

serverURL

• serverURL(checkoutAPIVersion?: CheckoutAPIVersion): string

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

  Parameters

  • OptionalcheckoutAPIVersion: CheckoutAPIVersion

  Returns string

updateSubscription

• updateSubscription(
      subscriptionID: number,
      postData: {
          billImmediately?: boolean;
          currency?: string;
          keepModifiers?: boolean;
          passthrough?: string;
          pause?: boolean;
          planID?: number;
          price?: number;
          prorate?: boolean;
          quantity?: number;
      },
  ): Promise<UpdateSubscriptionUserResponse>

  Update subscription details, quantity, price and or currency.

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

  Parameters

  • subscriptionID: number
  • postData: {
        billImmediately?: boolean;
        currency?: string;
        keepModifiers?: boolean;
        passthrough?: string;
        pause?: boolean;
        planID?: number;
        price?: number;
        prorate?: boolean;
        quantity?: number;
    }

  Returns Promise<UpdateSubscriptionUserResponse>

  Example

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

verifyWebhookData

• verifyWebhookData(
      postData: { p_signature: string } & Record<string, unknown>,
  ): boolean

  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

  Parameters

  • postData: { p_signature: string } & Record<string, unknown>

    The object with all the parameters sent to the webhook

  Returns boolean

  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);
  Copy