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

SubscriptionContract object

Version unstable

Represents a Subscription Contract.

Required access

Requires either all_subscription_contracts or own_subscription_contracts scope.

Connections

  • The list of billing attempts 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 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 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

  • orders (OrderConnection!)

    The list of orders 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

Fields

  • app (App)

    The subscription app that this subscription contract is registered to.

  • appAdminUrl (URL)

    URL of the subscription contract page on the subscription app.

  • billingPolicy (SubscriptionBillingPolicy!)

    The billing policy associated with the subscription contract.

  • createdAt (DateTime!)

    The date and time when the subscription contract was created.

  • 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 associated with the subscription contract.

  • deliveryPrice (MoneyV2!)

    The delivery price for each billing of the subscription contract.

  • id (ID!)

    Globally unique identifier.

  • The current status of the last payment.

  • lineCount (Int!)

    The number of lines associated with the subscription contract.

  • nextBillingDate (DateTime)

    The next billing date for the subscription contract.

  • originOrder (Order)

    The order from which this contract originated.

  • The current status of the subscription contract.

  • updatedAt (DateTime!)

    The date and time when the subscription contract was updated.

Types that return SubscriptionContract

Mutations for SubscriptionContract

Implements

Version unstable

An auto-generated type for paginating through multiple SubscriptionContracts.

Fields

Types that return SubscriptionContract

Mutations for SubscriptionContract

Version unstable

An auto-generated type which holds one SubscriptionContract and a cursor during pagination.

Fields

Types that return SubscriptionContract

Mutations for SubscriptionContract

Version 2021-07 (Release candidate)

Represents a Subscription Contract.

Required access

Requires either all_subscription_contracts or own_subscription_contracts scope.

Connections

  • The list of billing attempts 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 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 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

  • orders (OrderConnection!)

    The list of orders 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

Fields

  • app (App)

    The subscription app that this subscription contract is registered to.

  • appAdminUrl (URL)

    URL of the subscription contract page on the subscription app.

  • billingPolicy (SubscriptionBillingPolicy!)

    The billing policy associated with the subscription contract.

  • createdAt (DateTime!)

    The date and time when the subscription contract was created.

  • 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 associated with the subscription contract.

  • deliveryPrice (MoneyV2!)

    The delivery price for each billing of the subscription contract.

  • id (ID!)

    Globally unique identifier.

  • The current status of the last payment.

  • lineCount (Int!)

    The number of lines associated with the subscription contract.

  • nextBillingDate (DateTime)

    The next billing date for the subscription contract.

  • originOrder (Order)

    The order from which this contract originated.

  • The current status of the subscription contract.

  • updatedAt (DateTime!)

    The date and time when the subscription contract was updated.

Types that return SubscriptionContract

Mutations for SubscriptionContract

Implements

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple SubscriptionContracts.

On this page

Fields

Version 2021-07 (Release candidate)

An auto-generated type which holds one SubscriptionContract and a cursor during pagination.

Fields

Types that return SubscriptionContractEdge

Version 2021-04 (Latest)

Represents a Subscription Contract.

Required access

Requires either all_subscription_contracts or own_subscription_contracts scope.

Connections

  • The list of billing attempts 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 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 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

  • orders (OrderConnection!)

    The list of orders 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

Fields

  • app (App)

    The subscription app that this subscription contract is registered to.

  • appAdminUrl (URL)

    URL of the subscription contract page on the subscription app.

  • billingPolicy (SubscriptionBillingPolicy!)

    The billing policy associated with the subscription contract.

  • createdAt (DateTime!)

    The date and time when the subscription contract was created.

  • 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 associated with the subscription contract.

  • deliveryPrice (MoneyV2!)

    The delivery price for each billing of the subscription contract.

  • id (ID!)

    Globally unique identifier.

  • The current status of the last payment.

  • lineCount (Int!)

    The number of lines associated with the subscription contract.

  • nextBillingDate (DateTime)

    The next billing date for the subscription contract.

  • originOrder (Order)

    The order from which this contract originated.

  • The current status of the subscription contract.

  • updatedAt (DateTime!)

    The date and time when the subscription contract was updated.

Types that return SubscriptionContract

Mutations for SubscriptionContract

Implements

Version 2021-04 (Latest)

An auto-generated type for paginating through multiple SubscriptionContracts.

On this page

Fields

Version 2021-04 (Latest)

An auto-generated type which holds one SubscriptionContract and a cursor during pagination.

Fields

Types that return SubscriptionContractEdge

Version 2021-01

Represents a Subscription Contract.

Required access

Requires either all_subscription_contracts or own_subscription_contracts scope.

Connections

  • The list of billing attempts 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 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 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

  • orders (OrderConnection!)

    The list of orders 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

Fields

  • app (App)

    The subscription app that this subscription contract is registered to.

  • appAdminUrl (URL)

    URL of the subscription contract page on the subscription app.

  • billingPolicy (SubscriptionBillingPolicy!)

    The billing policy associated with the subscription contract.

  • createdAt (DateTime!)

    The date and time when the subscription contract was created.

  • 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 associated with the subscription contract.

  • deliveryPrice (MoneyV2!)

    The delivery price for each billing of the subscription contract.

  • id (ID!)

    Globally unique identifier.

  • The current status of the last payment.

  • lineCount (Int!)

    The number of lines associated with the subscription contract.

  • nextBillingDate (DateTime)

    The next billing date for the subscription contract.

  • originOrder (Order)

    The order from which this contract originated.

  • The current status of the subscription contract.

  • updatedAt (DateTime!)

    The date and time when the subscription contract was updated.

Types that return SubscriptionContract

Mutations for SubscriptionContract

Implements

Version 2021-01

An auto-generated type for paginating through multiple SubscriptionContracts.

On this page

Fields

Version 2021-01

An auto-generated type which holds one SubscriptionContract and a cursor during pagination.

Fields

Types that return SubscriptionContractEdge