Preview

subscriptionUpdateRequest is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

subscriptionUpdateRequest

Submit a request to update a subscription

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_PARTNER

    ROLE_CHANNEL_ADMIN

    billing.subscription-request.write.tenant

    billing.subscription-request.write.instance

    Arguments

    subscriptionUpdateRequest SubscriptionUpdateRequestInput! PREVIEW

    SubscriptionUpdateRequestInput fields

    idempotencyKey ID!
    subscriptionId ID!
    pricingPlanId ID!
    items [SubscriptionUpdateRequestItemInput!]! PREVIEW
    discountCodes [SubscriptionUpdateRequestDiscountCodeInput!] PREVIEW
    vendorCustomAttributes [SubscriptionUpdateRequestCustomAttributeInput!] PREVIEW
    subscriptionCustomAttributes [SubscriptionUpdateRequestCustomAttributeInput!] PREVIEW
    requester SubscriptionUpdateRequesterInput PREVIEW

    Optional requester information (user ID and account ID) for attribution of the update request. When provided, the requester context is used for the update operation.

    Return Fields

    subscriptionId ID!

    Subscription UUID

    validationErrors [SubscriptionUpdateValidationError!] PREVIEW

    Detail of the errors that happened during the validation process

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.