Go SDK - Stigg Documentation

2026-10-11

Added: DefaultPaymentMethodCardBrand and DefaultPaymentMethodWalletType on Customer and the customer fragment, so customer queries return the default payment method’s card brand and wallet type. DefaultPaymentMethodCardBrand is the card brand reported by the billing provider, for example visa, mastercard or amex. DefaultPaymentMethodWalletType is the digital wallet the card was added through, for example apple_pay or google_pay. Both are nil when the billing provider doesn’t report them, so a nil DefaultPaymentMethodWalletType doesn’t prove the card is a regular one: cards saved before this field existed have no value.

2026-10-11

No functional change to the Go SDK. This release only bumped the package version to track releases of other packages in the monorepo.

2026-08-31

Edge API routing for cacheable reads

Added: GetPaywall (public only), GetEntitlements, GetEntitlement, GetEntitlementsState and GetActiveSubscriptionsList are now served from the Edge API (https://edge.api.stigg.io) instead of the GraphQL API, which is significantly faster for cacheable reads. Routing is transparent — request and response types are unchanged, and no code change is needed to benefit from it.
Note: callers behind an egress allowlist need edge.api.stigg.io permitted.

Client initialization

Changed: the module path is now github.com/stiggio/api-client-go/v7. Update the import and go.mod first — keeping the old path keeps you on the previous major.

Changed: NewStiggClient takes the API key followed by an optional ClientConfig, replacing the three positional arguments. Together with the import, this is the whole migration:

// before
client := stigg.NewStiggClient(apiKey, nil, nil)
client := stigg.NewStiggClient(apiKey, httpClient, baseUrl)

// after
client := stigg.NewStiggClient(apiKey)
client := stigg.NewStiggClient(apiKey, stigg.ClientConfig{
  HttpClient: httpClient, // optional, was the 2nd argument
})

ApiUrl replaces the old *string base URL and is a plain string, so set it only when you were passing a non-nil base URL:

cfg := stigg.ClientConfig{HttpClient: httpClient}
if baseUrl != nil {
  cfg.ApiUrl = *baseUrl
}
client := stigg.NewStiggClient(apiKey, cfg)

Leave ApiUrl empty for the default endpoint.

2026-08-05

Added: EventCount field on GetCreditUsage series and points, with the number of distinct usage events that consumed credits.

2026-07-22

Added: optional EventType filter on GetCreditLedger, to return only the given ledger event types.

2026-07-14

Added: RECEIVED and STRIPE_INVOICING billing vendor identifier values.

2026-07-14

Credit cost estimation

Added: EstimateEventCost and EstimateUsageCost queries to preview the credits a usage event or usage report would consume, without persisting any data or affecting balances.

2026-07-14

Added: Consumed field on the Credit struct returned by ReportUsage, with the credits deducted by that call.

2026-07-09

Added: optional IdempotencyKey parameter on ReportUsage, to safely retry usage reports without double-counting.

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-24

Added: PreviewNextInvoice on customer portal subscriptions, with the next invoice’s total, amount due and per-line usage quantities.

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-14

Added: CancellationDate on the provision and update subscription inputs, to schedule a cancellation on a specific date. On update, passing null clears a scheduled cancellation.

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-22

Added: OVERDRAFT credit grant type.

2026-03-19

Added: DependencyFeature on package entitlements, the feature a credit entitlement depends on (for example seats).
⚠️ Deprecated: Dependency on package entitlements (use DependencyFeature instead).
Added: Entitlements on the subscription import input, accepting both feature and credit entitlements.

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-03-11

Added: BillingCadence, CustomCurrency (display name and units) and TopUpCustomCurrencyId on paywall prices, for plans with credit charges.

2026-03-09

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-03-05

Added: CREDITS_UPDATED value to CreditLedgerEventType

2026-03-05

Added: IncludeHistoricalUsage to UsageHistoryV2Input

2026-03-02

Added: BillingCycleAnchor to ApplySubscriptionInput, PreviewSubscriptionInput, ProvisionCustomerSubscriptionInput, ProvisionSubscriptionInput, SubscriptionInput and UpdateSubscriptionInput

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-09

⚠️ Removed: Behavior from PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
⚠️ Removed: DisplayNameOverride from PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
⚠️ Removed: EnumValues from PackageFeatureEntitlementFragment
⚠️ Removed: HasUnlimitedUsage from PackageFeatureEntitlementFragment
⚠️ Removed: HiddenFromWidgets from PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
⚠️ Removed: IsCustom from PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
⚠️ Removed: Order from PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
⚠️ Removed: ResetPeriod from PackageFeatureEntitlementFragment
⚠️ Removed: MONTH and YEAR values from CreditCadence
⚠️ Removed: Increment and Override values from EntitlementBehavior

2026-02-09

Added: Behavior to PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
Added: DisplayNameOverride to PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
Added: EnumValues to PackageFeatureEntitlementFragment
Added: HasUnlimitedUsage to PackageFeatureEntitlementFragment
Added: HiddenFromWidgets to PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
Added: IsCustom to PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
Added: Order to PackageCreditEntitlementFragment and PackageFeatureEntitlementFragment
Added: ResetPeriod to PackageFeatureEntitlementFragment
Added: MONTH and YEAR values to CreditCadence
Added: Increment and Override values to EntitlementBehavior

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-07-30

Added: EnumValues to GrantPromotionalEntitlementInput

2025-07-30

Added: EnumValues to PackageEntitlementFragment

2025-07-16

Added: EnumValues to EntitlementFragment
Added: RequestedValues to EntitlementCheckRequested and EntitlementFragment
Added: RequestedValuesMismatch value to AccessDeniedReason

2025-07-15

Added: FeatureTypeMismatch value to AccessDeniedReason

2025-07-13

Added: ENUM value to FeatureType

2025-06-30

Added: HiddenFromWidgets to AddonFragment

2025-06-26

Added: getSubscriptions endpoint that allows retrieving all of customers’ subscriptions

2025-06-25

Added: GetSubscriptions method
⚠️ Removed: Subscriptions method

2025-06-24

Added: Subscriptions method
Added: Addons to SubscriptionQueryFragment
Added: CurrentBillingPeriodEnd to SubscriptionQueryFragment
Added: EndCursor to PageInfoFragment
Added: HasNextPage to PageInfoFragment
Added: HasPreviousPage to PageInfoFragment
Added: PayingCustomer to SubscriptionQueryFragment
Added: StartCursor to PageInfoFragment
Added: SubscriptionID to SubscriptionQueryFragment

2025-06-19

Added: BRL value to Currency

2025-04-15

Added: DefaultPaymentMethodType to CustomerFragment, CustomerPortalBillingInformationFragment and CustomerWithSubscriptionsFragment
Added: BANK, CARD and CASH_APP values to PaymentMethodType

2025-03-20

Added: BillingInfoMetadata value to SubscriptionScheduleType

2025-02-23

Added: SubscriptionFragmentLatestInvoice.attemptCount

2025-02-17

Added: ProductID to CheckoutStateInput

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-05

Added: PriceOverride value to SubscriptionScheduleType

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: AmountsOff to SubscriptionCouponDiscountInput
Added: Discount to SubscriptionCouponInput
Added: DurationInMonths to SubscriptionCouponDiscountInput
Added: Name to SubscriptionCouponDiscountInput
Added: PercentOff to SubscriptionCouponDiscountInput

2024-12-01

Added: EstimateSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior
Added: PreviewSubscriptionInput.TrialOverrideConfigurationInput.trialEndBehavior

2024-12-01

Added: Configuration to SubscriptionCouponInput

2024-11-28

Added: BlockSize to CustomerPortalSubscriptionPriceFragment

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-19

⚠️ Removed: AmountsOff from CouponFragment
⚠️ Removed: PercentOff from CouponFragment

2024-11-19

Added: DestinationCustomerID to DelegateSubscriptionToCustomerInput
Added: DestinationResourceID to TransferSubscriptionToResourceInput
Added: SubscriptionID to DelegateSubscriptionToCustomerInput and TransferSubscriptionToResourceInput

2024-11-19

Added: AmountsOff to CouponFragment
Added: PercentOff to CouponFragment

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-07

Added: TrialEndBehavior to SubscriptionInput and TrialOverrideConfigurationInput
Added: CANCEL_SUBSCRIPTION and CONVERT_TO_PAID values to TrialEndBehavior

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-09

Added: YearlyResetPeriodConfig to ResetPeriodConfigurationFragment

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-13

Added: AddonID to PriceOverrideInput

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-23

Added: MINIMUM_SPEND value to BillingModel

2024-07-14

Added: Dimensions to ReportUsageBaseInput and ReportUsageInput

2024-07-07

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

2024-07-04

⚠️ Removed: Customers from CouponFragment

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-06-16

Added: GetSubscription method
Added: SubscriptionID to GetSubscriptionInput

2024-06-16

⚠️ Removed: GetSubscription method
⚠️ Removed: SubscriptionID from GetSubscriptionInput

2024-06-16

Added: GetSubscription method
Added: SubscriptionID to GetSubscriptionInput

2024-06-13

Added: UnitTransformation to FeatureFragment

2024-06-09

Added: NONE value to PaymentCollectionMethod

2024-06-03

Added: Addons to ImportSubscriptionInput
Added: BillableFeatures to ImportSubscriptionInput

2024-05-30

Added: AmountDue to SubscriptionInvoiceFragment
Added: PDFURL to SubscriptionInvoiceFragment
Added: SubTotal to SubscriptionInvoiceFragment
Added: SubTotalExcludingTax to SubscriptionInvoiceFragment
Added: Tax to SubscriptionInvoiceFragment
Added: Total to SubscriptionInvoiceFragment
Added: TotalExcludingTax to SubscriptionInvoiceFragment

2024-05-21

Added: SubscriptionID to SlimSubscriptionFragment

2024-05-01

Added: UpdatedAt to ImportCustomerInput and ImportSubscriptionInput

2024-05-01

Added: BillingReason to SubscriptionInvoiceFragment
Added: BILLING_CYCLE, MANUAL, MINIMUM_INVOICE_AMOUNT_EXCEEDED, OTHER, SUBSCRIPTION_CREATION and SUBSCRIPTION_UPDATE values to SubscriptionInvoiceBillingReason

2024-04-18

Added: MinimumSpend to UpdateSubscriptionInput

2024-04-18

Added: CHARGE and INVOICE values to PaymentCollectionMethod

2024-04-18

Added: Minimum to SubscriptionMinimumSpendValueInput
Added: MinimumSpend to ApplySubscriptionInput, ProvisionCustomerSubscriptionInput, ProvisionSubscriptionInput and SubscriptionInput

2024-04-17

Added: BaseCharge to PriceOverrideInput

2024-04-14

Added: BudgetExceeded value to AccessDeniedReason

2024-04-11

Added: Budget to ApplySubscriptionInput, ProvisionCustomerSubscriptionInput, ProvisionSubscriptionInput, SubscriptionInput and UpdateSubscriptionInput
Added: Limit to BudgetConfigurationInput
⚠️ Removed: BudgetCapConfiguration from ApplySubscriptionInput, ProvisionCustomerSubscriptionInput, ProvisionSubscriptionInput, SubscriptionInput and UpdateSubscriptionInput
⚠️ Removed: Limit from BudgetCapConfigurationInput

2024-04-11

Added: BudgetCapConfiguration to ApplySubscriptionInput, ProvisionCustomerSubscriptionInput, ProvisionSubscriptionInput, SubscriptionInput and UpdateSubscriptionInput
Added: Limit to BudgetCapConfigurationInput

2024-04-10

Added: BlockSize to PriceOverrideInput
Added: FlatPrice to PriceTierInput
Added: PriceOverrides to ApplySubscriptionInput, ProvisionCustomerSubscriptionInput, ProvisionSubscriptionInput, SubscriptionInput and UpdateSubscriptionInput
Added: Tiers to PriceOverrideInput
Added: UnitPrice to PriceTierInput
Added: UpTo to PriceTierInput

2024-04-07

Added: Groups to UsageHistoryFragment

2024-04-01

Added: BlockSize to PriceFragment

2024-03-28

Added: Addons to PlanCompatiblePackageGroupsFragment
Added: CompatiblePackageGroups to PlanFragment
Added: PackageGroupID to PlanCompatiblePackageGroupsFragment

2024-03-27

Added: Dependencies to AddonFragment
Added: RefID to AddonDependencyFragment

2024-03-25

Added: MaxQuantity to AddonFragment

2024-03-21

Added: Prorate to SubscriptionCancellationInput
⚠️ Removed: DontProrate from SubscriptionCancellationInput

2024-03-20

Added: DontProrate to SubscriptionCancellationInput

2024-03-10

Added: SalesforceID to ApplySubscriptionInput, ProvisionCustomerInput, ProvisionCustomerSubscriptionInput, ProvisionSubscriptionInput, SubscriptionInput and UpdateCustomerInput

2024-03-05

Added: ONE_OFF and RECURRING values to BillingCadence

2024-03-04

Added: AddonChangeVariables to ScheduleVariablesFragment
Added: BillingPeriodChangeVariables to ScheduleVariablesFragment
Added: DowngradeChangeVariables to ScheduleVariablesFragment
Added: PlanChangeVariables to ScheduleVariablesFragment
Added: UnitAmountChangeVariables to ScheduleVariablesFragment

2024-03-03

Added: ScheduleStrategy to ApplySubscriptionInput, PreviewSubscriptionInput, ProvisionSubscriptionInput, SubscriptionInput and UpdateSubscriptionInput
Added: END_OF_BILLING_MONTH, END_OF_BILLING_PERIOD and IMMEDIATE values to ScheduleStrategy

2024-02-06

Added: SubscriptionID to SubscriptionFragment

2024-01-29

Added: DetachCustomerPaymentMethod method

2024-01-29

Added: BillingCountryCode to OveragePriceFragment
Added: BillingPeriod to OveragePriceFragment
Added: OveragePrices to AddonFragment and PlanFragment
Added: Tiers to OveragePriceFragment
Added: TiersMode to OveragePriceFragment

2024-01-24

Added: HiddenFromWidgets to PlanFragment
Added: IncludeHiddenPlans to GetPaywallInput

2024-01-22

⚠️ Removed: VOLUME_PER_UNIT value from TiersMode

2024-01-26

🛑 Breaking change

Changed: For Volume/tiered pricing, unitPrice was moved to flatPrice.