search
☰

Preview

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

extendFreeTrial

Extend free trial period of subscriptions for an active free trial to a new free trial end date

This page contains

    Authorization Rules

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

    Scopes

    ROLE_PARTNER

    ROLE_CHANNEL_ADMIN

    ROLE_CHANNEL_SUPPORT

    ROLE_SALES_SUPPORT

    Arguments

    input ExtendFreeTrialInput! PREVIEW

    ExtendFreeTrialInput fields

    subscriptionId ID!

    ID of the subscription to extend free trial

    freeTrialExtensionReason String!

    Message indicating the reason for the extension

    freeTrialEndDate Date!

    The new free trial end date (must be greater than today's date)

    Return Fields

    subscription SubscriptionDefinition! PREVIEW

    Subscription that was requested to have free trial extended

    userErrors [ExtendFreeTrialError!] PREVIEW

    List of errors that may have occurred

    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.