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

SubscriptionDraft object

Version unstable

Represents a Subscription Draft.

Required access

read_own_subscription_contracts access scope.

Connections

  • 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

  • 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

  • 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

  • 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

  • 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.

  • 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

Implements

Version 2021-04 (Release candidate)

Represents a Subscription Draft.

Required access

read_own_subscription_contracts access scope.

Connections

  • 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

  • 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

  • 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

  • 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

  • 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.

  • 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

Implements

Version 2021-01 (Latest)

Represents a Subscription Draft.

Required access

read_own_subscription_contracts access scope.

Connections

  • 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

  • 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

  • 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

  • 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

  • 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.

  • 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

Implements