Skip to main content
​
2026-11-04
  • Added: optional startDate and endDate on v1.credits.listLedger, to return only ledger events with a timestamp in that range. Both are inclusive ISO 8601 dates.
​
2026-10-30
Governance in v1See Governance.
  • Added: the governance methods under v1:
    • v1.customers.entities.retrieve, v1.customers.entities.list, v1.customers.entities.archive and v1.customers.entities.upsert.
    • v1.customers.entities.entitlements.list and v1.customers.entities.entitlements.upsert. An entity entitlement ties an entity to a feature or currency with a usage limit and reset cadence.
    • v1.entityTypes.list, v1.entityTypes.archive and v1.entityTypes.upsert. An entity type with active entities can’t be archived, and v1.entityTypes.checkActiveEntities reports whether any exist across all customers.
  • Added: dimensions on v1.customers.checkEntitlement. Pass the entities the usage is attributed to, and the check also covers their governance budgets. The response then includes chains. See Check.
  • ⚠️ Deprecated: the v1-beta governance methods, in favor of their v1 replacements:
​
2026-10-29
  • Added: salesforceId on customers, the customer’s ID in the Salesforce integration. It’s returned when retrieving or listing customers, and accepted when provisioning, updating or importing them.
  • Added: archivedAt on entity types. v1Beta.entityTypes.list omits archived entity types unless you set includeArchived.
  • Changed: upserting an archived entity or entity type restores it. Upserting an entity whose entity type is archived fails with a 400.
  • ⚠️ Deprecated: v1Beta.customers.entities.unarchive. Upsert the entity to restore it.
​
2026-10-28
  • Fixed: the default base URL is https://edge.api.stigg.io again. Recent releases defaulted to https://api.stigg.io. A base URL you set yourself, in the client options or through STIGG_BASE_URL, is unaffected.
    • Note: callers behind an egress allowlist need edge.api.stigg.io permitted.
​
2026-10-28
  • Added: v1Beta.customers.governance.list (GET /api/v1-beta/customers/{id}/governance), a paginated governance query. It returns each node of the customer’s governance hierarchy with its limit, cadence, scope and current usage, and fetches the next page as you iterate. See Query governance.
  • Added: a before cursor on the governance query, and prev in its pagination, to page backwards.
  • Changed: the governance query’s feature, currency and entity type filters take up to 100 IDs each.
  • Added: EXPIRED status on credit reservations.
​
2026-10-22
Credit reservations
  • Added: reserve credits as part of an entitlement check. Pass reserveAmount and a client-provided reservationId to v1.customers.checkEntitlement for a credit entitlement. The check is decided and the credits held atomically, and requestedUsage is ignored. Retrying with the same reservationId returns the same result.
    • The hold lasts reservationTtlSeconds (1 to 86400, default 3600), or until reservationExpiresAt (at most 24 hours ahead). The two are mutually exclusive.
    • reservationMetadata attaches a JSON-encoded object of string values.
  • Added: v1.credits.reservations.release (POST /api/v1/credits/reservations/{reservationId}/release). It consumes consumedAmount from the credits that backed the reservation and returns the rest to the balance. Any amount above the reservation is consumed normally. Retrying a failed release with the same reservation ID applies it once.
  • Added: CREDITS_RESERVED, CREDITS_RESERVATION_RELEASED and CREDITS_RESERVATION_EXPIRED credit ledger event types. Ledger events gain reservationId, metadata, holdReturnedAmount and a per-grant breakdown, and the ledger list takes a reservationId filter. A reservation event’s amount is its net effect on the balance, so a reserve is negative, and so is a release that consumed more than was held.
Other changes
  • Changed: reported usage values may be fractional. They’re rounded half away from zero to 5 decimal places, and a value with a fractional part must have an absolute value below 2^35 (34,359,738,368). Previously only whole numbers were accepted.
  • Changed: the maximum unit quantity on addon and plan updates is no longer capped at 999,999.
