Skip to main content
​
5.264.0
2026-02-26
  • Added: EventLogTypeEdgeAPIPlanCacheDataResync event log type
​
5.261.0
2026-02-26
  • Added: EventLogTypeEdgeAPIProductCacheDataResync event log type
​
5.256.0
2026-02-25
  • Added: Entitlements (V2) to UpdateSubscriptionInput
​
5.255.0
2026-02-25
  • Added: ScopedKeyID and ScopedKeyName to EventActorInfo
​
5.254.0
2026-02-25
  • Added: Scopes to UpdateAPIKeyInput
​
5.248.4
2026-02-24
  • Added: additional metadata fields (AdditionalMetaData, Description, UnitPlural, UnitSingular) to credit entitlement currency types
​
5.248.0
2026-02-23
  • Added: EventLogTypeStripeAppDrawerViewed event log type
​
5.247.0
2026-02-23
  • Added: EntitlementsV2 field to CustomerPortal and CustomerPortalFragment
​
5.246.0
2026-02-23
  • Added: EventActorScopedKey event actor value
​
5.237.0
2026-02-18
  • Added: FeatureDependency type and DependencyFeatureID to package entitlement inputs (PackageEntitlementInput, PackageCreditEntitlementInput, PackageFeatureEntitlementInput, OverageEntitlementCreateInput)
​
5.234.0
2026-02-18
  • Added: typed subscription entitlement union support:
    • SubscriptionEntitlementUnion interface
    • SubscriptionCreditEntitlement struct
    • SubscriptionFeatureEntitlement struct
    • SubscriptionEntitlementInputV2 struct
  • Changed: Entitlements on subscription inputs now uses []*SubscriptionEntitlementInputV2
​
5.233.0
2026-02-17
  • Added: APIKeyScope struct and APIKeyScope/AvailableScopes queries
​
5.232.0
2026-02-17
  • Added: APIKeyScopeAction enum (Read, Write) and APIKeyScopeResource enum (APIKey, Coupon, Customer, Environment, Subscription)
  • Added: APIKeyScopeInput for assigning scopes to API keys
  • Added: ErrorCodeAuthorizationServiceError error code
​
5.230.0
2026-02-17
  • Added: Cadence to CreditEntitlementSummary
​
5.229.0
2026-02-16
  • Added: CreditEntitlementSummary struct with plan, add-on, and subscription source tracking
  • Added: CreditGrantSourceType enum (AddonEntitlement, PlanEntitlement, Price)
  • Added: Summaries to CreditEntitlementWithSummary
  • Added: SourceType to CreditGrant
​
5.225.0
2026-02-16
  • Added: PackageEntitlements as a union type ([]*PackageEntitlementUnionFragment) to AddonFragment
​
5.224.1
2026-02-15
  • Added: GetEntitlementV2 client method returning an EntitlementUnion (credit or feature entitlement)
  • Added: GetEntitlementV2Input with CurrencyID, CustomerID, FeatureID, ResourceID, and Options fields
​
5.222.0
2026-02-12
  • Added: UsagePeriodEnd to CreditEntitlementFragment
​
5.221.0
2026-02-12
  • Added: UsagePeriodEnd to CreditEntitlement and CreditEntitlementWithSummary
​
5.220.0
2026-02-12
  • Added: ListEnvironments query returning []*EnvironmentListItem
  • Added: EnvironmentListItem struct with environment metadata fields
​
5.216.0
2026-02-11
  • Added: IconURL to AppStoreApplication
​
5.215.0
2026-02-11
  • Added: MeterID to FeatureEntitlement and FeatureEntitlementWithSummary
​
5.211.0
2026-02-10
  • Added: EntitlementsWithSummary union type with EntitlementsWithSummary query
  • Added: CreditEntitlementWithSummary implementing EntitlementWithSummaryUnion
  • Added: FeatureEntitlementWithSummary implementing EntitlementWithSummaryUnion
