Ruby SDK

• 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 use get_usage_history_v_2 instead)
• Changed:
  • Input Object:
    • customer_ref_id renamed to customer_id
    • resource_ref_id renamed to resource_id
    • feature_ref_id renamed to feature_id
    • reset_period removed
    • yearly_reset_period_configuration removed
    • monthly_reset_period_configuration removed
    • weekly_reset_period_configuration removed
  • Output Object
    • start_date removed
    • end_date removed
    • usage.measurements[i].date renamed to series[0].point[i].timestamp
    • usage.measurements[i].value renamed to series[0].point[i].value
    • usage.measurements[i].is_reset_point renamed to series[0].point[i].is_reset_point
      • 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].group_info[j].key renamed to series[i].tags[j].key
    • groups[i].group_info[j].value renamed to series[i].tags[j].value
    • groups[i].usage_measurements[j].date renamed to series[i].point[j].timestamp
    • groups[i].usage_measurements[j].value renamed to series[i].point[j].value
    • groups[i].usage_measurements[j].is_reset_point renamed to series[i].point[j].is_reset_point
      • 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: SlimSubscriptionFragmentV2.trial_configuration and SlimSubscriptionFragmentV2.trial_end_date

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

• Added: TrialConfiguration to getActiveSubscriptions()

• 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 use transfer_subscription_to_resource() instead)

• Added: UsageHistoryFragment.Markersto reflect information about the reset usage dates

• Fixed: issue where customer.discount.deleted event 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_id
  • UpdateSubscriptionInput.paying_customer_id
  • ApplySubscriptionInput.paying_customer_id
  • PreviewSubscriptionInput.paying_customer_id
  • EstimateSubscriptionInput.paying_customer_id
  • EstimateSubscriptionUpdateInput.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_start
  • EntitlementFragment.usage_period_end
• ⚠️ Deprecated: Entitlement.nextResetDate field

• 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_id
  • ApplySubscriptionInput.paying_customer_id
  • SlimSubscriptionFragmentV2.payingCustomer
  • FullSubscription.payingCustomer

• Added: ability to apply a coupon to a subscription using the Stigg coupon ID using:
  • ProvisionSubscriptionInput.applied_coupon
  • UpdateSubscriptionInput.applied_coupon
  • ApplySubscriptionInput.applied_coupon
  • PreviewSubscriptionInput.applied_coupon
  • EstimateSubscriptionInput.applied_coupon
  • EstimateSubscriptionUpdateInput.applied_coupon

• Changed: ImportCustomerBulk changed to ImportCustomerBulkInput

• Added: ability to undo subscription scheduled cancelation usingcancel_subscription_updates()

• Added: ability to preview a subscription’s upcoming invoice usingpreview_next_invoice()

• Changed: fetch_usage_history() now returns the precise timestamp when the usage was reset

• Changed: UpdateSubscriptionInput.subscription_entitlements does not require the full list of entitlements when needing to add or update specific entitlements

• Added: TrialOverrideConfigurationInput.trial_end_date to 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_price was moved to flat_price.