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


Subscription definition

This page contains


    id: ID!

    Subscription Id

    status: SubscriptionStatus! PREVIEW

    Subscription status

    product: Product! PREVIEW

    Product Id

    pricingPlan: PricingPlan! PREVIEW

    Pricing Plan Id

    edition: ProductEdition!

    Edition Id

    contract: Contract PREVIEW


    units: [SubscriptionUnit] PREVIEW


    associations: [AssociationTarget] PREVIEW


    activeCharge: MainBillingCharge! PREVIEW

    Active billing charge


    Parent objects of SubscriptionDefinition

    AssociationTarget PREVIEW
    SubscriptionInfo PREVIEW
    SubscriptionPriceChange PREVIEW

    Preview of the Billing Charge to be created by the price change

    Mutations for SubscriptionDefinition

    extendFreeTrial PREVIEW

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

    requestSubscriptionPriceChange PREVIEW

    Create a price change event for the specific subscription ID, using the provided Price Definition ID and strategy.

    terminateSubscription PREVIEW

    The terminateSubscription mutation will immediately terminate a specified subscription within the marketplace. Upon execution, the subscription is permanently deleted from the marketplace database and cannot be restored. However, it's important to note that while the subscription is terminated on the marketplace side, it may still exist on the vendor side. This mutation should be used with caution due to its irreversible nature.

    Queries for SubscriptionDefinition

    priceChangeBySubscriptionId PREVIEW

    Get price change result for a given subscription id