​
5.204.0
2026-02-08
  • Added: CreditGrantCannotBeVoidedError error type and ErrorCodeCreditGrantCannotBeVoided error code
​
5.200.0
2026-02-05
  • Added: Feature and Grant fields to CreditLedgerEvent
​
5.199.0
2026-02-05
  • Added: IntegrationID to ImportCustomerBulkInput and ImportSubscriptionsBulkInput
​
5.197.0
2026-02-04
  • Added: PackageEntitlements union to PaywallAddon
  • Added: PackageEntitlements and InheritedPackageEntitlements unions to PaywallPlan
​
5.196.0
2026-02-04
  • Added: CreditGrantInvoiceStatus.Canceled status value
​
5.195.0
2026-02-03
  • Added: API key audit event log types: EventLogTypeAPIKeyCreated, EventLogTypeAPIKeyRevoked, EventLogTypeAPIKeyRotated, EventLogTypeAPIKeyUpdated
​
5.192.0
2026-02-02
  • Added: APIKeys query returning paginated APIKeyConnection
  • Added: GetAPIKeysInput with filtering by display name, environment, expiration, and key type
  • Added: APIKeyExpirationFilterInput for expiration-based filtering
​
5.187.0
2026-02-01
  • Added: CurrencyID to PriceOverrideInput
​
5.180.0
2026-01-28
  • Added: VoidedAt to CreditGrantFragment
​
5.169.0
2026-01-26
  • Added: EnvironmentID and NextGrantDate to SubscriptionPrice
​
5.165.0
2026-01-25
  • Added: ErrorCodeUnhandledCreditGrantSourceType error code
​
5.164.0
2026-01-25
  • Added: OnEntitlementsUpdatedV2 and OnUsageUpdatedV2 subscription methods
  • Added: EntitlementUnionFragment and CreditEntitlementFragment fragment types
  • Added: EntitlementsUpdatedV2Payload with typed entitlement union support
​
5.163.0
2026-01-25
  • Added: EntitlementUnion interface with CreditEntitlement and FeatureEntitlement implementations
  • Added: EntitlementsV2 to subscription, customer portal, and entitlements state responses
  • Added: EntitlementsUpdatedV2 webhook payload type
  • Added: UsageUpdatedV2 and UsageV2 types for the V2 usage updated event
  • Added: AccessDeniedReason.EntitlementNotFound
  • Added: EntitlementType enum (Credit, Feature)
​
5.154.0
2026-01-21
  • Added: scoped API key management mutations: CreateScopedAPIKey, RevokeAPIKey, RotateAPIKey, UpdateAPIKey
  • Added: CreateScopedAPIKeyInput, RevokeAPIKeyInput, RotateAPIKeyInput, UpdateAPIKeyInput, RotateAPIKeyResult
  • Added: Description, DisplayName, EnvironmentID, and ExpireAt to APIKey
  • Added: APIKeyExpired, APIKeyHasExpiryDate, APIKeyNotFound error types
​
5.153.0
2026-01-21
  • Added: ErrorCodeBillingInvoiceStatusError and ErrorCodeMissingBillingInvoiceError error codes
  • Added: CreditGrantID to MarkInvoiceAsPaidInput
​
5.151.0
2026-01-21
  • Added: BillingInformation to CreditGrantInput using CreditGrantBillingInfoInput
  • Added: PreviewCreditGrantBillingInfoInput for previewing credit grant billing
​
5.143.0
2026-01-19
  • Added: BillingAddress to CreditGrantBillingInfoInput
​
5.140.0
2026-01-19
  • Added: BillingID and PriceGroupPackageBillingID to PricePeriodInput
​
5.139.0
2026-01-18
  • Added: CreditRate to SubscriptionPrice
​
5.133.0
2026-01-15
  • Added: PackageEntitlementChangeUnion interface for tracking plan/add-on entitlement changes
  • Added: PackageCreditEntitlementChange and PackageFeatureEntitlementChange implementing the union
  • Added: PackageEntitlements change tracking to PackageChanges
