Skip to main content
​
2026-07-08
Direct credit consumption
  • Added: ConsumeCredits (synchronous) and ConsumeCreditsAsync (asynchronous) methods to deduct credits directly from a customer’s pool, without reporting usage against a metered feature or requiring an active subscription. Use ConsumeCredits for strict, real-time enforcement; use ConsumeCreditsAsync for high-volume, eventually-consistent consumption. See direct credit consumption.
  • GetCreditEntitlement and GetEntitlement continue to return a valid credit balance for customers with no active subscription, so credit governance can run fully decoupled from Stigg subscription management.
​
2026-06-23
Synchronous credit balance updates via ReportUsage
  • Added: When ReportUsage is called for a credit-backed feature, the response now includes a Credit struct with the updated credit balance — immediately, before the asynchronous metering pipeline settles. Credit contains CurrencyID, CurrentUsage, UsageLimit, and Timestamp. Use ReportUsage for sub-second, strict credit enforcement; use ReportEvent for high-volume, eventually-consistent metering.
Credit wallet soft limit
  • Added: HasSoftLimit field on credit entitlement responses. When a credit entitlement is configured as a soft limit, GetEntitlement returns IsGranted: true and HasSoftLimit: true even after the credit balance reaches zero. Credit-backed features inherit the wallet’s soft-limit so dependent feature reads stay consistent.
​
2026-06-01
Credit usage breakdown by event dimensions
  • Added: GroupBy array parameter on GetCreditUsage to break down credit consumption by any dimension key attached to reported usage events (e.g., user, model, region). Results are paginated for performance at high event volumes.
​
2026-05-10
Credit usage date filters
  • Added: StartDate and EndDate parameters on GetCreditUsage. Pass specific start and end timestamps to retrieve credit consumption data for an exact time window, in addition to the existing preset period enums. See customer credits.
​
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.
​
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.
​
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.
​
2026-02-26
  • Added: EventLogTypeEdgeAPIPlanCacheDataResync event log type
​
2026-02-26
  • Added: EventLogTypeEdgeAPIProductCacheDataResync event log type
​
2026-02-25
  • Added: Entitlements (V2) to UpdateSubscriptionInput
​
2026-02-25
  • Added: ScopedKeyID and ScopedKeyName to EventActorInfo
​
2026-02-25
  • Added: Scopes to UpdateAPIKeyInput
​
2026-02-24
  • Added: additional metadata fields (AdditionalMetaData, Description, UnitPlural, UnitSingular) to credit entitlement currency types
​
2026-02-23
  • Added: EventLogTypeStripeAppDrawerViewed event log type
​
2026-02-23
  • Added: EntitlementsV2 field to CustomerPortal and CustomerPortalFragment
​
2026-02-23
  • Added: EventActorScopedKey event actor value
​
2026-02-18
  • Added: FeatureDependency type and DependencyFeatureID to package entitlement inputs (PackageEntitlementInput, PackageCreditEntitlementInput, PackageFeatureEntitlementInput, OverageEntitlementCreateInput)
​
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
​
2026-02-17
  • Added: APIKeyScope struct and APIKeyScope/AvailableScopes queries
​
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
​
2026-02-17
  • Added: Cadence to CreditEntitlementSummary
​
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
​
2026-02-16
  • Added: PackageEntitlements as a union type ([]*PackageEntitlementUnionFragment) to AddonFragment
​
2026-02-15
  • Added: GetEntitlementV2 client method returning an EntitlementUnion (credit or feature entitlement)
  • Added: GetEntitlementV2Input with CurrencyID, CustomerID, FeatureID, ResourceID, and Options fields
​
2026-02-12
  • Added: UsagePeriodEnd to CreditEntitlementFragment
​
2026-02-12
  • Added: UsagePeriodEnd to CreditEntitlement and CreditEntitlementWithSummary
​
2026-02-12
  • Added: ListEnvironments query returning []*EnvironmentListItem
  • Added: EnvironmentListItem struct with environment metadata fields
​
2026-02-11
  • Added: IconURL to AppStoreApplication
​
2026-02-11
  • Added: MeterID to FeatureEntitlement and FeatureEntitlementWithSummary