​
2026-10-20
  • Added: reserved, reservedOnExpiredGrants and reservation on credit entitlements, in entitlement check, customer entitlements and subscription provisioning responses. reserved is the credits held by open reservations on active grants. It’s already included in currentUsage, so usageLimit minus currentUsage is still the available balance. reservedOnExpiredGrants is the credits still held on grants that expired during the hold. They can still be released, but aren’t part of the balance. reservation is the reservation the request created, if any.
​
2026-10-15
  • Added: the credit usage groupBy parameter accepts the reserved key featureId, alone or with up to 3 custom dimension keys (for example featureId,userId), to split each series by feature. The feature is returned in each series’ featureId and featureName, not as a tag.
​
2026-10-15
Usage reports, version 2
  • Added: v2.usage.report (POST /api/v2/usage). It reports usage like v1.usage.report, but returns the balance of each credit wallet once, in credits, however many measurements drew from it. Each measurement’s credit holds only the credits that measurement consumed.
  • ⚠️ Deprecated: v1.usage.report. Use v2.usage.report instead.
  • Added: entities on the v2 usage report and credit consumption responses. It lists the current usage of each governance entitlement the request counted towards, and is absent when governance isn’t enabled.
Other changes
  • Added: cardBrand and walletType on the customer’s default payment method, when retrieving or listing customers. cardBrand is the card brand reported by the billing provider, for example visa, mastercard or amex. walletType is the digital wallet the card was added through, for example apple_pay or google_pay. Both are null when the billing provider doesn’t report them.
​
2026-09-29
  • Added: optional contractId when creating a contract. Sending the same ID again returns the existing contract instead of creating a second one.
  • Changed: subscriptions is now optional when creating a contract, so a contract can be created empty and subscriptions attached later.
  • Added: PAYPAL payment method type on customers. The payment method type can now also be null.
  • ⚠️ Changed: the customer integration vendorIdentifier is narrowed to STRIPE, ZUORA, HUBSPOT and AWS_MARKETPLACE.
  • ⚠️ Removed: v1.events.dataExport.mintScopedToken (data export scoped token).
​
2026-09-03
Feature meters
  • Added: meter on features, with an aggregation (SUM, MAX, MIN, AVG, COUNT or UNIQUE, plus an optional field) and filters made of conditions. Returned on feature responses and accepted when creating a feature.
Other changes
  • Added: invoiceId on the next invoice preview of contracts.
  • Added: hasSoftLimit on credit entitlements when provisioning or updating a subscription, and when creating a contract.
​
2026-08-10
  • Added: a published image for running the Stigg MCP server self-hosted.
​
2026-08-10
  • ⚠️ Removed: billingModel and billingCadence fields from OveragePricingModel on addons and plans.
​
2026-08-05
  • Added: displayName field on entities and governance responses.
  • Added: description field on entity types.
​
2026-08-05
  • Added: eventCount field on the retrieve credit usage response.
​
2026-07-28
Contracts
  • Added: a contracts resource, plus a retrieveContracts method on customers. See contracts.
​
2026-07-26
  • Added: creditEntitlement field on overage pricing for addons and plans.
​
2026-07-21
  • Added: syncStates field on credit grants responses.
​
2026-07-21
  • Added: eventType parameter on the list credit ledger endpoint.
​
2026-07-18
  • ⚠️ Moved: the governance retrieval method from v1.events.beta.customers to v1Beta.customers.
​
2026-07-14
  • Added: STRIPE_INVOICING integration type on customers and integrations.
​
2026-07-14
  • Added: estimate methods on customer events and usage.
​
2026-07-12
  • Added: consumed field on credit responses in consumption and usage endpoints.
​
2026-07-08
  • Added: idempotencyKey parameter on the usage report method.
​
2026-07-05
  • ⚠️ Changed: capabilityId replaced with currencyId/featureId in the assignments list response.
​
2026-07-05
  • ⚠️ Renamed: entityType/typeId/typeRefId to entityTypeId in entities and governance responses.
​
2026-07-08
Direct credit consumption
  • Added: an endpoint to consume credits directly from a customer’s pool, without reporting usage against a metered feature or requiring an active subscription. Complements the existing grant-credits endpoint so credit balances, grants, and consumption can be managed fully decoupled from Stigg subscription management. See direct credit consumption.
  • The check-entitlement endpoint continues to return a valid credit balance for customers with no active subscription.