​
5.131.3
2026-01-14
  • Added: ErrorCodeSchedulingAtEndOfBillingPeriod error code
​
5.130.0
2026-01-14
  • Added: APIKeyType.Scoped API key type value
​
5.128.0
2026-01-12
  • Added: CreditCadence enum (Month, Year)
  • Added: Amount, Cadence, CustomCurrency, and CustomCurrencyID to PackageCreditEntitlement
​
5.123.0
2026-01-11
  • Added: PackageCreditEntitlement type implementing PackageEntitlementUnion
  • Added: Credit option to CreatePackageEntitlementInput and UpdatePackageEntitlementInput
  • Added: ErrorCodeFutureUpdateNotFound error code
​
5.118.0
2026-01-08
  • Added: PackageEntitlementUnion interface with PackageFeatureEntitlement implementation
  • Added: CreatePackageEntitlements, DeletePackageEntitlement, UpdatePackageEntitlement mutations
  • Added: PackageEntitlements union to Addon and Plan types
  • Added: CreatePackageEntitlementsInput, DeletePackageEntitlementInput, UpdatePackageEntitlementInput
​
5.118.3
2026-01-08
  • Added: ErrorCodeObjectAlreadyBeingUsedByAnotherRequestError error code
​
5.116.0
2026-01-05
  • Added: RollbackAddon and RollbackPlan mutations
  • Added: RollbackPackageInput with environment, ref ID, and version number
​
5.115.0
2026-01-05
  • Added: PlanVersions and AddonVersions paginated queries for version history
​
5.112.0
2026-01-04
  • Added: AccessDeniedReason to EntitlementsUpdated and EntitlementsUpdatedPayload
​
5.111.0
2026-01-01
  • Added: AddonSubscriptionsCount and PlanSubscriptionsCount queries with SubscribedCustomersCountInput
​
5.110.3
2026-01-01
  • Added: CreditGrantCadence and TopUpCustomCurrencyID to SubscriptionPrice
  • Added: EventLogTypeCreditGrantBalanceDepleted event log type
​
5.109.3
2025-12-31
  • Added: AdditionalMetaData and EndDate to SlimSubscriptionFragmentV2
​
5.107.0
2025-12-30
  • Added: EntitlementsStateAccessDeniedReason.CustomerIsArchived
​
5.106.0
2025-12-29
  • Added: EffectiveEndDate and Prices to SlimSubscriptionFragmentV2
  • Added: Email to SlimSubscriptionFragmentV2 customer and paying customer
  • Added: ErrorCodeProductNotPublishedError error code
​
5.99.0
2025-12-24
  • Added: RecurringCredits type and RecurringCreditsChangeVariables for subscription schedules
  • Added: Charges parameter to subscription estimate, provision, preview, apply, and update inputs
  • Added: SubscriptionScheduleType.RecurringCredits
​
5.89.0
2025-12-22
  • Added: TaxIds to SubscriptionBillingInfo
  • Added: ErrorCodeInvalidTaxID error code
​
5.84.0
2025-12-21
  • Added: EventLogTypeAutomaticRechargeConfigurationChanged event log type
​
5.82.0
2025-12-18
  • Added: ChargeInput and ChargeType enum (Credit, Feature)
  • Added: Charges support to provision, apply, and update subscription inputs
  • Added: CreditsQuantity to SubscriptionPrice
  • Added: CreditGrantType.Recurring
​
5.75.0
2025-12-16
  • Added: CurrentMonthlySpend to AutoRechargeSettingsFragment
​
5.74.0
2025-12-15
  • Added: Apple App Store integration types: AppStoreApplication, AppStoreSubscription
  • Added: MapAppStoreSubscriptionsToPlans mutation for mapping App Store subscriptions to plans
  • Added: ListAppStoreApplications and ListAppStoreSubscriptions queries
