Skip to main content
Anchor to SubscriptionDiscount

SubscriptionDiscount

union

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Subscription draft discount types.

Anchor to Possible typesPossible types

Anchor to SubscriptionAppliedCodeDiscountSubscriptionAppliedCodeDiscount
•OBJECT

Represents an applied code discount.

Anchor to idid
•ID!
non-null

The unique ID.

Anchor to redeemCoderedeemCode
•String!
non-null

The redeem code of the discount that applies on the subscription.

Anchor to rejectionReasonrejectionReason
•SubscriptionDiscountRejectionReason

The reason that the discount on the subscription draft is rejected.

Anchor to SubscriptionManualDiscountSubscriptionManualDiscount
•OBJECT

Custom subscription discount.

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?

Anchor to Fields with this unionFields with this union

Anchor to SubscriptionDiscountAllocation.discountSubscriptionDiscountAllocation.discount
•OBJECT

Represents what a particular discount reduces from a line price.

Anchor to SubscriptionDiscountConnection.nodesSubscriptionDiscountConnection.nodes
•CONNECTION

An auto-generated type for paginating through multiple SubscriptionDiscounts.

Anchor to SubscriptionDiscountEdge.nodeSubscriptionDiscountEdge.node
•OBJECT

An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination.

Anchor to SubscriptionDraft.discountsSubscriptionDraft.discounts
•OBJECT

The SubscriptionDraft object represents a draft version of a subscription contract before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes.

Use the SubscriptionDraft object to:

  • Add, remove, or modify subscription lines and their quantities
  • Manage discounts (add, remove, or update manual and code-based discounts)
  • Configure delivery options and shipping methods
  • Set up billing and delivery policies
  • Manage customer payment methods
  • Add custom attributes and notes to generated orders
  • Configure billing cycles and next billing dates
  • Preview the projected state of the subscription

Each SubscriptionDraft object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription.

The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible.

Learn more about how subscription contracts work and how to build, update, and combine subscription contracts.

Anchor to SubscriptionDraft.discountsAddedSubscriptionDraft.discountsAdded
•OBJECT

The SubscriptionDraft object represents a draft version of a subscription contract before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes.

Use the SubscriptionDraft object to:

  • Add, remove, or modify subscription lines and their quantities
  • Manage discounts (add, remove, or update manual and code-based discounts)
  • Configure delivery options and shipping methods
  • Set up billing and delivery policies
  • Manage customer payment methods
  • Add custom attributes and notes to generated orders
  • Configure billing cycles and next billing dates
  • Preview the projected state of the subscription

Each SubscriptionDraft object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription.

The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible.

Learn more about how subscription contracts work and how to build, update, and combine subscription contracts.

Anchor to SubscriptionDraft.discountsRemovedSubscriptionDraft.discountsRemoved
•OBJECT

The SubscriptionDraft object represents a draft version of a subscription contract before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes.

Use the SubscriptionDraft object to:

  • Add, remove, or modify subscription lines and their quantities
  • Manage discounts (add, remove, or update manual and code-based discounts)
  • Configure delivery options and shipping methods
  • Set up billing and delivery policies
  • Manage customer payment methods
  • Add custom attributes and notes to generated orders
  • Configure billing cycles and next billing dates
  • Preview the projected state of the subscription

Each SubscriptionDraft object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription.

The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible.

Learn more about how subscription contracts work and how to build, update, and combine subscription contracts.

Anchor to SubscriptionDraft.discountsUpdatedSubscriptionDraft.discountsUpdated
•OBJECT

The SubscriptionDraft object represents a draft version of a subscription contract before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes.

Use the SubscriptionDraft object to:

  • Add, remove, or modify subscription lines and their quantities
  • Manage discounts (add, remove, or update manual and code-based discounts)
  • Configure delivery options and shipping methods
  • Set up billing and delivery policies
  • Manage customer payment methods
  • Add custom attributes and notes to generated orders
  • Configure billing cycles and next billing dates
  • Preview the projected state of the subscription

Each SubscriptionDraft object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription.

The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible.

Learn more about how subscription contracts work and how to build, update, and combine subscription contracts.

Was this section helpful?