​
2026-06-30
  • Added: AIRWALLEX to the vendorIdentifier enum on customer endpoints.
​
2026-06-23
  • Added: v1.events.dataExport.destinations.update (update data-export destination selection), PATCH /api/v1/data-export/destinations/{destinationId}.
​
2026-06-23
  • Added: usagePeriodEnd in credit field on the v1.usage.report response.
​
2026-06-23
Credit wallet soft limit
  • Added: hasSoftLimit field on credit entitlements in addons and plans. When a credit entitlement is configured as a soft limit, the check-entitlement endpoint returns hasAccess: true and hasSoftLimit: true even after the credit balance reaches zero. Hard limit (the default) continues to return hasAccess: false when the balance is exhausted.
​
2026-06-22
  • Added: salesforceId field on the v1.subscriptions.update request.
​
2026-06-21
  • Added: v1.events.dataExport.listModels (list data-export models), GET /api/v1/data-export/models.
  • Added: enabledModels field on the v1.events.dataExport.destinations.create and v1.events.dataExport.mintScopedToken requests.
  • Added: enabledModels in destinations field on the v1.events.dataExport.destinations.delete and v1.events.dataExport.destinations.create responses.
​
2026-06-21
  • ⚠️ Removed: MONTH from the cadence enum on customer endpoints.
​
2026-06-18
  • Added: v1.events.beta.customers.retrieveGovernance (get a list of governance nodes), GET /api/v1-beta/customers/{id}/governance.
​
2026-06-11
  • Added: scopeEntityIds in chains field on the v1Beta.customers.entitlements.check response.
​
2026-06-10
  • Added: currencyId, featureId, parentId and scopeEntityIds in assignments fields on the v1Beta.customers.assignments.upsert request.
  • Added: currencyId, featureId, parentId and scopeEntityIds fields on the v1Beta.customers.assignments.list and v1Beta.customers.assignments.upsert responses.
  • ⚠️ Removed: capabilityId in assignments field from the v1Beta.customers.assignments.upsert request.
  • ⚠️ Removed: capabilityId field from the v1Beta.customers.assignments.list and v1Beta.customers.assignments.upsert responses.
​
2026-06-08
  • Added: connectionStatus and lastSyncStatus in destinations fields on the v1.events.dataExport.destinations.delete and v1.events.dataExport.destinations.create responses.
​
2026-06-07
  • Added: cancellationDate field on the v1.subscriptions.update and v1.subscriptions.provision requests.
​
2026-06-04
  • Added: v1.events.dataExport.destinations.delete (remove data-export destination), DELETE /api/v1/data-export/destinations/{destinationId}.
  • Added: v1.events.dataExport.destinations.create (add data-export destination), POST /api/v1/data-export/destinations.
  • Added: v1.events.dataExport.mintScopedToken (mint data-export scoped token), POST /api/v1/data-export/scoped-token.
  • Added: v1.events.dataExport.triggerSync (trigger data-export sync), POST /api/v1/data-export/sync.
​
2026-06-01
Credit usage breakdown by event dimensions
  • Added: groupBy array parameter on the retrieve credit usage endpoint 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-06-01
  • Added: PREQUEL to the vendorIdentifier enum on customer endpoints.
​
2026-05-28
  • Added: RECEIVED to the vendorIdentifier enum on customer endpoints.
​
2026-05-26
  • Added: tags in series field on the v1.credits.getUsage response.
​
2026-05-26
  • Added: v1Beta.customers.assignments.list (get a list of assignments), GET /api/v1-beta/customers/{id}/assignments.
  • Added: v1Beta.customers.assignments.upsert (upsert assignments), PUT /api/v1-beta/customers/{id}/assignments.
​
2026-05-25
  • Added: v1Beta.entities.list (get a list of entitys), GET /api/v1-beta/customers/{id}/entities.
  • Added: v1Beta.entities.retrieve (get a single entity by ID), GET /api/v1-beta/customers/{id}/entities/{entityId}.
  • Added: v1Beta.entities.archive (archive entities), POST /api/v1-beta/customers/{id}/entities/archive.
  • Added: v1Beta.entities.unarchive (unarchive entities), POST /api/v1-beta/customers/{id}/entities/unarchive.
  • Added: v1Beta.entities.upsert (upsert entities), PUT /api/v1-beta/customers/{id}/entities.