​
5.72.0
2025-12-14
  • Added: UnarchiveOneProduct mutation
  • Added: EventLogTypeProductUnarchived event log type
  • Added: ErrorCodeCannotUnarchiveProductError error code
​
5.71.0
2025-12-11
  • Added: BillingID to PricingModelCreateInput and OveragePricingModelCreateInput
​
5.67.0
2025-12-10
  • Added: BillingProducts query for browsing billing provider products with BillingProductsInput filtering
  • Added: BillingID and PriceGroupPackageBillingID to PackagePricingInput
  • Added: ErrorCodeVendorIsNotSupported error code
​
5.65.0
2025-12-08
  • Added: ProductStatus enum (Published, Archived) to Product
  • Added: ArchiveOneProduct mutation with ArchiveProductInput
  • Added: ErrorCodeCannotArchiveProductError error code
​
5.64.0
2025-12-07
  • Added: CursorPaging and CurrencyID filter to CreditLedgerInput
  • Added: CreditLedgerConnection with pagination support to GetCreditLedger
​
5.63.0
2025-12-07
  • Added: AutomaticRechargeConfigurationID to CreditGrant and CreditGrantFragment
  • Added: CurrentMonthlySpend to AutoRechargeSettingsDto
​
5.61.1
2025-12-04
  • Added: CreditGrantInvoice and CreditGrantInvoiceFragment types with full invoice lifecycle support
  • Added: CreditGrantInvoiceStatus enum (Open, Paid) and CreditGrantInvoiceBillingReason enum
​
5.57.7
2025-12-02
  • Added: Typename to GetEntitlementsState_EntitlementsState
​
5.56.0
2025-11-30
  • Added: GetAutomaticRechargeConfiguration and SaveAutomaticRechargeConfiguration client methods
  • Added: AutoRechargeSettingsFragment fragment type
​
5.53.0
2025-11-27
  • Added: CreditGrantCadence enum (BeginningOfBillingPeriod, Monthly)
  • Added: CreditGrantCadence and CustomCurrency to Price
​
5.46.0
2025-11-25
  • Added: TraceID to EventLog with filter and sort support
​
5.45.0
2025-11-25
  • Added: PreviewCreditGrant mutation with PreviewCreditGrantInput supporting billing info and coupon
  • Added: CreditGrantBillingInfoInput and CreditGrantCouponInput types
  • Added: CreditGrantPreview response type
​
5.43.0
2025-11-25
  • Added: EventLogTypeCreditGrantProcessCompleted event log type
​
5.39.0
2025-11-24
  • Added: AutoRechargeSettingsDto type with full recharge configuration
  • Added: SaveAutoRechargeSettings mutation and GetAutoRechargeSettings query
  • Added: GrantExpirationPeriod enum (OneMonth, OneYear) and ThresholdType enum (CreditAmount, DollarAmount)
  • Added: GetAutoRechargeSettingsInput and SaveAutoRechargeSettingsInput
​
5.35.0
2025-11-21
  • Added: EntityType and RequestLogID to EventLog with filter and sort support
  • Added: Like filter to EventLogEntityIDFilterComparison
  • Added: EventLogEntityTypeFilterComparison and EventLogRequestLogIDFilterComparison
​
5.32.0
2025-11-20
  • Added: DeferredRevenueAccount and RecognizedRevenueAccount to Zuora credentials
​
5.29.0
2025-11-19
  • Added: InvoiceID, LatestInvoice, PaymentCollection, and Status to CreditGrantFragment
​
5.28.0
2025-11-19
  • Added: CreditGrantStatus enum with states: Active, Expired, PaymentPending, Scheduled, Voided
  • Added: Status to CreditGrant
​
5.21.0
2025-11-17
  • Added: EventLogTypeCreditBalanceUpdated event log type
​
5.18.0
2025-11-16
  • Added: CreateCoupon client method
