Node.js SDK

• Breaking change: Entitlements retrieval logic now correctly identifies the underlying cause for missing entitlements — whether due to no active subscription, a missing customer, or no assigned entitlements.
• Note: If using a Persistent Caching Service, it must be updated before upgrading the Sidecar to ensure data integrity.

​

Migration steps

1. Upgrade the Persistent Caching Service image to version 2.40.1 or later.
2. Upgrade the Node SDK to version 4.0.0 or later.

• Updated SDK to prevent dependency on compromised NPM packages

• Added: grantPromotionalEntitlementsGroup or granting a promotional entitlements group - all entitlements that are not already granted to a customer, need to be included in the request.
• Added: revokePromotionalEntitlementsGroup for revoking all of the entitlements of a group, unless they are a part of a different group.
• Added: unlinkPromotionalEntitlementsGroup for removing the references of the group from promotional entitlements that are a part of it, while keep granting access to those entitlements.

• Added: CancelSubscription.awaitSubscriptionCancellation for controlling whether to wait for confirmation from billing solutions that are integrated with Stigg before marking subscription as canceled in Stigg

• Added: AccessDeniedReason.Revoked for determining when an entitlement has been explicitly revoked.

• Added: getEntitlement method - a unified way to check any type of feature entitlement (boolean, numeric, or metered) that automatically returns the appropriate entitlement type based on the feature configuration

• Added: SubscriptionBillingInfo.prorationBehavior for controlling the proration behavior when provisioning and updating subscriptions. The new parameter accepts the following value
• CREATE_PRORATIONS - bill for proration immediately. This is the default behavior.
• INVOICE_IMMEDIATELY - include prorated charges in the upcoming invoice.
• NONE - don’t prorate subscription changes.

• Added: getSubscriptions endpoint that allows retrieving all of customers’ subscriptions

• Added: SubscriptionInvoiceFragment.attemptCount

• Added: Ability to pass taxId on updateCustomer.billingInfo.taxIds

• Added: salesforceId to provisionCustomer, updateCustomer , provisionSubscription, importCustomerBulk and importSubscriptionBulk

• Added: offline mode

• Added: SubscriptionCouponDiscountInput.amounts_off
• Added: SubscriptionCouponDiscountInput.description
• Added: SubscriptionCouponDiscountInput.duration_in_months
• Added: SubscriptionCouponDiscountInput.name
• Added: SubscriptionCouponDiscountInput.percent_off

• Added: getUsageHistoryV2
• ⚠️ Deprecated: fetchUsageHistory(please use getUsageHistoryV2 instead)
• Changed:
  • Input Object
    • New field - groupBy list of dimensions to group usage history by.
  • Output Object
    • result[i].date renamed to series[0].point[i].timestamp
    • result[i].value renamed to series[0].point[i].value
    • result[i].isResetPoint renamed to series[0].point[i].isResetPoint
      • Old Value: true if and only if usage was reset due to periodic reset.
      • New Value: true if and only if usage was reset due to periodic reset or due to a plan transition.
    • New field markers - array of markers for usage reset reason (periodic change / plan transition)

• Added: ability to override prices when there’s a scheduled update in place

• Added: provisionSubscription.priceOverrides
• Added: applySubscription.priceOverrides

• Added: support for price localization in fixed fee coupons

• Added: delegateSubscriptionToCustomer()
• Added: transferSubscriptionToResource()
• 🟡 Deprecated: transferSubscription() method (please use transferSubscriptionToResource() instead)

• Fixed: when access to entitlement was denied due to the reaching of a budget cap, getMeteredEntitlements returned AccessDeniedReason.UNSPECIFIED instead of AccessDeniedReason.BudgetExceeded.

• Added: ability to estimate the subscription cost when the payment of the subscription is delegated to a different customer using:
  • previewSubscription.payingCustomerId,
  • estimateSubscription.payingCustomerId
  • estimateSubscriptionUpdate.payingCustomerId

• Added: ability to more easily determine the usage period of metered entitlements using:
  • Entitlement.usagePeriodStart
  • Entitlement.usagePeriodEnd
• 🟡 Deprecated: Entitlement.nextResetDate field

• Added: ability to delegate payment of a provisioned subscription to a different customer using:
  • provisionSubscription.payingCustomerId
  • applySubscription.payingCustomerId
  • SlimSubscriptionFragmentV2Fragment.payingCustomer
  • FullSubscription.payingCustomer

• Added: ability to apply a coupon to a subscription using the Stigg coupon ID using:
  • provisionSubscription.appliedCoupon
  • applySubscription.appliedCoupon
  • updateSubscription.appliedCoupon
  • previewSubscription.appliedCoupon
  • estimateSubscription.appliedCoupon
  • estimateSubscriptionUpdate.appliedCoupon

• Changed: UpdateSubscription.subscriptionEntitlements does not require the full list of entitlements when only needing to add or update specific entitlements

• Bug fixes

• Bug fixes

• Added: ability to get the list of active subscriptions from Edge using getActiveSubscriptionsList()

• Added: ability to get the details of a specific subscription using getSubscription()

• Added: ability to ignore customer and subscriptions that have been updated since the last import by passing ImportCustomer.updatedAt and ImportSubscriptionInput.updatedAt

• Added: ability to provision backdated subscriptions usingSubscriptionBillingInfo.isBackdated

• Added: ability to determine the billing period of a specific price usingPrice.billingCadence

• Added: ability to determine customer’s AWS Marketplace ID using SlimCustomer.awsMarketplaceCustomerId

• Added: ability to remove a payment method from a customer using detachCustomerPaymentMehod()

• Added: ability to get plans that are not visible to customers usingGetPaywall.includeHiddenPlans