​
2026-05-24
  • Added: v1Beta.entityTypes.list (get a list of entity types), GET /api/v1-beta/entity-types.
  • Added: v1Beta.entityTypes.upsert (upsert entity types), PUT /api/v1-beta/entity-types.
​
2026-05-21
  • Added: v1.events.beta.customers.entitlements.check (check entitlement (beta)), GET /api/v1-beta/customers/{id}/entitlements/check.
​
2026-05-18
  • Added: v1.addons.listCharges (list addon charges), GET /api/v1/addons/{id}/charges.
  • Added: v1.plans.listCharges (list plan charges), GET /api/v1/plans/{id}/charges.
  • Added: v1.plans.listOverageCharges (list plan overage charges), GET /api/v1/plans/{id}/overage-charges.
​
2026-05-12
  • Added: v1.events.credits.customCurrencies.list (get a list of custom currencys), GET /api/v1/credits/custom-currencies.
  • Added: v1.events.credits.customCurrencies.listAssociatedEntities (list custom currency associated entities), GET /api/v1/credits/custom-currencies/{currencyId}/associated-entities.
  • Added: v1.events.credits.customCurrencies.update (update custom currency), PATCH /api/v1/credits/custom-currencies/{currencyId}.
  • Added: v1.events.credits.customCurrencies.create (create custom currency), POST /api/v1/credits/custom-currencies.
  • Added: v1.events.credits.customCurrencies.archive (archive custom currency), POST /api/v1/credits/custom-currencies/{currencyId}/archive.
  • Added: v1.events.credits.customCurrencies.unarchive (unarchive custom currency), POST /api/v1/credits/custom-currencies/{currencyId}/unarchive.
  • Added: BOOLEAN, ENUM and NUMBER to the featureType enum on v1.features.listFeatures.
  • Added: FLUCTUATING, INCREMENTAL and None to the meterType enum on v1.features.listFeatures.
  • Added: CUSTOM, FREE and PAID to the pricingType enum on v1.subscriptions.list.
  • Added: ACTIVE, ARCHIVED, Active, CANCELED, DRAFT, EXPIRED, Expired, IN_TRIAL, NEW and NOT_STARTED and more to the status enum on addon, coupon, customer, feature, plan, product and subscription endpoints.
  • Added: APP_STORE, AUTH0, AWS_MARKETPLACE, BIG_QUERY, HUBSPOT, OPEN_FGA, SALESFORCE, SNOWFLAKE, STRIPE and ZUORA to the vendorIdentifier enum on v1.customers.integrations.list.
​
2026-05-06
  • ⚠️ Removed: OVERDRAFT and RECURRING from the grantType enum on v1.events.credits.grants.create.
​
2026-05-06
  • Added: v1.customers.checkEntitlement (check entitlement), GET /api/v1/customers/{id}/entitlements/check.
​
2026-04-30
  • ⚠️ Removed: Delete event queue, DELETE /internal/beta/event-queues/{queueName}.
  • ⚠️ Removed: Get a list of event queues, GET /internal/beta/event-queues.
  • ⚠️ Removed: Get a single event queue by ID, GET /internal/beta/event-queues/{queueName}.
  • ⚠️ Removed: Update a event queue, PATCH /internal/beta/event-queues/{queueName}.
  • ⚠️ Removed: Provision event queue, POST /internal/beta/event-queues/provision.
​
2026-05-10
Credit usage date filters
  • Added: startDate and endDate parameters on the retrieve credit usage endpoint. 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-04-16
  • Added: DATA_EXPORT_SYNC_FAILED and INCOMING_AIRBYTE_WEBHOOK to the eventTypes enum on internal.beta.eventQueues.update and internal.beta.eventQueues.provision.