​
5.15.0
2025-11-15
  • Added: EventLogTypeAutomaticRechargeOperationAttempted and EventLogTypeCreditsAutomaticRechargeLimitExceeded event log types
​
5.14.0
2025-11-13
  • Added: AwsMarketplacePlanDimension to PlanFragment
  • Added: AwsMarketplaceProductID to ProductFragment
​
5.12.0
2025-11-11
  • Added: string condition operations: Contains, EndsWith, In, StartsWith
  • Added: Values to MeterCondition and MeterConditionInput
​
5.9.0
2025-11-10
  • Added: Plan and Resource filters to SubscriptionQueryFilter
​
5.1.0
2025-11-05
  • Added: Passphrase and PrivateKey to SnowflakeCredentials
​
5.0.0
2025-11-04
  • Initial v5 release
​
4.7.0
2025-11-04
  • Added: CostFormula to CreditRate and CreditRateInput
​
4.6.0
2025-11-04
  • Added: PricingType filter and sort to subscription queries
​
4.5.0
2025-11-02
  • Initial v4 release
​
3.128.0
2025-10-28
  • Added: SnowflakeCredentials to UpdateIntegrationInput
​
3.123.0
2025-10-26
  • Added: EventLogTypePromotionalEntitlementEndsSoon event log type
​
3.122.0
2025-10-23
  • Added: Passphrase and PrivateKey to SnowflakeCredentialsInput
  • Added: Password to SnowflakeCredentials
​
3.116.0
2025-10-19
  • Added: EventLogTypeEdgeAPIClientConfigurationDataResync event log type
  • Added: ShowWatermark to SdkConfiguration and GetSdkConfiguration_SdkConfiguration
​
3.113.0
2025-10-09
  • Added: InvoiceSettlementEnabled to ZuoraCredentials and ZuoraCredentialsInput
​
3.111.0
2025-10-08
  • Added: AwsMarketplaceCustomerID filter fields to customer and subscription queries
  • Added: SubscriptionQueryFilterCustomerFilter for subscription-level customer filtering
​
3.108.0
2025-09-29
  • Added: VoidCreditGrant client method
​
3.107.0
2025-09-29
  • Added: VoidCreditGrantInput and VoidCreditGrant mutation
  • Added: VoidedAt to CreditGrant
  • Added: CreditLedgerEventType.CreditsVoided
  • Added: EventLogTypeCreditGrantVoided event log type
  • Added: CreditGrantAlreadyVoidedError error type
​
3.105.0
2025-09-29
  • Added: credit event log types: CreditBalanceDepleted, CreditBalanceLow, CreditGrantBalanceLow, CreditGrantCreated, CreditGrantDepleted, CreditGrantExpired, CreditGrantUpdated
​
3.101.0
2025-09-29
  • Added: OnCreditBalanceUpdated subscription method
  • Added: CreditBalanceUpdated and CreditBalanceUpdatedPayload types
  • Added: CurrencyID to CreditRate and CreditRateInput
  • Added: CreditBalanceFragment and related types
​
3.100.0
2025-09-28
  • Added: AwaitPaymentConfirmation and PaymentCollectionMethod to CreditGrantInput
  • Added: NoActiveSubscriptionForCustomerError error type
​
3.98.1
2025-09-28
  • Added: Currency to CreditUsage and CreditUsageFragment
  • Added: SlimCustomCurrencyFragment and related unit types
​
3.97.0
2025-09-22
  • Added: TopUpCustomCurrencyID to Price, OveragePricingModelCreateInput, and PricingModelCreateInput
​
3.96.0
2025-09-21
  • Added: GetCreditUsage client method
  • Added: CreditUsageFragment with series-based time-range data
​
3.95.0
2025-09-18
  • Added: CreditUsage, CreditUsageInput, CreditUsageSeries, and CreditUsagePoint types
  • Added: CreditUsageTimeRange enum (LastDay, LastWeek, LastMonth, LastYear)
