Skip to main content

SubscriptionDiscount

A discount applied to a subscription or subscription order.

type SubscriptionDiscount {
createdAt: Timestamp!
discount: Discount!
discountAgreement: DiscountAgreement!
discountApplication: DiscountApplication
id: GlobalID!
status: SubscriptionDiscountStatus!
subscription: Subscription
updatedAt: Timestamp!
}

Fields​

SubscriptionDiscount.createdAt ● Timestamp! non-null scalar types​

The date and time when the subscription discount was created.

SubscriptionDiscount.discount ● Discount! non-null object types​

The discount that was applied.

SubscriptionDiscount.discountAgreement ● DiscountAgreement! non-null object types​

The discount agreement that tracks the customer's use of the discount.

SubscriptionDiscount.discountApplication ● DiscountApplication object types​

The result of applying the discount in the latest price calculation. Only set on a subscription order's discount once its prices are calculated.

SubscriptionDiscount.id ● GlobalID! non-null scalar types​

The subscription discount's ID.

SubscriptionDiscount.status ● SubscriptionDiscountStatus! non-null enum types​

The subscription discount's status.

SubscriptionDiscount.subscription ● Subscription object types​

The subscription the discount belongs to.

SubscriptionDiscount.updatedAt ● Timestamp! non-null scalar types​

The date and time when the subscription discount was last updated.

Member Of​

Subscription object ● SubscriptionDiscountActivatePayload object ● SubscriptionDiscountApplyPayload object ● SubscriptionDiscountRemovePayload object ● SubscriptionDiscountValidatePayload object ● SubscriptionEvent object ● SubscriptionOrder object