​
2026-02-10
  • Added: EntitlementsWithSummary union type with EntitlementsWithSummary query
  • Added: CreditEntitlementWithSummary implementing EntitlementWithSummaryUnion
  • Added: FeatureEntitlementWithSummary implementing EntitlementWithSummaryUnion
​
2026-02-08
  • Added: CreditGrantCannotBeVoidedError error type and ErrorCodeCreditGrantCannotBeVoided error code
​
2026-02-05
  • Added: Feature and Grant fields to CreditLedgerEvent
​
2026-02-05
  • Added: IntegrationID to ImportCustomerBulkInput and ImportSubscriptionsBulkInput
​
2026-02-04
  • Added: PackageEntitlements union to PaywallAddon
  • Added: PackageEntitlements and InheritedPackageEntitlements unions to PaywallPlan
​
2026-02-04
  • Added: CreditGrantInvoiceStatus.Canceled status value
​
2026-02-03
  • Added: API key audit event log types: EventLogTypeAPIKeyCreated, EventLogTypeAPIKeyRevoked, EventLogTypeAPIKeyRotated, EventLogTypeAPIKeyUpdated
​
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
​
2026-02-01
  • Added: CurrencyID to PriceOverrideInput
​
2026-01-28
  • Added: VoidedAt to CreditGrantFragment
​
2026-01-26
  • Added: EnvironmentID and NextGrantDate to SubscriptionPrice
​
2026-01-25
  • Added: ErrorCodeUnhandledCreditGrantSourceType error code
​
2026-01-25
  • Added: OnEntitlementsUpdatedV2 and OnUsageUpdatedV2 subscription methods
  • Added: EntitlementUnionFragment and CreditEntitlementFragment fragment types
  • Added: EntitlementsUpdatedV2Payload with typed entitlement union support
​
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)
​
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
​
2026-01-21
  • Added: ErrorCodeBillingInvoiceStatusError and ErrorCodeMissingBillingInvoiceError error codes
  • Added: CreditGrantID to MarkInvoiceAsPaidInput
​
2026-01-21
  • Added: BillingInformation to CreditGrantInput using CreditGrantBillingInfoInput
  • Added: PreviewCreditGrantBillingInfoInput for previewing credit grant billing
​
2026-01-19
  • Added: BillingAddress to CreditGrantBillingInfoInput
​
2026-01-19
  • Added: BillingID and PriceGroupPackageBillingID to PricePeriodInput
​
2026-01-18
  • Added: CreditRate to SubscriptionPrice
​
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
​
2026-01-14
  • Added: ErrorCodeSchedulingAtEndOfBillingPeriod error code
​
2026-01-14
  • Added: APIKeyType.Scoped API key type value
​
2026-01-12
  • Added: CreditCadence enum (Month, Year)
  • Added: Amount, Cadence, CustomCurrency, and CustomCurrencyID to PackageCreditEntitlement
​
2026-01-11
  • Added: PackageCreditEntitlement type implementing PackageEntitlementUnion
  • Added: Credit option to CreatePackageEntitlementInput and UpdatePackageEntitlementInput
  • Added: ErrorCodeFutureUpdateNotFound error code
​
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
​
2026-01-08
  • Added: ErrorCodeObjectAlreadyBeingUsedByAnotherRequestError error code
​
2026-01-05
  • Added: RollbackAddon and RollbackPlan mutations
  • Added: RollbackPackageInput with environment, ref ID, and version number
​
2026-01-05
  • Added: PlanVersions and AddonVersions paginated queries for version history
​
2026-01-04
  • Added: AccessDeniedReason to EntitlementsUpdated and EntitlementsUpdatedPayload
​
2026-01-01
  • Added: AddonSubscriptionsCount and PlanSubscriptionsCount queries with SubscribedCustomersCountInput
​
2026-01-01
  • Added: CreditGrantCadence and TopUpCustomCurrencyID to SubscriptionPrice
  • Added: EventLogTypeCreditGrantBalanceDepleted event log type
​
2025-12-31
  • Added: AdditionalMetaData and EndDate to SlimSubscriptionFragmentV2