​
3.93.0
2025-09-18
  • Added: pagination support to GetCreditGrants using CursorPaging
  • Added: CreditGrantConnection and CreditGrantEdge types
​
3.88.0
2025-09-17
  • Added: GetCreditLedger client method
  • Added: CreditLedgerFragment type
​
3.84.1
2025-09-16
  • Added: GetEntitlementsState client method
  • Added: EntitlementsState and EntitlementsStateAccessDeniedReason types
​
3.81.0
2025-09-14
  • Added: credit-related event log types: CreditsBalanceDepleted, CreditsBalanceUsageLow, CreditsGrantDepleted, CreditsGrantExpired, CreditsGrantGranted, CreditsGrantUpdated, CreditsGrantUsageLow
  • Added: EventEntityType.Credit
​
3.80.0
2025-09-11
  • Added: OfferID to GetPaywallInput
​
3.70.0
2025-09-07
  • Added: Offer type with full lifecycle support: CreateOffer, UpdateOffer, PublishOffer, CreateOfferDraft, RemoveOfferDraft, SetAsDefault mutations
  • Added: Offer reference to Addon, PackageDto, and Plan types
  • Added: OfferStatus enum (Draft, Published, Archived) and related filter/sort types
  • Added: GetOfferInput, CreateOfferInput, CreateOfferDraftInput
​
3.70.1
2025-09-07
  • Added: DraftDetails to Offer with version information
​
3.68.0
2025-09-04
  • Added: CreatePaymentSession client method
  • Added: PaymentSessionFragment, StripeCheckoutCredentialsFragment, ZuoraCheckoutCredentialsFragment types
​
3.66.0
2025-09-04
  • Added: BillingCredentials interface with StripeCheckoutCredentials and ZuoraCheckoutCredentials implementations
  • Added: PaymentSession and PaymentSessionInput types
  • Added: BillingVendorIdentifier.Zuora
  • Added: PublishableKey to ZuoraCredentials
​
3.64.0
2025-09-03
  • Added: EmailDomains to Account with AccountEmailDomain type
  • Added: IsAccountEmailDomainTaken query
  • Added: EmailDomains to UpdateAccountInput
​
3.62.0
2025-09-03
  • Added: GrantPromotionalEntitlementsGroup, RevokePromotionalEntitlementsGroup, UnlinkPromotionalEntitlementsGroup client methods
​
3.59.2
2025-09-01
  • Added: AwaitSubscriptionCancellation to SubscriptionCancellationInput for controlling whether to wait for billing provider confirmation before marking a subscription as canceled
​
3.57.0
2025-08-31
  • Added: GrantPromotionalEntitlementsGroupInput, RevokePromotionalEntitlementsGroupInput, UnlinkPromotionalEntitlementsGroupInput types
  • Added: FeatureGroupIds and FeatureGroups to PromotionalEntitlement
  • Added: FeatureGroupID to PromotionalEntitlementInput
​
3.48.0
2025-08-27
  • Added: CreditLedger, CreditLedgerEvent, and CreditLedgerEventType types (CreditsConsumed, CreditsExpired, CreditsGranted)
  • Added: CreditLedgerInput and CreditsLedger query
​
3.42.0
2025-08-26
  • Added: StartDate filter and sort to subscription queries
​
3.40.0
2025-08-25
  • Added: IsGranted to PackageEntitlementFragment and MockPaywallPackageEntitlementFragment
​
3.39.0
2025-08-25
  • Added: AccessDeniedReason.InsufficientCredits
​
3.38.0
2025-08-25
  • Added: GetCreditBalance, GetCreditGrants, and GrantCredits client methods
  • Added: CreditGrantFragment, CreditsBalanceSummaryFragment fragment types
​
3.36.0
2025-08-24
  • Added: AccessDeniedReason.Revoked
  • Added: IsGranted to PackageEntitlement and related input types
