JavaScript SDK

​

Credit isFallback: telling “no data” from “not entitled”

const noEntitlementReasons = [
  AccessDeniedReason.EntitlementNotFound,
  AccessDeniedReason.CustomerNotFound,
  AccessDeniedReason.CustomerResourceNotFound,
  AccessDeniedReason.NoActiveSubscription,
  AccessDeniedReason.CustomerIsArchived,
];
const hasBalanceData =
  !entitlement.isFallback &&
  (entitlement.accessDeniedReason == null ||
    !noEntitlementReasons.includes(entitlement.accessDeniedReason));

• Added: hasSoftLimit field on CreditEntitlement. When a credit entitlement is configured as a soft limit, getEntitlement() returns hasAccess: true and hasSoftLimit: true even after the credit balance reaches zero. Hard limit (the default) continues to return hasAccess: false when the balance is exhausted. Credit-backed features inherit the wallet’s soft-limit so dependent feature reads stay consistent.

• Added: billingCycleAnchor property when provisioning and updating subscriptions. Accepts SubscriptionBillingCycleAnchor.UNCHANGED (default) to keep the existing billing cycle anchor, or SubscriptionBillingCycleAnchor.NOW to reset it to the current timestamp.

• Deprecated: getCreditBalance() (please use getCreditEntitlement() instead). getCreditEntitlement() reads directly from the SDK’s local cache, significantly reducing latency and removing rate-limit concerns. It returns the same data: currentBalance, totalConsumed, totalGranted, and currency.

• Added: getCreditEntitlement() method for low-latency retrieval of customer credit balance.
• Added: Support for provisioning subscriptions with variable recurring credit grant entitlements.

• Enhanced getCreditEntitlement to return currency information.

• Added: Support for configuring and managing credit auto-recharge settings, including trigger balance, target top-up amount, and monthly spend limit.

• Added support for subscriptions filter by resourceId and plan (planId/displayName).

• Updated SDK to prevent dependency on compromised NPM packages

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

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

• Added: ability to determine the number of attempts that were made to collect payment for a generated invoice when Stigg is integrated with Stripe using the latestInvoice.attemptCount property of the getActiveSubscriptions() and getSubscription() endpoints

• Added: support for offline mode

• Added: GetUsageHistoryV2
• ⚠️ Deprecated: GetUsageHistory(please use GetUsageHistoryV2 instead)
• Changed:
  • Input Object:
    • customerRefId renamed to customerId
    • resourceRefId renamed to resourceId
    • featureRefId renamed to featureId
    • resetPeriod removed
    • yearlyResetPeriodConfiguration removed
    • monthlyResetPeriodConfiguration removed
    • weeklyResetPeriodConfiguration removed
  • Output Object
    • startDate removed
    • endDate removed
    • usageMeasurements[i].date renamed to series[0].point[i].timestamp
    • usageMeasurements[i].value renamed to series[0].point[i].value
    • usageMeasurements[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.
    • groups[i].groupInfo[j].key renamed to series[i].tags[j].key
    • groups[i].groupInfo[j].value renamed to series[i].tags[j].value
    • groups[i].usageMeasurements[j].date renamed to series[i].point[j].timestamp
    • groups[i].usageMeasurements[j].value renamed to series[i].point[j].value
    • groups[i].usageMeasurements[j].isResetPoint renamed to series[i].point[j].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.

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

• Added: support for price localization in fixed fee coupons

• 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:
  • MeteredEntitlement.usagePeriodStart
  • MeteredEntitlement.usagePeriodEnd
• 🛑 Removed: MeteredEntitlement.nextResetDate

• 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()