Skip to main content
Version: Node SDK

Changelog

v4.0.0​

Breaking Changes​

  • Salable API versions are now supported and Version is now a required argument upon Salable instantiation. (Currently supports v2)
    • Support for v1 of the Salable API has been deprecated

Licenses​

  • getAll now supports cursor based pagination, licenses can also be filtered by status, subscriptionUuid, planUuid, productUuid, and granteeId
  • getOne and getForGranteeId now offer an expand option to expand certain properties (e.g. plan etc)
  • getForPurchaser no longer offers cancelLink as an option
  • getUsage has been deprecated
  • create and createMany are now seperate methods, status and endTime have been added as optional parameters
  • update method parameters have been changed to have an object as the second parameter, the granteeId property is where the grantee ID value can be assigned
  • cancelMany method parameter has been updated to be an object, the uuids property is where an array of license UUIDs to cancel can be assigned
  • verifyLicenseCheck has been renamed to verify

Plans​

  • getOne now offers an expand option to expand certain properties (e.g. product etc)
  • getCheckoutLink options have now been updated:
    • vat is no longer supported and has been deprecated
    • customer has been deprecated and been replaced with customerId and customerEmail
    • contactUsLink has been deprecated
    • marketingConsent has been deprecated
    • couponCode has been deprecated
    • customMessage has been deprecated
    • automaticTax, changeQuantity, and requirePaymentMethod have been added

Pricing Tables​

  • getOne options have been updated. The only supported options are now granteeId and currency

Products​

  • getOne now offers an expand option to expand certain properties (e.g. plan etc)
  • getPricingTable options have been updated. The only supported options are now granteeId and currency

Subscriptions​

  • getOne now offers an expand option to expand certain properties (e.g. plan etc)
  • getAll method added. Retrieves a list of all subscriptions
  • getInvoices method added. Retrieves a list of invoices for a subscription
  • getSwitchablePlans method added. Retrieves a list of available plans that a subscribed user can switch to
  • getUpdatePaymentLink method added. Retrieves the update payment portal link for a specific subscription
  • getPortalLink method added. Retrieves the customer portal link for a subscription
  • getCancelSubscriptionLink method added. Retrieves the cancel subscription portal link for a specific subscription
  • getPaymentMethod method added. Retrieves the payment method used to pay for a subscription
  • reactivateSubscription method added. Reactivate a Subscription's scheduled cancellation before the billing period has passed
  • updatePlan method has been deprecated
  • addSeats and removeSeats now optionally allow proration as an option

Usage (NEW)​

  • getAllUsageRecords gets all usage records for grantee's metered licenses
  • getCurrentUsageRecord gets current usage record for grantee on plan
  • updateLicenseUsage updates a license's usage

RBAC (DEPRECATED)​

  • All RBAC methods have been deprecated and currently not supported by the SDK

Other Changes​

  • DOCS: JSDoc and SDK documentation have been updated
  • interfaces have been replaced with types
  • 403 and 404 errors now specifically handled

v3.2.0​

Licenses​

  • Added getOne, getForPurchaser, getForGranteeId, getUsage & getCount licenses methods to SDK.

v3.1.0​

Licenses​

  • Added getOne, getForPurchaser, getForGranteeId, getUsage & getCount licenses methods to SDK.

v3.0.0​

Error handling​

  • Added new Error classes SalableResponseError, SalableValidationError and SalableUnknownError
  • New error codes

More information on error handling

v2.8.0​

Subscriptions​

  • Added changePlan subscriptions method to SDK.

Pricing Tables​

  • Added getOne pricing tables method to SDK.

v2.7.0​

Licenses​

  • Added update, updateMany & getCount licenses methods to SDK.

v2.6.0​

Subscriptions​

  • Added addSeats & removeSeats subscription methods to SDK.

v2.5.0​

Features​

  • Added Products (getOne, getCheckoutLink, getFeatures, getCapabilities, getCurrencies) methods to SDK.

v2.4.0​

Features​

  • Added plans (getOne, getCheckoutLink, getFeatures, getCapabilities, getCurrencies) methods to SDK.

Other Changes​

  • DOCS: Updated links to resources object documentation

v2.3.0​

Features​

  • Added URL support in constructor for passing API URL

v2.2.0​

Features​

  • Added cancel subscription method to SDK.

v2.1.0​

Features​

  • Added rbac (permissions, users, roles) methods to SDK.

Other Changes​

  • DOCS: Updated documentation mistakes and inaccuracies

v2.0.0​

Breaking Changes​

  • Top level export SalableApi renamed to Salable
  • getLicenses() renamed to getAll()
  • createLicense() renamed to create()
  • checkLicenses() renamed to check()
  • getSubscription() renamaed to getOne()
  • changePlan() renmaed to updatePlan()
  • updateUsage() renamed to update()

Other Changes​

  • DOCS: JSDoc documentation added to all methods for each class
  • FEAT: Updated internal _request method to support TS Generics for return and argument types
  • CHORE: Restructured repository contents so endpoints aren't contained inside a third-party-api folder.