Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

​
6.6.1
2026-03-19
  • Added: billingCycleAnchor property when provisioning and updating subscriptions. Accepts SubscriptionBillingCycleAnchor.UNCHANGED (default) to keep the existing billing cycle anchor, or SubscriptionBillingCycleAnchor.NOW to reset it to the current timestamp.
​
6.2.3
2026-04-29
  • Added: includeInactiveSubscriptions parameter on getUsageHistoryV2. When set to true, usage history is returned regardless of whether the customer currently has an active subscription. If they do have an active subscription, the response also includes a markers array containing the subscription’s usage reset timestamps.
​
6.40.0
2026-03-17
  • Added: getCreditEntitlement() method for low-latency retrieval of customer credit balance from the local cache.
  • Added: Support for provisioning subscriptions with variable recurring credit grant entitlements.
​
5.74.0
2026-01-24
  • Added: Support for configuring and managing credit auto-recharge settings, including trigger balance, target top-up amount, and monthly spend limit.
​
5.0.0
2025-11
This major version reflects a monorepo-wide version increment driven by a breaking change in the Python SDK (pydantic v1 → v2 dependency update). There are no breaking changes for the Ruby SDK in this version.
​
4.5.0
2025-11-02
This major version reflects a monorepo-wide version increment driven by breaking changes in the Node.js and Sidecar SDKs (entitlements retrieval logic). There are no breaking changes for the Ruby SDK in this version.
​
3.75.0
2025-09-29
  • Added getCreditLedger and getCreditUsage methods.
​
3.74.0
2025-09-29
  • Added void credit grant voidCreditGrant.
​
3.73.0
2025-09-29
  • Added credit balance subscription handling with automatic entitlement updates, expiration checks, and cache mapping for credit rate and validity.
​
3.72.0
2025-09-25
  • Added credit rate mapping.
​
3.71.0
2025-09-23
  • Added awsMarketplaceCustomerId to update and provision customers.
​
3.68.0
2025-09-04
  • Added: grantPromotionalEntitlementsGroup or granting a promotional entitlements group - all entitlements that are not already granted to a customer, need to be included in the request.
  • Added: revokePromotionalEntitlementsGroup for revoking all of the entitlements of a group, unless they are a part of a different group.
  • Added: unlinkPromotionalEntitlementsGroup for removing the references of the group from promotional entitlements that are a part of it, while keep granting access to those entitlements.
​
3.64.0
2025-09-03
  • Added support for subscriptions filter by resourceId and plan (planId/displayName).
​
3.59.2
2025-09-02
  • Added: CancelSubscription.awaitSubscriptionCancellation for controlling whether to wait for confirmation from billing solutions that are integrated with Stigg before marking subscription as canceled in Stigg
​
3.40.0
2025-09-01
  • Added: AccessDeniedReason.Revoked for determining when an entitlement has been explicitly revoked.
​
3.22.2
2025-08-15
  • Added: SubscriptionBillingInfo.prorationBehavior for 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.
​
2.448.1
2025-06-26
  • Added: getSubscriptions endpoint that allows retrieving all of customers’ subscriptions
​
2.307.0
2025-02-23
  • Added: SubscriptionInvoiceFragment.attempt_count
​
2.293.0
2025-01-21
  • Added: ImportSubscriptionInput.subscription_id
​
2.289.0
2025-01-19
  • Added: importSubscriptionInput.salesforce_id, importCustomerInput.salesforce_id
​
2.235.0
2024-12-17
  • 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.
​
2.233.0
2024-12-15
  • Added: SlimSubscriptionFragmentV2.trial_configuration and SlimSubscriptionFragmentV2.trial_end_date
​
2.217.0
2024-12-08
  • Added: ability to override prices when there’s a scheduled update in place
​
2.212.4
2024-12-3
  • Added: TrialConfiguration to getActiveSubscriptions()
​
2.212.1
2024-12-02
  • Added: validation that coupon name does not exceed 40 characters
​
2.209.0
2024-12-02
  • Added: SubscriptionCouponDiscountInput.amounts_off
  • Added: SubscriptionCouponDiscountInput.description
  • Added: SubscriptionCouponDiscountInput.duration_in_months
  • Added: SubscriptionCouponDiscountInput.name
  • Added: SubscriptionCouponDiscountInput.percent_off
​
2.207.0
2024-12-01
  • Added: EstimateSubscriptionInput.TrialOverrideConfigurationInput.trial_end_behavior
  • Added: PreviewSubscriptionInput.TrialOverrideConfigurationInput.trial_end_behavior
​
2.204.0
2024-11-24
  • Added: EstimateSubscriptionInput.TrialOverrideConfigurationInput.trial_end_date
  • Added: PreviewSubscriptionInput.TrialOverrideConfigurationInput.trial_end_date
​
2.199.0
2024-11-21
  • Added: support for price localization in fixed fee coupons
​
2.196.1
2024-11-18
  • Added: Ability to remove customer’s email address by passing an empty string on updateCustomerInput.email
​
2.196.0
2024-11-18
  • Added: delegate_subscription_to_customer()
  • Added: transfer_subscription_to_resource()
  • ⚠️ Deprecated: transfer_subscription() method (please use transfer_subscription_to_resource() instead)
​
2.188.0
2024-11-05
  • Added: UsageHistoryFragment.Markersto reflect information about the reset usage dates
​
2.178.1
2024-11-04
  • Fixed: issue where customer.discount.deleted event from Stripe isn’t handled properly
​
2.175.4
2024-10-31
  • Added: ability to set any date in the SubscriptionFragment.trialEndDate
​
2.162.0
2024-10-13
  • 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
​
2.160.0
2024-10-13
  • Added: raise error when sync to Stripe fails due to unrecognized customer billing address
​
2.151.0
2024-10-06
  • 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
​
2.131.1
2024-09-19
  • Added: raise error when attempting to import a customer with an existing billing_id
​
2.129.0
2024-09-17
  • Added: CustomerPortalSubscriptionFragment.plan_id
​
2.123.1
2024-09-11
  • 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
​
2.100.2
2024-09-01
  • 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
​
2.86.0
2024-08-22
  • 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
​
2.80.2
2024-08-20
  • Changed: ImportCustomerBulk changed to ImportCustomerBulkInput
​
2.62.4
2024-08-07
  • Added: ability to undo subscription scheduled cancelation usingcancel_subscription_updates()
​
2.62.0
2024-08-07
  • Added: ability to preview a subscription’s upcoming invoice usingpreview_next_invoice()
​
2.20.0
2024-07-07
  • Changed: fetch_usage_history() now returns the precise timestamp when the usage was reset
​
2.13.5
2024-07-01
  • Changed: UpdateSubscriptionInput.subscription_entitlements does not require the full list of entitlements when needing to add or update specific entitlements
​
2.8.2
2024-06-27
  • Added: TrialOverrideConfigurationInput.trial_end_date to allow scheduled trial cancelation when provisioning and updating subscriptions
​
1.236.0
2024-06-20
  • Added: ability to get the list of active subscriptions from Edge using get_active_subscriptions_list()
​
1.232.0
2024-06-16
  • Added: ability to get the list of active subscriptions using get_active_subscriptions()
​
1.0.0
2024-01-22
🛑 Breaking change
  • Changed: For Volume/tiered pricing, unit_price was moved to flat_price.