Choose a version:

SubscriptionManualDiscount

object

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Custom subscription discount.

Anchor to FieldsFields

Anchor to entitledLinesentitledLines •SubscriptionDiscountEntitledLines!non-null: Entitled line items used to apply the subscription discount on.
Anchor to idid •ID!non-null: The unique ID.
Anchor to recurringCycleLimitrecurringCycleLimit •Int: The maximum number of times the subscription discount will be applied on orders.
Anchor to rejectionReasonrejectionReason •SubscriptionDiscountRejectionReason: The reason that the discount on the subscription draft is rejected.
Anchor to targetTypetargetType •DiscountTargetType!non-null: Type of line the discount applies on.
Anchor to titletitle •String: The title associated with the subscription discount.
Anchor to typetype •DiscountType!non-null: The type of the subscription discount.
Anchor to usageCountusageCount •Int!non-null: The number of times the discount was applied.
Anchor to valuevalue •SubscriptionDiscountValue!non-null: The value of the subscription discount.

Was this section helpful?

•mutation

Adds a subscription discount to a subscription draft.

Anchor to draftIddraftId •ID!required: The ID of the Subscription Contract draft to add a subscription discount to.
Anchor to inputinput •SubscriptionManualDiscountInput!required: The properties of the new Subscription Discount.

Anchor to discountAddeddiscountAdded •SubscriptionManualDiscount: The added Subscription Discount.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

•mutation

Updates a subscription discount on a subscription draft.

Anchor to discountIddiscountId •ID!required: The gid of the Subscription Discount to update.
Anchor to draftIddraftId •ID!required: The ID of the Subscription Contract draft to update a subscription discount on.
Anchor to inputinput •SubscriptionManualDiscountInput!required: The properties to update on the Subscription Discount.

Anchor to discountUpdateddiscountUpdated •SubscriptionManualDiscount: The updated Subscription Discount.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

•mutation

Adds a subscription free shipping discount to a subscription draft.

Anchor to draftIddraftId •ID!required: The ID of the subscription contract draft to add a subscription free shipping discount to.
Anchor to inputinput •SubscriptionFreeShippingDiscountInput!required: The properties of the new subscription free shipping discount.

Anchor to discountAddeddiscountAdded •SubscriptionManualDiscount: The added subscription free shipping discount.
Anchor to draftdraft •SubscriptionDraft: The subscription contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

•mutation

Updates a subscription free shipping discount on a subscription draft.

Anchor to discountIddiscountId •ID!required: The gid of the Subscription Discount to update.
Anchor to draftIddraftId •ID!required: The ID of the Subscription Contract draft to update a subscription discount on.
Anchor to inputinput •SubscriptionFreeShippingDiscountInput!required: The properties to update on the Subscription Free Shipping Discount.

Anchor to discountUpdateddiscountUpdated •SubscriptionManualDiscount: The updated Subscription Discount.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

•mutation

Removes a subscription line from a subscription draft.

Anchor to draftIddraftId •ID!required: The gid of the Subscription Contract draft to remove a subscription line from.
Anchor to lineIdlineId •ID!required: The gid of the Subscription Line to remove.

Anchor to discountsUpdateddiscountsUpdated •[SubscriptionManualDiscount!]: The list of updated subscription discounts impacted by the removed line.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to lineRemovedlineRemoved •SubscriptionLine: The removed Subscription Line.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?