​
2026-04-15
  • Added: CUSTOM_CURRENCY_ARCHIVED, CUSTOM_CURRENCY_CREATED, CUSTOM_CURRENCY_UNARCHIVED and CUSTOM_CURRENCY_UPDATED to the eventTypes enum on internal.beta.eventQueues.update and internal.beta.eventQueues.provision.
​
2026-04-14
  • ⚠️ Removed: includeInactiveSubscriptions query parameter from v1.usage.history.
  • Added: EDGE_API_CUSTOM_CURRENCY_CACHE_DATA_RESYNC to the eventTypes enum on internal.beta.eventQueues.update and internal.beta.eventQueues.provision.
​
2026-04-07
  • Added: v1.customers.integrations.unlink (unlink customer integration), DELETE /api/v1/customers/{id}/integrations/{integrationId}.
  • Added: internal.beta.eventQueues.delete (delete event queue), DELETE /internal/beta/event-queues/{queueName}.
  • Added: v1.customers.integrations.list (get a list of customer integrations), GET /api/v1/customers/{id}/integrations.
  • Added: v1.customers.integrations.retrieve (get a single customer integration by ID), GET /api/v1/customers/{id}/integrations/{integrationId}.
  • Added: internal.beta.eventQueues.list (get a list of event queues), GET /internal/beta/event-queues.
  • Added: internal.beta.eventQueues.retrieve (get a single event queue by ID), GET /internal/beta/event-queues/{queueName}.
  • Added: v1.customers.integrations.update (update a customer integration), PATCH /api/v1/customers/{id}/integrations/{integrationId}.
  • Added: internal.beta.eventQueues.update (update a event queue), PATCH /internal/beta/event-queues/{queueName}.
  • Added: v1.customers.integrations.link (link customer integration), POST /api/v1/customers/{id}/integrations.
  • Added: internal.beta.eventQueues.provision (provision event queue), POST /internal/beta/event-queues/provision.
​
2026-03-18
  • Added: OVERDRAFT to the grantType enum on credit endpoints.
​
2026-03-18
  • ⚠️ Removed: Delete event queue, DELETE /api/v1/event-queues/{queueName}.
  • ⚠️ Removed: Get a list of event queues, GET /api/v1/event-queues.
  • ⚠️ Removed: Get a single event queue by ID, GET /api/v1/event-queues/{queueName}.
  • ⚠️ Removed: Update a event queue, PATCH /api/v1/event-queues/{queueName}.
  • ⚠️ Removed: Provision event queue, POST /api/v1/event-queues/provision.
  • ⚠️ Removed: Set addon pricing, PUT /api/v1/addons/{id}/charges.
  • ⚠️ Removed: Set plan pricing, PUT /api/v1/plans/{id}/charges.
  • Added: charges field on the v1.addons.update and v1.plans.update requests.
  • Added: dependencyFeatureId field on the v1.addons.entitlements.update and v1.plans.entitlements.update requests.
  • Added: dependencyFeatureId in entitlements field on the v1.addons.entitlements.create and v1.plans.entitlements.create requests.
  • Added: targetId field on the v1.products.duplicateProduct request.
  • Added: dependencyFeatureId field on addon and plan responses (8 endpoints).
  • Added: metadata in entitlements.currency; id in entitlements.feature fields on the v1.customers.retrieveEntitlements and v1.subscriptions.provision responses.
  • ⚠️ Removed: id field from the v1.products.duplicateProduct request.
  • ⚠️ Removed: additionalMetaData in entitlements.currency; refId in entitlements.feature fields from the v1.customers.retrieveEntitlements and v1.subscriptions.provision responses.
  • Added: CREDITS_CONSUMPTION_TRANSFER_SOURCE and CREDITS_CONSUMPTION_TRANSFER_TARGET to the eventType enum on v1.events.credits.listLedger.
​
2026-03-16
  • Added: Delete event queue, DELETE /api/v1/event-queues/{queueName}.
  • Added: billingCurrency, language, passthrough and timezone fields on the v1.customers.update and v1.customers.provision requests.
  • Added: billingCurrency, language, passthrough and timezone fields on customer responses (8 endpoints).
  • Added: EVENT_QUEUE_DEPROVISIONING_REQUESTED to the eventTypes enum on update a event queue and provision event queue.
  • Added: DEPROVISIONING to the status enum on event queue endpoints.
