API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

SubscriptionDraft object

Version unstable

Represents a Subscription Draft.

Required access

read_own_subscription_contracts access scope.

Connections

discounts (SubscriptionDiscountConnection!)

The list of subscription discounts which will be associated with the subscription contract.

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.

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.

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.

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.

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.

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.

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.

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.

deliveryAddress ( MailingAddressInput )

The address to delivery the subscription contract to.

status (SubscriptionContractSubscriptionStatus)

The current status of the subscription contract.

Types that return SubscriptionDraft

Mutations for SubscriptionDraft

subscriptionDraftCommit

Commits the updates of a Subscription Contract draft.

subscriptionDraftDiscountAdd

Adds a subscription discount to a subscription draft.

subscriptionDraftDiscountCodeApply

Applies a code discount on the subscription draft.

subscriptionDraftDiscountRemove

Removes a subscription discount from a subscription draft.

subscriptionDraftDiscountUpdate

Updates a subscription discount on a subscription draft.

subscriptionDraftFreeShippingDiscountAdd

Adds a subscription free shipping discount to a subscription draft.

subscriptionDraftFreeShippingDiscountUpdate

Updates a subscription free shipping discount on a subscription draft.

subscriptionDraftLineAdd

Adds a subscription line to a subscription draft.

subscriptionDraftLineRemove

Removes a subscription line from a subscription draft.

subscriptionDraftLineUpdate

Updates a subscription line on a subscription draft.

subscriptionDraftUpdate

Updates a Subscription Draft.

Implements

Version 2021-01 (Release candidate)

Represents a Subscription Draft.

Required access

read_own_subscription_contracts access scope.

Connections

discounts (SubscriptionDiscountConnection!)

The list of subscription discounts which will be associated with the subscription contract.

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.

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.

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.

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.

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.

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.

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.

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.

deliveryAddress ( MailingAddressInput )

The address to delivery the subscription contract to.

status (SubscriptionContractSubscriptionStatus)

The current status of the subscription contract.

Types that return SubscriptionDraft

Mutations for SubscriptionDraft

subscriptionDraftCommit

Commits the updates of a Subscription Contract draft.

subscriptionDraftDiscountAdd

Adds a subscription discount to a subscription draft.

subscriptionDraftDiscountCodeApply

Applies a code discount on the subscription draft.

subscriptionDraftDiscountRemove

Removes a subscription discount from a subscription draft.

subscriptionDraftDiscountUpdate

Updates a subscription discount on a subscription draft.

subscriptionDraftFreeShippingDiscountAdd

Adds a subscription free shipping discount to a subscription draft.

subscriptionDraftFreeShippingDiscountUpdate

Updates a subscription free shipping discount on a subscription draft.

subscriptionDraftLineAdd

Adds a subscription line to a subscription draft.

subscriptionDraftLineRemove

Removes a subscription line from a subscription draft.

subscriptionDraftLineUpdate

Updates a subscription line on a subscription draft.

subscriptionDraftUpdate

Updates a Subscription Draft.

Implements