​
2025-12-30
  • Added: EntitlementsStateAccessDeniedReason.CustomerIsArchived
​
2025-12-29
  • Added: EffectiveEndDate and Prices to SlimSubscriptionFragmentV2
  • Added: Email to SlimSubscriptionFragmentV2 customer and paying customer
  • Added: ErrorCodeProductNotPublishedError error code
​
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
​
2025-12-22
  • Added: TaxIds to SubscriptionBillingInfo
  • Added: ErrorCodeInvalidTaxID error code
​
2025-12-21
  • Added: EventLogTypeAutomaticRechargeConfigurationChanged event log type
​
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
​
2025-12-16
  • Added: CurrentMonthlySpend to AutoRechargeSettingsFragment
​
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
​
2025-12-14
  • Added: UnarchiveOneProduct mutation
  • Added: EventLogTypeProductUnarchived event log type
  • Added: ErrorCodeCannotUnarchiveProductError error code
​
2025-12-11
  • Added: BillingID to PricingModelCreateInput and OveragePricingModelCreateInput
​
2025-12-10
  • Added: BillingProducts query for browsing billing provider products with BillingProductsInput filtering
  • Added: BillingID and PriceGroupPackageBillingID to PackagePricingInput
  • Added: ErrorCodeVendorIsNotSupported error code
​
2025-12-08
  • Added: ProductStatus enum (Published, Archived) to Product
  • Added: ArchiveOneProduct mutation with ArchiveProductInput
  • Added: ErrorCodeCannotArchiveProductError error code
​
2025-12-07
  • Added: CursorPaging and CurrencyID filter to CreditLedgerInput
  • Added: CreditLedgerConnection with pagination support to GetCreditLedger
​
2025-12-07
  • Added: AutomaticRechargeConfigurationID to CreditGrant and CreditGrantFragment
  • Added: CurrentMonthlySpend to AutoRechargeSettingsDto
​
2025-12-04
  • Added: CreditGrantInvoice and CreditGrantInvoiceFragment types with full invoice lifecycle support
  • Added: CreditGrantInvoiceStatus enum (Open, Paid) and CreditGrantInvoiceBillingReason enum
​
2025-12-02
  • Added: Typename to GetEntitlementsState_EntitlementsState
​
2025-11-30
  • Added: GetAutomaticRechargeConfiguration and SaveAutomaticRechargeConfiguration client methods
  • Added: AutoRechargeSettingsFragment fragment type
​
2025-11-27
  • Added: CreditGrantCadence enum (BeginningOfBillingPeriod, Monthly)
  • Added: CreditGrantCadence and CustomCurrency to Price
​
2025-11-25
  • Added: TraceID to EventLog with filter and sort support
​
2025-11-25
  • Added: PreviewCreditGrant mutation with PreviewCreditGrantInput supporting billing info and coupon
  • Added: CreditGrantBillingInfoInput and CreditGrantCouponInput types
  • Added: CreditGrantPreview response type
​
2025-11-25
  • Added: EventLogTypeCreditGrantProcessCompleted event log type
​
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
​
2025-11-21
  • Added: EntityType and RequestLogID to EventLog with filter and sort support
  • Added: Like filter to EventLogEntityIDFilterComparison
  • Added: EventLogEntityTypeFilterComparison and EventLogRequestLogIDFilterComparison
​
2025-11-20
  • Added: DeferredRevenueAccount and RecognizedRevenueAccount to Zuora credentials
​
2025-11-19
  • Added: InvoiceID, LatestInvoice, PaymentCollection, and Status to CreditGrantFragment
​
2025-11-19
  • Added: CreditGrantStatus enum with states: Active, Expired, PaymentPending, Scheduled, Voided
  • Added: Status to CreditGrant
​
2025-11-17
  • Added: EventLogTypeCreditBalanceUpdated event log type
​
2025-11-16
  • Added: CreateCoupon client method
​
2025-11-15
  • Added: EventLogTypeAutomaticRechargeOperationAttempted and EventLogTypeCreditsAutomaticRechargeLimitExceeded event log types
​
2025-11-13
  • Added: AwsMarketplacePlanDimension to PlanFragment
  • Added: AwsMarketplaceProductID to ProductFragment