​
2026-03-12
  • Added: v1.customers.retrieveEntitlements (get entitlements state), GET /api/v1/customers/{id}/entitlements.
  • Added: Get a list of event queues, GET /api/v1/event-queues.
  • Added: Get a single event queue by ID, GET /api/v1/event-queues/{queueName}.
  • Added: Update a event queue, PATCH /api/v1/event-queues/{queueName}.
  • Added: Provision event queue, POST /api/v1/event-queues/provision.
  • Added: billingId and salesforceId in customers; integrationId fields on the v1.customers.import request.
​
2026-03-09
  • Added: amount, behavior, cadence, description, displayNameOverride, enumValues, hasSoftLimit and hasUnlimitedUsage and 10 more fields on the v1.addons.entitlements.update and v1.plans.entitlements.update requests.
  • Added: billingId field on the v1.customers.update and v1.customers.provision requests.
  • Added: amount, behavior, cadence, description, displayNameOverride, enumValues, hasSoftLimit and hasUnlimitedUsage and 11 more in entitlements fields on the v1.addons.entitlements.create and v1.plans.entitlements.create requests.
  • Added: amount, cadence, hasSoftLimit, hasUnlimitedUsage, id, monthlyResetPeriodConfiguration, resetPeriod and type and 3 more in entitlements fields on the v1.subscriptions.update and v1.subscriptions.provision requests.
  • Added: includeInactiveSubscriptions query parameter on v1.usage.history.
  • Added: billingId field on customer responses (8 endpoints).
  • Added: metadata field on coupon responses (5 endpoints).
  • ⚠️ Removed: credit and feature fields from the v1.addons.entitlements.update and v1.plans.entitlements.update requests.
  • ⚠️ Removed: credit and feature in entitlements fields from addon, plan and subscription requests (4 endpoints).
  • ⚠️ Removed: includeHistoricalUsage query parameter from v1.usage.history.
  • ⚠️ Removed: customCurrencyId and featureId fields from addon and plan responses (8 endpoints).
​
2026-03-08
  • ⚠️ Removed: subscriptionEntitlements field from the v1.subscriptions.update and v1.subscriptions.provision requests.
​
2026-03-05
  • Added: includeHistoricalUsage query parameter on v1.usage.history.
  • Added: CREDITS_UPDATED to the eventType enum on v1.credits.listLedger.
​
2026-03-05
  • Added: status field on the v1.addons.update request.
​
2026-03-04
  • Added: v1.credits.getAutoRecharge (get automatic recharge configuration), GET /api/v1/credits/auto-recharge.
  • Added: v1.credits.getUsage (get credit usage), GET /api/v1/credits/usage.
  • Added: v1.credits.grants.create (create a credit grant), POST /api/v1/credits/grants.
  • Added: v1.credits.grants.void (void credit grant), POST /api/v1/credits/grants/{id}/void.
  • Added: amount and currency in minimumSpend; amount, billingCountryCode and currency in priceOverrides fields on the v1.subscriptions.provision request.
  • Added: amount and currency in minimumSpend; amount and currency in priceOverrides fields on the v1.subscriptions.update request.
  • Added: billingCycleAnchor, budget, coupons, futureUpdates, latestInvoice, minimumSpend, subscriptionEntitlements and trial; addonId, amount, baseCharge, billingCountryCode, blockSize, currency, featureId and tiers in prices fields on subscription responses (7 endpoints).
  • Added: billingCycleAnchor, budget, coupons, futureUpdates, latestInvoice, minimumSpend, subscriptionEntitlements and trial in subscription; amount, billingCountryCode and currency in subscription.prices fields on the v1.subscriptions.provision response.
  • ⚠️ Removed: minimum in minimumSpend; price in priceOverrides fields from the v1.subscriptions.update request.
  • ⚠️ Removed: minimum in minimumSpend; price in priceOverrides; billingCountryCode in priceOverrides.tiers.flatPrice; billingCountryCode in priceOverrides.tiers.unitPrice fields from the v1.subscriptions.provision request.
  • ⚠️ Removed: createdAt, id and updatedAt in prices fields from subscription responses (7 endpoints).
  • ⚠️ Removed: price in subscription.prices field from the v1.subscriptions.provision response.
