Backend SDKs
Java SDK
- Added:
SubscriptionFragmentLatestInvoice.attemptCount
- Added:
ImportSubscriptionInput.subscriptionId
- Added:
importSubscriptionInput.salesforceId
,importCustomerInput.salesforceId
- Added:
GetUsageHistoryV2
- ⚠️ Deprecated:
GetUsageHistory
(please useGetUsageHistoryV2
instead) - Changed:
- Input Object:
customerRefId
renamed tocustomerId
resourceRefId
renamed toresourceId
featureRefId
renamed tofeatureId
resetPeriod
removedyearlyResetPeriodConfiguration
removedmonthlyResetPeriodConfiguration
removedweeklyResetPeriodConfiguration
removed
- Output Object
startDate
removedendDate
removedusageMeasurements[i].date
renamed toseries[0].point[i].timestamp
usageMeasurements[i].value
renamed toseries[0].point[i].value
usageMeasurements[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:
groups[i].groupInfo[j].key
renamed toseries[i].tags[j].key
groups[i].groupInfo[j].value
renamed toseries[i].tags[j].value
groups[i].usageMeasurements[j].date
renamed toseries[i].point[j].timestamp
groups[i].usageMeasurements[j].value
renamed toseries[i].point[j].value
groups[i].usageMeasurements[j].isResetPoint
renamed toseries[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.
- Old Value:
- Input Object:
- Added:
getActiveSubscriptionsList_trialConfiguration
andgetActiveSubscriptionsList_trialConfiguration_trialEndDate
- Added: ability to override prices when there’s a scheduled update in place
- Added:
TrialConfiguration
togetActiveSubscriptions()
- 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.Markers
to reflect information about the reset usage dates
- Fixed: issue where
customer.discount.deleted
event 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.payingCustomerId
UpdateSubscriptionInput.payingCustomerId
ApplySubscriptionInput.payingCustomerId
PreviewSubscriptionInput.payingCustomerId
EstimateSubscriptionInput.payingCustomerId
EstimateSubscriptionUpdateInput.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.usagePeriodStart
Entitlement.usagePeriodEnd
- ⚠️ Deprecated:
Entitlement.nextResetDate
field
- 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.payingCustomerId
ApplySubscriptionInput.payingCustomerId
SlimSubscriptionFragmentV2.payingCustomer
FullSubscription.payingCustomer
- Added: ability to apply a coupon to a subscription using the Stigg coupon ID using:
ProvisionSubscriptionInput.appliedCoupon
UpdateSubscriptionInput.appliedCoupon
ApplySubscriptionInput.appliedCoupon
PreviewSubscriptionInput.appliedCoupon
EstimateSubscriptionInput.appliedCoupon
EstimateSubscriptionUpdateInput.appliedCoupon
- Changed:
ImportCustomerBulk
changed 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.subscriptionEntitlements
does not require the full list of entitlements when needing to add or update specific entitlements
- Added:
TrialOverrideConfigurationInput.trialEndDate
to 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,
unitPrice
was moved toflatPrice
.