SubscriptionDraft object
Represents a Subscription Draft.
Required access
read_own_subscription_contracts
access scope.
On this page
Connections
-
discounts (
SubscriptionDiscountConnection!
)The list of subscription discounts which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsAdded (
SubscriptionDiscountConnection!
)The list of subscription discounts to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsRemoved (
SubscriptionDiscountConnection!
)The list of subscription discounts to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsUpdated (
SubscriptionDiscountConnection!
)The list of subscription discounts to be updated on the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
lines (
SubscriptionLineConnection!
)The list of subscription lines which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesAdded (
SubscriptionLineConnection!
)The list of subscription lines to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesRemoved (
SubscriptionLineConnection!
)The list of subscription lines to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
billingPolicy (
SubscriptionBillingPolicy!
)The billing policy for the subscription contract.
-
currencyCode (
CurrencyCode!
)The currency used for the subscription contract.
-
customer (
Customer!
)The customer to whom the subscription contract belongs.
-
customerPaymentMethod (
CustomerPaymentMethod
)The customer payment method used for the subscription contract.
Argument Description showRevoked
(Boolean
)Whether to show the customer's revoked payment method.
Default value:false
-
deliveryMethod (
SubscriptionDeliveryMethod
)The delivery method for each billing of the subscription contract.
-
deliveryPolicy (
SubscriptionDeliveryPolicy!
)The delivery policy for the subscription contract.
-
deliveryPrice (
MoneyV2
)The delivery price for each billing the subscription contract.
-
id (
ID!
)Globally unique identifier.
-
nextBillingDate (
DateTime
)The next billing date for the subscription contract.
-
originalContract (
SubscriptionContract
)The original subscription contract.
-
shippingOptions (
SubscriptionShippingOptionResult
)Available Shipping Options for a given delivery address. Returns NULL for pending requests.
Argument Description deliveryAddress
(MailingAddressInput
)The address to delivery the subscription contract to.
-
The current status of the subscription contract.
Types that return SubscriptionDraft
Mutations for SubscriptionDraft
-
Commits the updates of a Subscription Contract draft.
-
Adds a subscription discount to a subscription draft.
-
Applies a code discount on the subscription draft.
-
Removes a subscription discount from a subscription draft.
-
Updates a subscription discount on a subscription draft.
-
Adds a subscription free shipping discount to a subscription draft.
-
Updates a subscription free shipping discount on a subscription draft.
-
Adds a subscription line to a subscription draft.
-
Removes a subscription line from a subscription draft.
-
Updates a subscription line on a subscription draft.
-
Updates a Subscription Draft.
Implements
Represents a Subscription Draft.
Required access
read_own_subscription_contracts
access scope.
On this page
Connections
-
discounts (
SubscriptionDiscountConnection!
)The list of subscription discounts which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsAdded (
SubscriptionDiscountConnection!
)The list of subscription discounts to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsRemoved (
SubscriptionDiscountConnection!
)The list of subscription discounts to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsUpdated (
SubscriptionDiscountConnection!
)The list of subscription discounts to be updated on the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
lines (
SubscriptionLineConnection!
)The list of subscription lines which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesAdded (
SubscriptionLineConnection!
)The list of subscription lines to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesRemoved (
SubscriptionLineConnection!
)The list of subscription lines to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
billingPolicy (
SubscriptionBillingPolicy!
)The billing policy for the subscription contract.
-
currencyCode (
CurrencyCode!
)The currency used for the subscription contract.
-
customer (
Customer!
)The customer to whom the subscription contract belongs.
-
customerPaymentMethod (
CustomerPaymentMethod
)The customer payment method used for the subscription contract.
Argument Description showRevoked
(Boolean
)Whether to show the customer's revoked payment method.
Default value:false
-
deliveryMethod (
SubscriptionDeliveryMethod
)The delivery method for each billing of the subscription contract.
-
deliveryPolicy (
SubscriptionDeliveryPolicy!
)The delivery policy for the subscription contract.
-
deliveryPrice (
MoneyV2
)The delivery price for each billing the subscription contract.
-
id (
ID!
)Globally unique identifier.
-
nextBillingDate (
DateTime
)The next billing date for the subscription contract.
-
originalContract (
SubscriptionContract
)The original subscription contract.
-
shippingOptions (
SubscriptionShippingOptionResult
)Available Shipping Options for a given delivery address. Returns NULL for pending requests.
Argument Description deliveryAddress
(MailingAddressInput
)The address to delivery the subscription contract to.
-
The current status of the subscription contract.
Types that return SubscriptionDraft
Mutations for SubscriptionDraft
-
Commits the updates of a Subscription Contract draft.
-
Adds a subscription discount to a subscription draft.
-
Applies a code discount on the subscription draft.
-
Removes a subscription discount from a subscription draft.
-
Updates a subscription discount on a subscription draft.
-
Adds a subscription free shipping discount to a subscription draft.
-
Updates a subscription free shipping discount on a subscription draft.
-
Adds a subscription line to a subscription draft.
-
Removes a subscription line from a subscription draft.
-
Updates a subscription line on a subscription draft.
-
Updates a Subscription Draft.
Implements
Represents a Subscription Draft.
Required access
read_own_subscription_contracts
access scope.
On this page
Connections
-
discounts (
SubscriptionDiscountConnection!
)The list of subscription discounts which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsAdded (
SubscriptionDiscountConnection!
)The list of subscription discounts to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsRemoved (
SubscriptionDiscountConnection!
)The list of subscription discounts to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsUpdated (
SubscriptionDiscountConnection!
)The list of subscription discounts to be updated on the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
lines (
SubscriptionLineConnection!
)The list of subscription lines which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesAdded (
SubscriptionLineConnection!
)The list of subscription lines to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesRemoved (
SubscriptionLineConnection!
)The list of subscription lines to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
billingPolicy (
SubscriptionBillingPolicy!
)The billing policy for the subscription contract.
-
currencyCode (
CurrencyCode!
)The currency used for the subscription contract.
-
customer (
Customer!
)The customer to whom the subscription contract belongs.
-
customerPaymentMethod (
CustomerPaymentMethod
)The customer payment method used for the subscription contract.
Argument Description showRevoked
(Boolean
)Whether to show the customer's revoked payment method.
Default value:false
-
deliveryMethod (
SubscriptionDeliveryMethod
)The delivery method for each billing of the subscription contract.
-
deliveryPolicy (
SubscriptionDeliveryPolicy!
)The delivery policy for the subscription contract.
-
deliveryPrice (
MoneyV2
)The delivery price for each billing the subscription contract.
-
id (
ID!
)Globally unique identifier.
-
nextBillingDate (
DateTime
)The next billing date for the subscription contract.
-
originalContract (
SubscriptionContract
)The original subscription contract.
-
shippingOptions (
SubscriptionShippingOptionResult
)Available Shipping Options for a given delivery address. Returns NULL for pending requests.
Argument Description deliveryAddress
(MailingAddressInput
)The address to delivery the subscription contract to.
-
The current status of the subscription contract.
Types that return SubscriptionDraft
Mutations for SubscriptionDraft
-
Commits the updates of a Subscription Contract draft.
-
Adds a subscription discount to a subscription draft.
-
Applies a code discount on the subscription draft.
-
Removes a subscription discount from a subscription draft.
-
Updates a subscription discount on a subscription draft.
-
Adds a subscription free shipping discount to a subscription draft.
-
Updates a subscription free shipping discount on a subscription draft.
-
Adds a subscription line to a subscription draft.
-
Removes a subscription line from a subscription draft.
-
Updates a subscription line on a subscription draft.
-
Updates a Subscription Draft.
Implements
Represents a Subscription Draft.
Required access
read_own_subscription_contracts
access scope.
On this page
Connections
-
discounts (
SubscriptionDiscountConnection!
)The list of subscription discounts which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsAdded (
SubscriptionDiscountConnection!
)The list of subscription discounts to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsRemoved (
SubscriptionDiscountConnection!
)The list of subscription discounts to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountsUpdated (
SubscriptionDiscountConnection!
)The list of subscription discounts to be updated on the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
lines (
SubscriptionLineConnection!
)The list of subscription lines which will be associated with the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesAdded (
SubscriptionLineConnection!
)The list of subscription lines to be added to the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
linesRemoved (
SubscriptionLineConnection!
)The list of subscription lines to be removed from the subscription contract.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
billingPolicy (
SubscriptionBillingPolicy!
)The billing policy for the subscription contract.
-
currencyCode (
CurrencyCode!
)The currency used for the subscription contract.
-
customer (
Customer!
)The customer to whom the subscription contract belongs.
-
customerPaymentMethod (
CustomerPaymentMethod
)The customer payment method used for the subscription contract.
Argument Description showRevoked
(Boolean
)Whether to show the customer's revoked payment method.
Default value:false
-
deliveryMethod (
SubscriptionDeliveryMethod
)The delivery method for each billing of the subscription contract.
-
deliveryPolicy (
SubscriptionDeliveryPolicy!
)The delivery policy for the subscription contract.
-
deliveryPrice (
MoneyV2
)The delivery price for each billing the subscription contract.
-
id (
ID!
)Globally unique identifier.
-
nextBillingDate (
DateTime
)The next billing date for the subscription contract.
-
originalContract (
SubscriptionContract
)The original subscription contract.
-
shippingOptions (
SubscriptionShippingOptionResult
)Available Shipping Options for a given delivery address. Returns NULL for pending requests.
Argument Description deliveryAddress
(MailingAddressInput
)The address to delivery the subscription contract to.
-
The current status of the subscription contract.
Types that return SubscriptionDraft
Mutations for SubscriptionDraft
-
Commits the updates of a Subscription Contract draft.
-
Adds a subscription discount to a subscription draft.
-
Applies a code discount on the subscription draft.
-
Removes a subscription discount from a subscription draft.
-
Updates a subscription discount on a subscription draft.
-
Adds a subscription free shipping discount to a subscription draft.
-
Updates a subscription free shipping discount on a subscription draft.
-
Adds a subscription line to a subscription draft.
-
Removes a subscription line from a subscription draft.
-
Updates a subscription line on a subscription draft.
-
Updates a Subscription Draft.