​
2026-03-02
  • Added: v1.credits.grants.list (get a list of credit grants), GET /api/v1/credits/grants.
  • Added: v1.credits.listLedger (get a list of credit ledger events), GET /api/v1/credits/ledger.
  • Added: id in addons field on the v1.subscriptions.update, v1.subscriptions.provision and v1.subscriptions.preview requests.
  • Added: addons, billingPeriod and charges in subscriptions fields on the v1.subscriptions.import request.
  • Added: id in freeItems field on the v1.subscriptions.preview response.
  • ⚠️ Removed: addonId in addons field from the v1.subscriptions.update, v1.subscriptions.provision and v1.subscriptions.preview requests.
  • ⚠️ Removed: addonId in freeItems field from the v1.subscriptions.preview response.
​
2026-02-26
  • Added: v1.addons.entitlements.delete (delete addon entitlement), DELETE /api/v1/addons/{addonId}/entitlements/{id}.
  • Added: v1.plans.removeDraft (remove plan draft), DELETE /api/v1/plans/{id}/draft.
  • Added: v1.plans.entitlements.delete (delete plan entitlement), DELETE /api/v1/plans/{planId}/entitlements/{id}.
  • Added: v1.addons.entitlements.list (get a list of addon entitlements), GET /api/v1/addons/{addonId}/entitlements.
  • Added: v1.plans.entitlements.list (get a list of plan entitlements), GET /api/v1/plans/{planId}/entitlements.
  • Added: v1.addons.entitlements.update (update a addon entitlement), PATCH /api/v1/addons/{addonId}/entitlements/{id}.
  • Added: v1.plans.update (update a plan), PATCH /api/v1/plans/{id}.
  • Added: v1.plans.entitlements.update (update a plan entitlement), PATCH /api/v1/plans/{planId}/entitlements/{id}.
  • Added: v1.addons.entitlements.create (create addon entitlements), POST /api/v1/addons/{addonId}/entitlements.
  • Added: v1.plans.archive (archive plan), POST /api/v1/plans/{id}/archive.
  • Added: v1.plans.createDraft (create plan draft), POST /api/v1/plans/{id}/draft.
  • Added: v1.plans.publish (publish plan), POST /api/v1/plans/{id}/publish.
  • Added: v1.plans.entitlements.create (create plan entitlements), POST /api/v1/plans/{planId}/entitlements.
  • Added: v1.addons.setPricing (set addon pricing), PUT /api/v1/addons/{id}/charges.
  • Added: v1.plans.setPricing (set plan pricing), PUT /api/v1/plans/{id}/charges.
  • Added: defaultTrialConfig field on the v1.plans.create request.
  • Added: compatibleAddonIds and defaultTrialConfig fields on the v1.plans.list, v1.plans.retrieve and v1.plans.create responses.
  • Added: additionalMetaData, description, displayName, unitPlural and unitSingular in entitlements.currency fields on the v1.subscriptions.provision response.
​
2026-02-18
  • Added: id field on the v1.products.duplicateProduct request.
​
2026-02-18
  • ⚠️ Removed: Revoke promotional entitlement, DELETE /api/v1/customers/{customerId}/promotional/{featureId}.
  • Added: v1.customers.promotionalEntitlements.revoke (revoke promotional entitlement), DELETE /api/v1/customers/{id}/promotional-entitlements/{featureId}.
  • Added: v1.customers.promotionalEntitlements.list (get a list of promotional entitlements), GET /api/v1/customers/{id}/promotional-entitlements.
  • Added: v1.events.plans.list (get a list of plans), GET /api/v1/plans.
  • Added: v1.events.plans.retrieve (get a single plan by ID), GET /api/v1/plans/{id}.
  • ⚠️ Removed: Create a promotional entitlements, POST /api/v1/customers/{customerId}/promotional.
  • Added: v1.customers.promotionalEntitlements.create (create a promotional entitlements), POST /api/v1/customers/{id}/promotional-entitlements.
  • Added: v1.events.plans.create (create plan), POST /api/v1/plans.
  • Added: productId field on addon responses (6 endpoints).
  • ⚠️ Removed: id field from the v1.products.duplicateProduct request.
  • ⚠️ Removed: ARCHIVED, DRAFT and PUBLISHED from the status enum on v1.events.addons.listAddons.