​
3.34.1
2025-08-24
  • Added: ConsumedAmount to CreditGrant
​
3.27.0
2025-08-19
  • Added: Description and Units to CustomCurrency and SlimCustomCurrency
  • Added: Units and UnitsInput struct types
​
3.26.5
2025-08-19
  • Added: DueDate to SubscriptionInvoice
​
3.26.0
2025-08-18
  • Added: GrantID to CreditGrant
​
3.23.1
2025-08-17
  • Added: EventEntityType.FeatureGroup
​
3.23.0
2025-08-17
  • Added: LinkFeatureGroupToPackage mutation with LinkFeatureGroupToPackageInput
​
3.22.2
2025-08-15
  • Added: SubscriptionProrationBehavior enum (CreateProrations, InvoiceImmediately, None)
  • Added: ProrationBehavior to SubscriptionBillingInfo
​
3.17.0
2025-08-13
  • Added: CreditBalance and CreditBalanceSummary structs
  • Added: SlimCustomCurrency type
​
3.16.0
2025-08-12
  • Added: CreditRate and CreditRateInput types with Amount and CustomCurrencyID
  • Added: BillingModel.CreditBased
​
3.13.0
2025-08-12
  • Added: feature group event log types: FeatureGroupArchived, FeatureGroupCreated, FeatureGroupUnArchived, FeatureGroupUpdated
​
3.12.0
2025-08-12
  • Added: ProrationBehaviorExtended enum (CreateProrations, InvoiceImmediately, None)
  • Added: ProrationBehavior to SubscriptionBillingInfo
​
3.10.0
2025-08-09
  • Added: EnvironmentID to ApplySubscriptionInput
​
3.9.0
2025-08-07
  • Added: MigratePackageFeatureGroupsToLatest mutation
​
3.6.0
2025-08-06
  • Added: CreditBalanceDto, CreditBalanceSummaryDto, and CreditBalanceSummaryInput types
  • Added: CreditBalanceSummary query
​
3.3.0
2025-08-05
  • Initial v3 release
​
2.448.1
2025-06-26
  • Added: getSubscriptions endpoint that allows retrieving all of customers’ subscriptions
​
2.307.0
2025-02-23
  • Added: SubscriptionFragmentLatestInvoice.attemptCount
​
2.293.0
2025-01-21
  • Added: ImportSubscriptionInput.subscriptionId
​
2.289.0
2025-01-19
  • Added: importSubscriptionInput.salesforceId, importCustomerInput.salesforceId
