Add timestamps, new error enums, analytics currency scopes, updated subscription commit docs

10/1/2026, 7:45:24 PM

This update adds a createdAt timestamp field to a wide set of typesβ€”including CardPaymentDetails, DeliveryCarrierService, DeliveryProfile, DiscountRedeemCode, Domain, FulfillmentLineItem, FulfillmentService, LineItem, Menu, PriceList, ProductOption, TransactionFee, and UrlRedirectβ€”so clients can track when each resource was created. A new object type, AnalyticsSchemaEventCurrencyScope, is introduced to list currencies used in analytics events, and AnalyticsSchemaEventFieldScope now exposes a currencyScopes list of these objects for query validation. Two new enum values are added: BARCODE_DUPLICATE and BARCODE_TOO_LONG to InventoryShipmentCreateInTransitUserErrorCode, and DISCOVERY_CALCULATION_NOT_COMMITTABLE to SubscriptionContractCalculationCommitUserErrorCode, improving error granularity. The mutation subscriptionContractCalculationCommit now includes a note that calculations that only fetch delivery options cannot be committed; a new calculation with a chosen delivery method must be created before commitment. The rollout effectiveTrafficAllocation and trafficAllocation field descriptions have been updated to reflect updated semantics. No new queries or mutations are added, and the overall schema remains backward compatible except for the added fields and improved error codes. Developers should update their schema introspection and handle the new timestamps and error codes accordingly.

Mutation Changes

πŸ”„ Modified Mutations (1)

subscriptionContractCalculationCommit

Commits a succeeded subscription contract calculation. For a create or update calculation, committing makes the calculated contract the contract's new active version used for future billing. For a billing cycle edit, committing applies the calculated contract only to the selected cycle. A calculation that provides fetchAvailableDeliveryOptions only discovered delivery options and can't be committed. Create a new calculation with the chosen delivery method, then commit it.

The calculation must be in a succeeded state, which you can confirm with the subscriptionContractCalculation query. Returns the committed contract as a SubscriptionContract, or a SubscriptionBillingCycleEditedContract for a billing cycle edit.

Learn how to build a subscription contract.

Type Changes

βž• Added Types (1)

πŸ—οΈAnalyticsSchemaEventCurrencyScopeβž• AddedOBJECT

Currencies associated with an analytics event for query validation.

Fields: currencyCodes, eventHandle

πŸ”„ Modified Types (17)

πŸ—οΈAnalyticsSchemaEventFieldScopeπŸ”„ Modified
βž• Field added: currencyScopes

The currencies associated with each event for query validation.

πŸ—οΈCardPaymentDetailsπŸ”„ Modified
βž• Field added: createdAt

The date and time when the card payment details were created.

πŸ—οΈDeliveryCarrierServiceπŸ”„ Modified
βž• Field added: createdAt

The date and time when the carrier service was created.

πŸ—οΈDeliveryProfileπŸ”„ Modified
βž• Field added: createdAt

The date and time when the delivery profile was created.

πŸ—οΈDiscountRedeemCodeπŸ”„ Modified
βž• Field added: createdAt

The date and time when the discount redeem code was created.

πŸ—οΈDomainπŸ”„ Modified
βž• Field added: createdAt

The date and time when the domain was created.

πŸ—οΈFulfillmentLineItemπŸ”„ Modified
βž• Field added: createdAt

The date and time when the fulfillment line item was created.

πŸ—οΈFulfillmentServiceπŸ”„ Modified
βž• Field added: createdAt

The date and time when the fulfillment service was created.

πŸ—οΈInventoryShipmentCreateInTransitUserErrorCodeπŸ”„ Modified
βž• Enum value added: BARCODE_DUPLICATE
βž• Enum value added: BARCODE_TOO_LONG
πŸ—οΈLineItemπŸ”„ Modified
βž• Field added: createdAt

The date and time when the line item was created.

πŸ—οΈMenuπŸ”„ Modified
βž• Field added: createdAt

The date and time when the menu was created.

πŸ—οΈPriceListπŸ”„ Modified
βž• Field added: createdAt

The date and time when the price list was created.

πŸ—οΈProductOptionπŸ”„ Modified
βž• Field added: createdAt

The date and time when the product option was created.

πŸ—οΈRolloutπŸ”„ Modified
πŸ”„ Field modified: effectiveTrafficAllocation
πŸ”„ Field modified: trafficAllocation
πŸ—οΈSubscriptionContractCalculationCommitUserErrorCodeπŸ”„ Modified
βž• Enum value added: DISCOVERY_CALCULATION_NOT_COMMITTABLE
πŸ—οΈTransactionFeeπŸ”„ Modified
βž• Field added: createdAt

The date and time when the transaction fee was created.

πŸ—οΈUrlRedirectπŸ”„ Modified
βž• Field added: createdAt

The date and time when the URL redirect was created.