Subscription Update v2: UI vs API coverage
Use this page when you plan headless or integrated automation next to the storefront and Operations UI. Availability of specific fields (preview vs GA) changes by release; confirm in the schema and with your AppDirect technical representative.
Step-by-step UI behavior is in Update subscriptions v2 and Manage subscriptions (new experience) where relevant.
GraphQL reference: namespaces to use
The GraphQL reference lists all types, queries, and mutations. For Subscription Update v2, start under these namespaces (use the left navigation or in-page search on the reference site):
billing
Typical operations for previews, submitting subscription changes, unit transfer, and related reads:
| Kind | Operations (search in billing) |
|---|---|
| Queries | previewSubscriptionUpdateRequest, subscriptionUpdateRequestStatus, transferUnitEligibleEditions, transferUnitEligibleSubscriptions, previewSubscriptionCancellation, … |
| Mutations | subscriptionUpdateRequest, transferUnits, updateSubscriptionAttributes, requestSubscriptionPriceChange, … |
Related input and payload types in the same schema include names such as SubscriptionUpdateRequestInput, SubscriptionUpdateRequestItemInput, SubscriptionUpdatePreviewResponse, and types for units transfer (for example UnitsTransferSubscriptionUpdateRequest).
checkout
Typical operations for the self-serve cart experience that mirrors the update UI:
| Kind | Operations (search in checkout) |
|---|---|
| Queries | selfServeSubscriptionUpdateCapabilities, subscriptionUpdateCartFields, activeCart, activeCartOfUser, cartFields, cartValidation, … |
| Mutations | addItemsToCart, updateCartItems, finalizeCart, validateCart, updateCartCustomAttributes, … |
reseller experience
Typical operations for assisted subscription updates built on quotes (the quote / opportunity workspace):
| Kind | Operations (search in reseller experience) |
|---|---|
| Queries | quote, quotes, quoteVersion, quoteVersions, quoteSummary, quoteFinalizationStatus, … |
| Mutations | createQuote, updateQuote, updateQuoteItem, updateQuoteVersion, triggerQuoteFinalizationProcess, executeQuoteVersionAction, … |
Other namespaces
Vendor-specific flows (for example Adobe subscription transfer) may appear under additional namespaces in the same reference (for example adobe subscription transfer). Use the schema browser to find the exact operations your integration uses.
Coverage matrix (high level)
| Capability | Self-serve UI | Assisted (quote / opportunity) UI | GraphQL (summary) |
|---|---|---|---|
| Edition / plan change | Yes | Yes | checkout (cart) + billing (subscriptionUpdateRequest path); confirm inputs in reference |
| Seat or quantity change (including +N / −N where offered) | Yes | Yes | checkout (updateCartItems, …) + billing |
| Custom attributes on update | Yes | Yes | SubscriptionUpdateRequest inputs / cart custom attributes in schema |
| Schedule change (immediate, date, end of contract) | Yes (subject to contract rules) | Yes | billing request payloads; validate scheduling fields in reference |
| Only one pending scheduled change at a time (latest wins) | Yes | Yes | Same platform rule; model in your integration against subscriptionUpdateRequestStatus and product rules |
| Unit transfer (partial / full) | When catalog enables | When enabled | billing: transferUnits, transferUnitEligibleEditions, transferUnitEligibleSubscriptions |
| Multi-subscription update in one self-serve session | Requires Manage subscriptions (new experience) | N/A | Multiple cart / request patterns; confirm with reference and representative |
| Update / renewal quotes and customer approval | N/A | Yes | reseller experience quote mutations and queries |
| NCE full and partial upgrades (Microsoft) | Yes | Yes | GraphQL plus Microsoft connector behavior; confirm with connector docs |
| Payment method during update | Yes (marketplace dependent) | Yes | billing payment-related mutations and checkout as applicable |
Related topics
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!