Preview

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

updateSubscriptionAttributes

Update subscription attributes (e.g., label).

This page contains

    Authorization Rules

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

    Scopes

    billing.subscription.write.self

    billing.subscription.write.account

    billing.subscription.write.tenant

    billing.subscription.write.instance

    ROLE_USER

    ROLE_SYS_ADMIN

    ROLE_BILLING_ADMIN

    ROLE_CHANNEL_ADMIN

    ROLE_PARTNER

    ROLE_SUPER_USER

    Arguments

    input SubscriptionAttributeUpdateInput! PREVIEW

    SubscriptionAttributeUpdateInput fields

    subscriptionId ID!

    The subscription ID to update

    label String

    The label to set for the subscription. Omit for no label change.

    salesRepUserId ID

    Sales rep user ID. Omit for no sales-rep change; set both IDs to assign or change; null with salesRepAccountId null to remove.

    salesRepAccountId ID

    Sales rep account ID. Omit for no sales-rep change; set both IDs to assign or change; null with salesRepUserId null to remove.

    Return Fields

    subscriptionId ID!

    The subscription ID that was updated

    label String

    The updated label value

    salesRepUserId ID

    Updated sales rep user ID, if returned by the update operation.

    salesRepAccountId ID

    Updated sales rep account ID, if returned by the update operation.

    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.