- 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:
AccessDeniedReason.Revokedfor determining when an entitlement has been explicitly revoked.
- 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:
SubscriptionInvoiceFragment.attempt_count
- Added:
ImportSubscriptionInput.subscription_id
- Added:
importSubscriptionInput.salesforce_id,importCustomerInput.salesforce_id
- Added:
get_usage_history_v_2 - ⚠️ Deprecated:
get_usage_history(please useget_usage_history_v_2instead) - Changed:
- Input Object:
customer_ref_idrenamed tocustomer_idresource_ref_idrenamed toresource_idfeature_ref_idrenamed tofeature_idreset_periodremovedyearly_reset_period_configurationremovedmonthly_reset_period_configurationremovedweekly_reset_period_configurationremoved
- Output Object
start_dateremovedend_dateremovedusage.measurements[i].daterenamed toseries[0].point[i].timestampusage.measurements[i].valuerenamed toseries[0].point[i].valueusage.measurements[i].is_reset_pointrenamed toseries[0].point[i].is_reset_point- 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].group_info[j].keyrenamed toseries[i].tags[j].keygroups[i].group_info[j].valuerenamed toseries[i].tags[j].valuegroups[i].usage_measurements[j].daterenamed toseries[i].point[j].timestampgroups[i].usage_measurements[j].valuerenamed toseries[i].point[j].valuegroups[i].usage_measurements[j].is_reset_pointrenamed toseries[i].point[j].is_reset_point- 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:
SlimSubscriptionFragmentV2.trial_configurationandSlimSubscriptionFragmentV2.trial_end_date
- 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:
SubscriptionCouponDiscountInput.amounts_off - Added:
SubscriptionCouponDiscountInput.description - Added:
SubscriptionCouponDiscountInput.duration_in_months - Added:
SubscriptionCouponDiscountInput.name - Added:
SubscriptionCouponDiscountInput.percent_off
- Added:
EstimateSubscriptionInput.TrialOverrideConfigurationInput.trial_end_behavior - Added:
PreviewSubscriptionInput.TrialOverrideConfigurationInput.trial_end_behavior
- Added:
EstimateSubscriptionInput.TrialOverrideConfigurationInput.trial_end_date - Added:
PreviewSubscriptionInput.TrialOverrideConfigurationInput.trial_end_date
- Added: support for price localization in fixed fee coupons
- Added: Ability to remove customer’s email address by passing an empty string on
updateCustomerInput.email
- Added:
delegate_subscription_to_customer() - Added:
transfer_subscription_to_resource() - ⚠️ Deprecated:
transfer_subscription()method (please usetransfer_subscription_to_resource()instead)
- Added:
UsageHistoryFragment.Markersto reflect information about the reset usage dates
- Fixed: issue where
customer.discount.deletedevent from Stripe isn’t handled properly
- Added: ability to set any date in the
SubscriptionFragment.trialEndDate
- Added: ability to estimate the subscription cost when the payment of the subscription is delegated to a different customer using:
ProvisionSubscriptionInput.paying_customer_idUpdateSubscriptionInput.paying_customer_idApplySubscriptionInput.paying_customer_idPreviewSubscriptionInput.paying_customer_idEstimateSubscriptionInput.paying_customer_idEstimateSubscriptionUpdateInput.paying_customer_id
- Added: raise 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:
EntitlementFragment.usage_period_startEntitlementFragment.usage_period_end
- ⚠️ Deprecated:
Entitlement.nextResetDatefield
- Added: raise error when attempting to import a customer with an existing
billing_id
- Added:
CustomerPortalSubscriptionFragment.plan_id
- Added:
SubscriptionCouponInput.billing_coupon_id - ⚠️ Deprecated:
ProvisionSubscriptionInput.promotion_code - ⚠️ Deprecated:
UpdateSubscriptionInput.promotion_code - ⚠️ Deprecated:
ApplySubscriptionInput.promotion_code - ⚠️ Deprecated:
PreviewSubscriptionInput.promotion_code - ⚠️ Deprecated:
EstimateSubscriptionInput.promotion_code - ⚠️ Deprecated:
EstimateSubscriptionUpdateInput.promotion_code
- Added: ability to delegate payment of a provisioned subscription to a different customer using:
ProvisionSubscriptionInput.paying_customer_idApplySubscriptionInput.paying_customer_idSlimSubscriptionFragmentV2.payingCustomerFullSubscription.payingCustomer
- Added: ability to apply a coupon to a subscription using the Stigg coupon ID using:
ProvisionSubscriptionInput.applied_couponUpdateSubscriptionInput.applied_couponApplySubscriptionInput.applied_couponPreviewSubscriptionInput.applied_couponEstimateSubscriptionInput.applied_couponEstimateSubscriptionUpdateInput.applied_coupon
- Changed:
ImportCustomerBulkchanged toImportCustomerBulkInput
- Added: ability to undo subscription scheduled cancelation using
cancel_subscription_updates()
- Added: ability to preview a subscription’s upcoming invoice using
preview_next_invoice()
- Changed:
fetch_usage_history()now returns the precise timestamp when the usage was reset
- Changed:
UpdateSubscriptionInput.subscription_entitlementsdoes not require the full list of entitlements when needing to add or update specific entitlements
- Added:
TrialOverrideConfigurationInput.trial_end_dateto allow scheduled trial cancelation when provisioning and updating subscriptions
- Added: ability to get the list of active subscriptions from Edge using
get_active_subscriptions_list()
- Added: ability to get the list of active subscriptions using
get_active_subscriptions()
🛑 Breaking change
- Changed: For Volume/tiered pricing,
unit_pricewas moved toflat_price.