​
2026-02-17
  • Added: v1.addons.removeDraft (remove addon draft), DELETE /api/v1/addons/{id}/draft.
  • Added: v1.addons.list (get a list of addons), GET /api/v1/addons.
  • Added: v1.addons.update (update a addon), PATCH /api/v1/addons/{id}.
  • Added: v1.coupons.updateCoupon (update a coupon), PATCH /api/v1/coupons/{id}.
  • Added: v1.addons.create (create an addon), POST /api/v1/addons.
  • Added: v1.addons.createDraft (create addon draft), POST /api/v1/addons/{id}/draft.
  • Added: v1.addons.publish (publish addon), POST /api/v1/addons/{id}/publish.
  • Added: v1.coupons.archiveCoupon (archive coupon), POST /api/v1/coupons/{id}/archive.
  • Added: metadata field on the v1.coupons.create request.
  • Added: dependencies field on the v1.addons.retrieve and v1.addons.archive responses.
  • ⚠️ Removed: additionalMetaData field from the v1.coupons.create request.
​
2026-02-15
  • Added: v1.addons.retrieve (get a single addon by ID), GET /api/v1/addons/{id}.
  • Added: v1.features.listFeatures (get a list of features), GET /api/v1/features.
  • Added: v1.features.retrieveFeature (get a single feature by ID), GET /api/v1/features/{id}.
  • Added: v1.features.updateFeature (update a feature), PATCH /api/v1/features/{id}.
  • Added: v1.products.updateProduct (update a product), PATCH /api/v1/products/{id}.
  • Added: v1.addons.archive (archive an addon), POST /api/v1/addons/{id}/archive.
  • Added: v1.features.createFeature (create a feature), POST /api/v1/features.
  • Added: v1.features.archiveFeature (archive feature), POST /api/v1/features/{id}/archive.
  • Added: v1.features.unarchiveFeature (unarchive feature), POST /api/v1/features/{id}/unarchive.
  • Added: v1.products.createProduct (create product), POST /api/v1/products.
  • Added: v1.products.archiveProduct (archive product), POST /api/v1/products/{id}/archive.
  • Added: v1.products.duplicateProduct (duplicate product), POST /api/v1/products/{id}/duplicate.
  • Added: v1.products.unarchiveProduct (unarchive product), POST /api/v1/products/{id}/unarchive.
  • Added: v1.subscriptions.invoice.markAsPaid (mark subscription invoice as paid), POST /api/v1/subscriptions/{id}/invoice/paid.
  • Added: v1.subscriptions.usage.chargeUsage (charge subscription usage), POST /api/v1/subscriptions/{id}/usage/charge.
  • Added: v1.subscriptions.usage.sync (trigger subscription usage sync), POST /api/v1/subscriptions/{id}/usage/sync.
  • Added: addonId, baseCharge and currencyId in priceOverrides fields on the v1.subscriptions.update request.
  • Added: createdAt, email and name query parameters on v1.customers.list.
  • Added: createdAt, id and status query parameters on v1.products.listProducts.
  • Added: createdAt, id, status and type query parameters on v1.coupons.list.
  • Added: createdAt, planId, pricingType and resourceId query parameters on v1.subscriptions.list.
  • Added: productSettings field on the v1.products.listProducts response.
​
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-01-29
  • Updated stainless config for API configuration enhancement
​
2026-01-28
  • API updates implementing incremental improvements
​
2026-01-27
  • API updates
  • Improved cursor pagination for enhanced data retrieval
​
2026-01-27
Features:
  • Added customer endpoints
  • Promotional endpoints support
Maintenance:
  • Code formatting improvements for snippet readability
  • CI/CD workflow updates
  • Documentation corrections
  • Dependency upgrades (Babel, qs, js-yaml)
  • SDK configuration refinements