​
2025-11-11
  • Added: string condition operations: Contains, EndsWith, In, StartsWith
  • Added: Values to MeterCondition and MeterConditionInput
​
2025-11-10
  • Added: Plan and Resource filters to SubscriptionQueryFilter
​
2025-11-05
  • Added: Passphrase and PrivateKey to SnowflakeCredentials
​
2025-11-04
  • Initial v5 release
​
2025-11-04
  • Added: CostFormula to CreditRate and CreditRateInput
​
2025-11-04
  • Added: PricingType filter and sort to subscription queries
​
2025-11-02
  • Initial v4 release
​
2025-10-28
  • Added: SnowflakeCredentials to UpdateIntegrationInput
​
2025-10-26
  • Added: EventLogTypePromotionalEntitlementEndsSoon event log type
​
2025-10-23
  • Added: Passphrase and PrivateKey to SnowflakeCredentialsInput
  • Added: Password to SnowflakeCredentials
​
2025-10-19
  • Added: EventLogTypeEdgeAPIClientConfigurationDataResync event log type
  • Added: ShowWatermark to SdkConfiguration and GetSdkConfiguration_SdkConfiguration
​
2025-10-09
  • Added: InvoiceSettlementEnabled to ZuoraCredentials and ZuoraCredentialsInput
​
2025-10-08
  • Added: AwsMarketplaceCustomerID filter fields to customer and subscription queries
  • Added: SubscriptionQueryFilterCustomerFilter for subscription-level customer filtering
​
2025-09-29
  • Added: VoidCreditGrant client method
​
2025-09-29
  • Added: VoidCreditGrantInput and VoidCreditGrant mutation
  • Added: VoidedAt to CreditGrant
  • Added: CreditLedgerEventType.CreditsVoided
  • Added: EventLogTypeCreditGrantVoided event log type
  • Added: CreditGrantAlreadyVoidedError error type
​
2025-09-29
  • Added: credit event log types: CreditBalanceDepleted, CreditBalanceLow, CreditGrantBalanceLow, CreditGrantCreated, CreditGrantDepleted, CreditGrantExpired, CreditGrantUpdated
​
2025-09-29
  • Added: OnCreditBalanceUpdated subscription method
  • Added: CreditBalanceUpdated and CreditBalanceUpdatedPayload types
  • Added: CurrencyID to CreditRate and CreditRateInput
  • Added: CreditBalanceFragment and related types
​
2025-09-28
  • Added: AwaitPaymentConfirmation and PaymentCollectionMethod to CreditGrantInput
  • Added: NoActiveSubscriptionForCustomerError error type
​
2025-09-28
  • Added: Currency to CreditUsage and CreditUsageFragment
  • Added: SlimCustomCurrencyFragment and related unit types
​
2025-09-22
  • Added: TopUpCustomCurrencyID to Price, OveragePricingModelCreateInput, and PricingModelCreateInput
​
2025-09-21
  • Added: GetCreditUsage client method
  • Added: CreditUsageFragment with series-based time-range data
​
2025-09-18
  • Added: CreditUsage, CreditUsageInput, CreditUsageSeries, and CreditUsagePoint types
  • Added: CreditUsageTimeRange enum (LastDay, LastWeek, LastMonth, LastYear)
​
2025-09-18
  • Added: pagination support to GetCreditGrants using CursorPaging
  • Added: CreditGrantConnection and CreditGrantEdge types
​
2025-09-17
  • Added: GetCreditLedger client method
  • Added: CreditLedgerFragment type
​
2025-09-16
  • Added: GetEntitlementsState client method
  • Added: EntitlementsState and EntitlementsStateAccessDeniedReason types
​
2025-09-14
  • Added: credit-related event log types: CreditsBalanceDepleted, CreditsBalanceUsageLow, CreditsGrantDepleted, CreditsGrantExpired, CreditsGrantGranted, CreditsGrantUpdated, CreditsGrantUsageLow
  • Added: EventEntityType.Credit
​
2025-09-11
  • Added: OfferID to GetPaywallInput
​
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
​
2025-09-07
  • Added: DraftDetails to Offer with version information
