- Added:
grantPromotionalEntitlementsGroupor granting a promotional entitlements group - all entitlements that are not already granted to a customer, need to be included in the request. - Added:
revokePromotionalEntitlementsGroupfor revoking all of the entitlements of a group, unless they are a part of a different group. - Added:
unlinkPromotionalEntitlementsGroupfor removing the references of the group from promotional entitlements that are a part of it, while keep granting access to those entitlements.
- Added:
CancelSubscription.awaitSubscriptionCancellationfor controlling whether to wait for confirmation from billing solutions that are integrated with Stigg before marking subscription as canceled in Stigg
- Added:
SubscriptionBillingInfo.prorationBehaviorfor 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:
getSubscriptionsendpoint that allows retrieving all of customers’ subscriptions
- Added:
SubscriptionFragmentLatestInvoice.attemptCount
- Added:
ImportSubscriptionInput.subscriptionId
- Added:
importSubscriptionInput.salesforceId,importCustomerInput.salesforceId
- Added:
GetUsageHistoryV2 - ⚠️ Deprecated:
GetUsageHistory(please useGetUsageHistoryV2instead) - Changed:
- Input Object:
customerRefIdrenamed tocustomerIdresourceRefIdrenamed toresourceIdfeatureRefIdrenamed tofeatureIdresetPeriodremovedyearlyResetPeriodConfigurationremovedmonthlyResetPeriodConfigurationremovedweeklyResetPeriodConfigurationremoved
- Output Object
startDateremovedendDateremovedusageMeasurements[i].daterenamed toseries[0].point[i].timestampusageMeasurements[i].valuerenamed toseries[0].point[i].valueusageMeasurements[i].isResetPointrenamed toseries[0].point[i].isResetPoint- Old Value:
trueif and only if usage was reset due to periodic reset. - New Value:
trueif and only if usage was reset due to periodic reset or due to a plan transition.
- Old Value:
groups[i].groupInfo[j].keyrenamed toseries[i].tags[j].keygroups[i].groupInfo[j].valuerenamed toseries[i].tags[j].valuegroups[i].usageMeasurements[j].daterenamed toseries[i].point[j].timestampgroups[i].usageMeasurements[j].valuerenamed toseries[i].point[j].valuegroups[i].usageMeasurements[j].isResetPointrenamed toseries[i].point[j].isResetPoint- Old Value:
trueif and only if usage was reset due to periodic reset. - New Value:
trueif and only if usage was reset due to periodic reset or due to a plan transition.
- Old Value:
- Input Object:
- Added:
getActiveSubscriptionsList_trialConfigurationandgetActiveSubscriptionsList_trialConfiguration_trialEndDate
- Added: ability to override prices when there’s a scheduled update in place
- Added:
TrialConfigurationtogetActiveSubscriptions()
- Added: validation that coupon name does not exceed 40 characters
- Added:
SubscriptionCoupon.amountsOff - Added:
SubscriptionCoupon.description - Added:
SubscriptionCoupon.durationInMonths - Added:
SubscriptionCoupon.name - Added:
SubscriptionCoupon.percentOff
- Added:
EstimateSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior - Added:
PreviewSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior
- Added:
EstimateSubscriptionInput.TrialOverrideConfigurationInput.trialEndDate - Added:
PreviewSubscriptionInput.TrialOverrideConfigurationInput.trialEndDate
- Added: support for price localization in fixed fee coupons
- Added: Ability to remove customer’s email address by passing an empty string on
updateCustomer.email
- Added:
DelegateSubscriptionToCustomer() - Added:
TransferSubscriptionToResource() - ⚠️ Deprecated:
TransferSubscriptin()method (please useTransferSubscriptionToResource()instead)
- Added:
UsageHistoryFragment.Markersto reflect information about the reset usage dates
- Fixed: issue where
customer.discount.deletedevent from Stripe isn’t handled properly
- Added: Edge support for
GetActiveSubscriptionsListQuery
- Added: ability to set any date in the
SubscriptionFragment.trial_end_date
- Added: ability to estimate the subscription cost when the payment of the subscription is delegated to a different customer using:
ProvisionSubscriptionInput.payingCustomerIdUpdateSubscriptionInput.payingCustomerIdApplySubscriptionInput.payingCustomerIdPreviewSubscriptionInput.payingCustomerIdEstimateSubscriptionInput.payingCustomerIdEstimateSubscriptionUpdateInput.payingCustomerId
- Added: throw error when sync to Stripe fails due to unrecognized customer billing address
- Added: ability to more easily determine the usage period of metered entitlements using:
Entitlement.usagePeriodStartEntitlement.usagePeriodEnd
- ⚠️ Deprecated:
Entitlement.nextResetDatefield
- Added: throw error when attempting to import a customer with an existing
billingId
- Added:
CustomerPortalSubscriptionFragment.planId
- Added:
SubscriptionCouponInput.billingCouponId - ⚠️ Deprecated:
ProvisionSubscriptionInput.promotionCode - ⚠️ Deprecated:
UpdateSubscriptionInput.promotionCode - ⚠️ Deprecated:
ApplySubscriptionInput.promotionCode - ⚠️ Deprecated:
PreviewSubscriptionInput.promotionCode - ⚠️ Deprecated:
EstimateSubscriptionInput.promotionCode - ⚠️ Deprecated:
EstimateSubscriptionUpdateInput.promotionCode
- Added: ability to delegate payment of a provisioned subscription to a different customer using:
ProvisionSubscriptionInput.payingCustomerIdApplySubscriptionInput.payingCustomerIdSlimSubscriptionFragmentV2.payingCustomerFullSubscription.payingCustomer
- Added: ability to apply a coupon to a subscription using the Stigg coupon ID using:
ProvisionSubscriptionInput.appliedCouponUpdateSubscriptionInput.appliedCouponApplySubscriptionInput.appliedCouponPreviewSubscriptionInput.appliedCouponEstimateSubscriptionInput.appliedCouponEstimateSubscriptionUpdateInput.appliedCoupon
- Changed:
ImportCustomerBulkchanged toImportCustomerBulkInput
- Added: ability to undo subscription scheduled cancelation using
CancelSubscriptionUpdates()
- Added: ability to preview a subscription’s upcoming invoice using
PreviewNextInvoice()
- Changed:
GetUsageHistory()now returns the precise timestamp when the usage was reset
- Changed:
UpdateSubscriptionInput.subscriptionEntitlementsdoes not require the full list of entitlements when needing to add or update specific entitlements
- Added:
TrialOverrideConfigurationInput.trialEndDateto allow scheduled trial cancelation when provisioning and updating subscriptions
- Added: ability to get the list of active subscriptions from Edge using
GetActiveSubscriptionsList()
- Added: ability to get the list of active subscriptions using
GetActiveSubscriptions()
🛑 Breaking change
- Changed: For Volume/tiered pricing,
unitPricewas moved toflatPrice.
