SubscriptionDraft - admin-graphql - OBJECT
Version: 2024-10
Description:
Represents a Subscription Draft.
Access Scopes
`read_own_subscription_contracts` access scope.
Fields
-
billingCycle:
SubscriptionBillingCycle -
The billing cycle that the subscription contract will be associated with.
-
billingPolicy:
SubscriptionBillingPolicy! -
The billing policy for the subscription contract.
-
currencyCode:
CurrencyCode! -
The currency used for the subscription contract.
-
customAttributes:
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:
CustomerPaymentMethod -
The customer payment method used for the subscription contract.
-
deliveryMethod:
SubscriptionDeliveryMethod -
The delivery method for each billing of the subscription contract.
-
deliveryOptions:
SubscriptionDeliveryOptionResult -
The available delivery options for a given delivery address. Returns `null` for pending requests.
-
deliveryPolicy:
SubscriptionDeliveryPolicy! -
The delivery policy for the subscription contract.
-
deliveryPrice:
MoneyV2 -
The delivery price for each billing the subscription contract.
-
id:
ID! -
A globally-unique ID.
-
nextBillingDate:
DateTime -
The next billing date for the subscription contract.
-
note:
String -
The note field that will be applied to the generated orders.
-
originalContract:
SubscriptionContract -
The original subscription contract.
-
shippingOptions:
SubscriptionShippingOptionResult -
Available Shipping Options for a given delivery address. Returns NULL for pending requests.
-
status:
SubscriptionContractSubscriptionStatus -
The current status of the subscription contract.
Connections
Related queries
Related mutations
Related Unions
Examples