​
2025-09-04
  • Added: CreatePaymentSession client method
  • Added: PaymentSessionFragment, StripeCheckoutCredentialsFragment, ZuoraCheckoutCredentialsFragment types
​
2025-09-04
  • Added: BillingCredentials interface with StripeCheckoutCredentials and ZuoraCheckoutCredentials implementations
  • Added: PaymentSession and PaymentSessionInput types
  • Added: BillingVendorIdentifier.Zuora
  • Added: PublishableKey to ZuoraCredentials
​
2025-09-03
  • Added: EmailDomains to Account with AccountEmailDomain type
  • Added: IsAccountEmailDomainTaken query
  • Added: EmailDomains to UpdateAccountInput
​
2025-09-03
  • Added: GrantPromotionalEntitlementsGroup, RevokePromotionalEntitlementsGroup, UnlinkPromotionalEntitlementsGroup client methods
​
2025-09-01
  • Added: AwaitSubscriptionCancellation to SubscriptionCancellationInput for controlling whether to wait for billing provider confirmation before marking a subscription as canceled
​
2025-08-31
  • Added: GrantPromotionalEntitlementsGroupInput, RevokePromotionalEntitlementsGroupInput, UnlinkPromotionalEntitlementsGroupInput types
  • Added: FeatureGroupIds and FeatureGroups to PromotionalEntitlement
  • Added: FeatureGroupID to PromotionalEntitlementInput
​
2025-08-27
  • Added: CreditLedger, CreditLedgerEvent, and CreditLedgerEventType types (CreditsConsumed, CreditsExpired, CreditsGranted)
  • Added: CreditLedgerInput and CreditsLedger query
​
2025-08-26
  • Added: StartDate filter and sort to subscription queries
​
2025-08-25
  • Added: IsGranted to PackageEntitlementFragment and MockPaywallPackageEntitlementFragment
​
2025-08-25
  • Added: AccessDeniedReason.InsufficientCredits
​
2025-08-25
  • Added: GetCreditBalance, GetCreditGrants, and GrantCredits client methods
  • Added: CreditGrantFragment, CreditsBalanceSummaryFragment fragment types
​
2025-08-24
  • Added: AccessDeniedReason.Revoked
  • Added: IsGranted to PackageEntitlement and related input types
​
2025-08-24
  • Added: ConsumedAmount to CreditGrant
​
2025-08-19
  • Added: Description and Units to CustomCurrency and SlimCustomCurrency
  • Added: Units and UnitsInput struct types
​
2025-08-19
  • Added: DueDate to SubscriptionInvoice
​
2025-08-18
  • Added: GrantID to CreditGrant
​
2025-08-17
  • Added: EventEntityType.FeatureGroup
​
2025-08-17
  • Added: LinkFeatureGroupToPackage mutation with LinkFeatureGroupToPackageInput
​
2025-08-15
  • Added: SubscriptionProrationBehavior enum (CreateProrations, InvoiceImmediately, None)
  • Added: ProrationBehavior to SubscriptionBillingInfo
​
2025-08-13
  • Added: CreditBalance and CreditBalanceSummary structs
  • Added: SlimCustomCurrency type
​
2025-08-12
  • Added: CreditRate and CreditRateInput types with Amount and CustomCurrencyID
  • Added: BillingModel.CreditBased
​
2025-08-12
  • Added: feature group event log types: FeatureGroupArchived, FeatureGroupCreated, FeatureGroupUnArchived, FeatureGroupUpdated
​
2025-08-12
  • Added: ProrationBehaviorExtended enum (CreateProrations, InvoiceImmediately, None)
  • Added: ProrationBehavior to SubscriptionBillingInfo
​
2025-08-09
  • Added: EnvironmentID to ApplySubscriptionInput
​
2025-08-07
  • Added: MigratePackageFeatureGroupsToLatest mutation
​
2025-08-06
  • Added: CreditBalanceDto, CreditBalanceSummaryDto, and CreditBalanceSummaryInput types
  • Added: CreditBalanceSummary query
​
2025-08-05
  • Initial v3 release
​
2025-06-26
  • Added: getSubscriptions endpoint that allows retrieving all of customers’ subscriptions
