SubscriptionContract object

Represents a Subscription Contract.

Connections

• billingAttempts (SubscriptionBillingAttemptConnection!)

  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

• discounts (SubscriptionManualDiscountConnection!)

  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

• lines (SubscriptionLineConnection!)

  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.

• lastPaymentStatus (SubscriptionContractLastPaymentStatus)

  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.

• status (SubscriptionContractSubscriptionStatus!)

  The current status of the subscription contract.

• updatedAt (DateTime!)

  The date and time when the subscription contract was updated.

Types that return SubscriptionContract

• Customer.subscriptionContracts
• CustomerPaymentMethod.subscriptionContracts
• LineItem.contract
• QueryRoot.subscriptionContract
• QueryRoot.subscriptionContracts
• SubscriptionBillingAttempt.subscriptionContract
• SubscriptionContract.node
• SubscriptionDraft.originalContract

Mutations for SubscriptionContract

• subscriptionContractCreate

  Creates a Subscription Contract.

• subscriptionContractSetNextBillingDate

  Sets the next billing date of a Subscription Contract.

• subscriptionContractUpdate

  Updates a Subscription Contract.

Implements

• Node

An auto-generated type for paginating through multiple SubscriptionContracts.

Fields

• edges ([SubscriptionContractEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

Types that return SubscriptionContract

• Customer.subscriptionContracts
• CustomerPaymentMethod.subscriptionContracts
• LineItem.contract
• QueryRoot.subscriptionContract
• QueryRoot.subscriptionContracts
• SubscriptionBillingAttempt.subscriptionContract
• SubscriptionContract.node
• SubscriptionDraft.originalContract

Mutations for SubscriptionContract

• subscriptionContractCreate

  Creates a Subscription Contract.

• subscriptionContractSetNextBillingDate

  Sets the next billing date of a Subscription Contract.

• subscriptionContractUpdate

  Updates a Subscription Contract.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (SubscriptionContract!)

  The item at the end of SubscriptionContractEdge.

Types that return SubscriptionContract

• Customer.subscriptionContracts
• CustomerPaymentMethod.subscriptionContracts
• LineItem.contract
• QueryRoot.subscriptionContract
• QueryRoot.subscriptionContracts
• SubscriptionBillingAttempt.subscriptionContract
• SubscriptionContract.node
• SubscriptionDraft.originalContract

Mutations for SubscriptionContract

• subscriptionContractCreate

  Creates a Subscription Contract.

• subscriptionContractSetNextBillingDate

  Sets the next billing date of a Subscription Contract.

• subscriptionContractUpdate

  Updates a Subscription Contract.