Backend SDKs
Node.js SDK
- Added:
SubscriptionInvoiceFragment.attemptCount
- Added: Ability to pass taxId on
updateCustomer.billingInfo.taxIds
- Added:
salesforceId
toprovisionCustomer
,updateCustomer
,provisionSubscription
,importCustomerBulk
andimportSubscriptionBulk
- Added: offline mode
Coupon discount changes:
- Added:
SubscriptionCouponDiscountInput.amounts_off
- Added:
SubscriptionCouponDiscountInput.description
- Added:
SubscriptionCouponDiscountInput.duration_in_months
- Added:
SubscriptionCouponDiscountInput.name
- Added:
SubscriptionCouponDiscountInput.percent_off
Usage history changes:
- Added:
getUsageHistoryV2
- ⚠️ Deprecated:
fetchUsageHistory
(please usegetUsageHistoryV2
instead) - Changed:
- Input Object
- New field -
groupBy
list of dimensions to group usage history by.
- New field -
- Output Object
result[i].date
renamed toseries[0].point[i].timestamp
result[i].value
renamed toseries[0].point[i].value
result[i].isResetPoint
renamed toseries[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.
- Old Value:
- New field
markers
- array of markers for usage reset reason (periodic change / plan transition)
- Input Object
- 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 usetransferSubscriptionToResource()
instead)
- Fixed: when access to entitlement was denied due to the reaching of a budget cap,
getMeteredEntitlements
returnedAccessDeniedReason.UNSPECIFIED
instead ofAccessDeniedReason.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
andImportSubscriptionInput.updatedAt
- Added: ability to provision backdated subscriptions using
SubscriptionBillingInfo.isBackdated
- Added: ability to determine the billing period of a specific price using
Price.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 using
GetPaywall.includeHiddenPlans