​
2025-02-23
  • Added: SubscriptionFragmentLatestInvoice.attemptCount
​
2025-01-21
  • Added: ImportSubscriptionInput.subscriptionId
​
2025-01-19
  • Added: importSubscriptionInput.salesforceId, importCustomerInput.salesforceId
​
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.
​
2024-12-15
  • Added: getActiveSubscriptionsList_trialConfiguration and getActiveSubscriptionsList_trialConfiguration_trialEndDate
​
2024-12-08
  • Added: ability to override prices when there’s a scheduled update in place
​
2024-12-03
  • Added: TrialConfiguration to getActiveSubscriptions()
​
2024-12-02
  • Added: validation that coupon name does not exceed 40 characters
​
2024-12-02
  • Added: SubscriptionCoupon.amountsOff
  • Added: SubscriptionCoupon.description
  • Added: SubscriptionCoupon.durationInMonths
  • Added: SubscriptionCoupon.name
  • Added: SubscriptionCoupon.percentOff
​
2024-12-01
  • Added: EstimateSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior
  • Added: PreviewSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior
​
2024-11-24
  • Added: EstimateSubscriptionInput.TrialOverrideConfigurationInput.trialEndDate
  • Added: PreviewSubscriptionInput.TrialOverrideConfigurationInput.trialEndDate
​
2024-11-24
  • Added: support for price localization in fixed fee coupons
​
2024-11-18
  • Added: ability to remove customer’s email address by passing an empty string on updateCustomer.email
​
2024-11-18
  • Added: DelegateSubscriptionToCustomer()
  • Added: TransferSubscriptionToResource()
  • ⚠️ Deprecated: TransferSubscriptin() method (please use TransferSubscriptionToResource() instead)
​
2024-11-05
  • Added: UsageHistoryFragment.Markers to reflect information about the reset usage dates
​
2024-11-04
  • Fixed: issue where customer.discount.deleted event from Stripe isn’t handled properly
​
2024-10-31
  • Added: ability to set any date in the SubscriptionFragment.trialEndDate
​
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
​
2024-10-13
  • Added: raise error when sync to Stripe fails due to unrecognized customer billing address
​
2024-10-06
  • Added: ability to more easily determine the usage period of metered entitlements using:
    • Entitlement.UsagePeriodStart
    • Entitlement.UsagePeriodEnd
  • ⚠️ Deprecated: Entitlement.nextResetDate field
​
2024-09-19
  • Added: raise error when attempting to import a customer with an existing BillingID
​
2024-09-17
  • Added: CustomerPortalSubscription.PlanID
​
2024-09-11
  • Added: SubscriptionCouponInput.BillingCouponID
  • ⚠️ Deprecated: ProvisionSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: UpdateSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: ApplySubscriptionInput.PromotionCode
  • ⚠️ Deprecated: PreviewSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: EstimateSubscriptionInput.PromotionCode
  • ⚠️ Deprecated: EstimateSubscriptionUpdateInput.PromotionCode
​
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
​
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
​
2024-08-20
  • Changed: ImportCustomerBulk changed to ImportCustomerBulkInput
​
2024-08-07
  • Added: ability to undo subscription scheduled cancelation using CancelSubscriptionUpdates()
​
2024-08-07
  • Added: ability to preview a subscription’s upcoming invoice using PreviewNextInvoice()
​
2024-07-07
  • Changed: FetchUsageHistory() now returns the precise timestamp when the usage was reset
​
2024-07-01
  • Changed: UpdateSubscriptionInput.SubscriptionEntitlements does not require the full list of entitlements when needing to add or update specific entitlements
​
2024-06-27
  • Added: TrialOverrideConfigurationInput.TrialEndDate to allow scheduled trial cancelation when provisioning and updating subscriptions
​
2024-06-20
  • Added: ability to get the list of active subscriptions from Edge using GetActiveSubscriptionList()
​
2024-06-16
  • Added: ability to get the list of active subscriptions using GetActiveSubscriptions()
​
2024-01-26
🛑 Breaking change
  • Changed: For Volume/tiered pricing, unitPrice was moved to flatPrice.