stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > SubscriptionDraft

AdminTypes.SubscriptionDraft interface

Represents a Subscription Draft.

Signature:

export interface SubscriptionDraft extends Node 

Extends: Node

Properties

Property Modifiers Type Description
billingCycle?   Maybe<SubscriptionBillingCycle> (Optional) The billing cycle that the subscription contract will be associated with.
billingPolicy   SubscriptionBillingPolicy The billing policy for the subscription contract.
concatenatedBillingCycles   SubscriptionBillingCycleConnection The billing cycles of the contracts that will be concatenated to the subscription contract.
currencyCode   CurrencyCode | `${CurrencyCode}` The currency used for the subscription contract.
customAttributes   Array<Attribute> A list of the custom attributes to be added to the generated orders.
customer   Customer The customer to whom the subscription contract belongs.
customerPaymentMethod?   Maybe<CustomerPaymentMethod> (Optional) The customer payment method used for the subscription contract.
deliveryMethod?   Maybe<SubscriptionDeliveryMethod> (Optional) The delivery method for each billing of the subscription contract.
deliveryOptions?   Maybe<SubscriptionDeliveryOptionResult> (Optional) The available delivery options for a given delivery address. Returns null for pending requests.
deliveryPolicy   SubscriptionDeliveryPolicy The delivery policy for the subscription contract.
deliveryPrice?   Maybe<MoneyV2> (Optional) The delivery price for each billing the subscription contract.
discounts   SubscriptionDiscountConnection The list of subscription discounts which will be associated with the subscription contract.
discountsAdded   SubscriptionDiscountConnection The list of subscription discounts to be added to the subscription contract.
discountsRemoved   SubscriptionDiscountConnection The list of subscription discounts to be removed from the subscription contract.
discountsUpdated   SubscriptionDiscountConnection The list of subscription discounts to be updated on the subscription contract.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
lines   SubscriptionLineConnection The list of subscription lines which will be associated with the subscription contract.
linesAdded   SubscriptionLineConnection The list of subscription lines to be added to the subscription contract.
linesRemoved   SubscriptionLineConnection The list of subscription lines to be removed from the subscription contract.
nextBillingDate?   Maybe<Scalars[‘DateTime’][‘output’]> (Optional) The next billing date for the subscription contract.
note?   Maybe<Scalars[‘String’][‘output’]> (Optional) The note field that will be applied to the generated orders.
originalContract?   Maybe<SubscriptionContract> (Optional) The original subscription contract.
shippingOptions?   Maybe<SubscriptionShippingOptionResult> (Optional) Available Shipping Options for a given delivery address. Returns NULL for pending requests.
status?   Maybe<SubscriptionContractSubscriptionStatus | `${SubscriptionContractSubscriptionStatus}`> (Optional) The current status of the subscription contract.