createPricingPlan

Creates a pricing plan for the specified edition

This page contains

    Authorization Rules

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

    Scopes

    ROLE_DEVELOPER

    ROLE_CHANNEL_ADMIN

    ROLE_PARTNER

    Arguments

    input CreatePricingPlanInput!

    Attributes to create a pricing plan

    CreatePricingPlanInput fields

    editionId ID!

    Edition reference id to which the pricing plan will be added

    pricingPlan PricingPlanCreateInput

    Details for the pricing plan (Deprecated - Use fields at the root level to set details for the pricing plan)

    billingFrequency PricingDuration PREVIEW

    Length of the billing cycle

    allowCustomUsage Boolean

    If true, reporting metered usage with arbitrary cost and description is allowed

    keepBillingCycleOnUsageChange Boolean

    If true, the billing date for a subscription will not change when a customer updates number of units they have purchased

    keepBillingCycleOnPricingPlanChange Boolean

    If true, the billing date for a subscription will not change when a pricing plan is changed. A pricing plan change takes precedence over a unit quantity or usage change.

    reactivationPeriod NonNegativeInt

    The reactivation period used for domain products

    separatePrepaidOrder Boolean

    If true, all metered usage will be charged at the end of the billing cycle. Any other fees will be pre-paid at the beginning of the billing cycle.

    flatFee PricingPlanFeeInput

    Defines a new price for flat fee of pricing plan

    setupFee PricingPlanFeeInput

    Defines a new price for setup fee of pricing plan

    unitFees [AddPricingPlanUnitFeeInput!]

    Defines the list of unit prices of pricing plan

    contract CreatePricingPlanContractInput

    Defines a contract

    Return Fields

    pricingPlan PricingPlan PREVIEW

    Details of new pricing plan

    userErrors [CreatePricingPlanError!]

    Error details while creating a pricing plan

    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.