subscriptionDraftDiscountAdd mutation
Adds a subscription discount to a subscription draft.
Required access
write_own_subscription_contracts
access scope.
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.
Arguments
Argument | Description |
---|---|
draftId
(
ID!
)
required
|
The ID of the Subscription Contract draft to add a subscription discount to. |
input
(
SubscriptionManualDiscountInput!
)
required
|
The properties of the new Subscription Discount. |
SubscriptionManualDiscountInput fields
-
entitledLines (
SubscriptionManualDiscountEntitledLinesInput
)Entitled line items used to apply the subscription discount on.
-
recurringCycleLimit (
Int
)The maximum number of times the subscription discount will be applied on orders.
-
title (
String
)The title associated with the subscription discount.
-
Percentage or fixed amount value of the discount.
Return fields
-
discountAdded (
SubscriptionManualDiscount
)The added Subscription Discount.
-
draft (
SubscriptionDraft
)The Subscription Contract draft object.
-
userErrors (
[SubscriptionDraftUserError!]!
)List of errors that occurred executing the mutation.
Adds a subscription discount to a subscription draft.
Required access
write_own_subscription_contracts
access scope.
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.
Arguments
Argument | Description |
---|---|
draftId
(
ID!
)
required
|
The ID of the Subscription Contract draft to add a subscription discount to. |
input
(
SubscriptionManualDiscountInput!
)
required
|
The properties of the new Subscription Discount. |
SubscriptionManualDiscountInput fields
-
entitledLines (
SubscriptionManualDiscountEntitledLinesInput
)Entitled line items used to apply the subscription discount on.
-
recurringCycleLimit (
Int
)The maximum number of times the subscription discount will be applied on orders.
-
title (
String
)The title associated with the subscription discount.
-
Percentage or fixed amount value of the discount.
Return fields
-
discountAdded (
SubscriptionManualDiscount
)The added Subscription Discount.
-
draft (
SubscriptionDraft
)The Subscription Contract draft object.
-
userErrors (
[SubscriptionDraftUserError!]!
)List of errors that occurred executing the mutation.
Adds a subscription discount to a subscription draft.
Required access
write_own_subscription_contracts
access scope.
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.
Arguments
Argument | Description |
---|---|
draftId
(
ID!
)
required
|
The ID of the Subscription Contract draft to add a subscription discount to. |
input
(
SubscriptionManualDiscountInput!
)
required
|
The properties of the new Subscription Discount. |
SubscriptionManualDiscountInput fields
-
entitledLines (
SubscriptionManualDiscountEntitledLinesInput
)Entitled line items used to apply the subscription discount on.
-
recurringCycleLimit (
Int
)The maximum number of times the subscription discount will be applied on orders.
-
title (
String
)The title associated with the subscription discount.
-
Percentage or fixed amount value of the discount.
Return fields
-
discountAdded (
SubscriptionManualDiscount
)The added Subscription Discount.
-
draft (
SubscriptionDraft
)The Subscription Contract draft object.
-
userErrors (
[SubscriptionDraftUserError!]!
)List of errors that occurred executing the mutation.