​
2.235.0
2024-12-17
  • Added: GetUsageHistoryV2
  • ⚠️ Deprecated: GetUsageHistory (please use GetUsageHistoryV2 instead)
  • Changed:
    • Input Object:
      • customerRefId renamed to customerId
      • resourceRefId renamed to resourceId
      • featureRefId renamed to featureId
      • resetPeriod removed
      • yearlyResetPeriodConfiguration removed
      • monthlyResetPeriodConfiguration removed
      • weeklyResetPeriodConfiguration removed
    • Output Object
      • startDate removed
      • endDate removed
      • usageMeasurements[i].date renamed to series[0].point[i].timestamp
      • usageMeasurements[i].value renamed to series[0].point[i].value
      • usageMeasurements[i].isResetPoint renamed to series[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.
      • groups[i].groupInfo[j].key renamed to series[i].tags[j].key
      • groups[i].groupInfo[j].value renamed to series[i].tags[j].value
      • groups[i].usageMeasurements[j].date renamed to series[i].point[j].timestamp
      • groups[i].usageMeasurements[j].value renamed to series[i].point[j].value
      • groups[i].usageMeasurements[j].isResetPoint renamed to series[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.
​
2.233.0
2024-12-15
  • Added: getActiveSubscriptionsList_trialConfiguration and getActiveSubscriptionsList_trialConfiguration_trialEndDate
​
2.217.0
2024-12-08
  • Added: ability to override prices when there’s a scheduled update in place
​
2.212.4
2024-12-03
  • 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: SubscriptionCoupon.amountsOff
  • Added: SubscriptionCoupon.description
  • Added: SubscriptionCoupon.durationInMonths
  • Added: SubscriptionCoupon.name
  • Added: SubscriptionCoupon.percentOff
​
2.207.0
2024-12-01
  • Added: EstimateSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior
  • Added: PreviewSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior
​
2.204.0
2024-11-24
  • Added: EstimateSubscriptionInput.TrialOverrideConfigurationInput.trialEndDate
  • Added: PreviewSubscriptionInput.TrialOverrideConfigurationInput.trialEndDate
​
2.199.0
2024-11-24
  • 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 updateCustomer.email
​
2.196.0
2024-11-18
  • Added: DelegateSubscriptionToCustomer()
  • Added: TransferSubscriptionToResource()
  • ⚠️ Deprecated: TransferSubscriptin() method (please use TransferSubscriptionToResource() instead)
​
2.188.0
2024-11-05
  • Added: UsageHistoryFragment.Markers to 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.PayingCustomerID
    • UpdateSubscriptionInput.PayingCustomerID
    • ApplySubscriptionInput.PayingCustomerID
    • PreviewSubscriptionInput.PayingCustomerID
    • EstimateSubscriptionInput.PayingCustomerID
    • EstimateSubscriptionUpdateInput.PayingCustomerID
​
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:
    • Entitlement.UsagePeriodStart
    • Entitlement.UsagePeriodEnd
  • ⚠️ Deprecated: Entitlement.nextResetDate field
​
2.131.1
2024-09-19
  • Added: raise error when attempting to import a customer with an existing BillingID
​
2.129.0
2024-09-17
  • Added: CustomerPortalSubscription.PlanID
​
2.123.1
2024-09-11
  • Added: SubscriptionCouponInput.BillingCouponID
  • ⚠️ Deprecated: ProvisionSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: UpdateSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: ApplySubscriptionInput.PromotionCode
  • ⚠️ Deprecated: PreviewSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: EstimateSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: EstimateSubscriptionUpdateInput.PromotionCode
​
2.100.2
2024-09-01
  • Added: ability to delegate payment of a provisioned subscription to a different customer using:
    • ProvisionSubscriptionInput.PayingCustomerID
    • ApplySubscriptionInput.PayingCustomerID
    • 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.AppliedCoupon
    • UpdateSubscriptionInput.AppliedCoupon
    • ApplySubscriptionInput.AppliedCoupon
    • PreviewSubscriptionInput.AppliedCoupon
    • EstimateSubscriptionInput.AppliedCoupon
    • EstimateSubscriptionUpdateInput.AppliedCoupon
​
2.80.2
2024-08-20
  • Changed: ImportCustomerBulk changed to ImportCustomerBulkInput
​
2.62.4
2024-08-07
  • Added: ability to undo subscription scheduled cancelation using CancelSubscriptionUpdates()
​
2.62.0
2024-08-07
  • Added: ability to preview a subscription’s upcoming invoice using PreviewNextInvoice()
​
2.20.0
2024-07-07
  • Changed: FetchUsageHistory() now returns the precise timestamp when the usage was reset
​
2.13.5
2024-07-01
  • Changed: UpdateSubscriptionInput.SubscriptionEntitlements does not require the full list of entitlements when needing to add or update specific entitlements
​
2.8.2
2024-06-27
  • Added: TrialOverrideConfigurationInput.TrialEndDate 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 GetActiveSubscriptionList()
​
1.232.0
2024-06-16
  • Added: ability to get the list of active subscriptions using GetActiveSubscriptions()
​
1.0.0
2024-01-26
🛑 Breaking change
  • Changed: For Volume/tiered pricing, unitPrice was moved to flatPrice.