Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to lineslines

•SubscriptionLineConnection!

non-null

A list of subscription lines associated with the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to linesCountlinesCount

•Count

The number of lines associated with the subscription contract.

Anchor to notenote

•String

A note that will be applied to the generated orders.

Anchor to ordersorders

•OrderConnection!

non-null

A list of the subscription contract's orders.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the subscription contract was updated.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to SubscriptionContract SubscriptionContract

•OBJECT

A Subscription Contract.

Anchor to billingPolicybillingPolicy

•SubscriptionBillingPolicy!

non-null

The billing policy associated with the subscription contract.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the subscription contract was created.

Anchor to currencyCodecurrencyCode

•CurrencyCode!

non-null

The currency used for the subscription contract.

Anchor to customAttributescustomAttributes

•[Attribute!]!

non-null

A list of custom attributes to be added to the generated orders.

Anchor to deliveryMethoddeliveryMethod

•SubscriptionDeliveryMethod

The delivery method for each billing of the subscription contract.

Anchor to deliveryPolicydeliveryPolicy

•SubscriptionDeliveryPolicy!

non-null

The delivery policy associated with the subscription contract.

Anchor to deliveryPricedeliveryPrice

•MoneyV2!

non-null

The delivery price for each billing of the subscription contract.

Anchor to discountsdiscounts

•SubscriptionDiscountConnection

The list of subscription discounts associated with the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to lastBillingAttemptErrorTypelastBillingAttemptErrorType

•SubscriptionContractLastBillingErrorType

The last billing error type of the contract.

Anchor to lastPaymentStatuslastPaymentStatus

•SubscriptionContractLastPaymentStatus

The current status of the last payment.

Anchor to lineslines

•SubscriptionLineConnection!

non-null

A list of subscription lines associated with the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to linesCountlinesCount

•Count

The number of lines associated with the subscription contract.

Anchor to nextBillingDatenextBillingDate

•DateTime

The next billing date for the subscription contract.

Anchor to notenote

•String

A note that will be applied to the generated orders.

Anchor to ordersorders

•OrderConnection!

non-null

A list of the subscription contract's orders.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to originOrderoriginOrder

•Order

The order from which the contract originated.

Anchor to revisionIdrevisionId

•UnsignedInt64!

non-null

The revision ID of the contract.

Anchor to statusstatus

•SubscriptionContractSubscriptionStatus!

non-null

The current status of the subscription contract.

Anchor to upcomingBillingCyclesupcomingBillingCycles

•SubscriptionBillingCycleConnection!

non-null

The upcoming billing cycles on the subscription contract.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•SubscriptionBillingCyclesSortKeys

Default:CYCLE_INDEX

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the subscription contract was updated.

Was this section helpful?

{

"currencyCode": "",

"customAttributes": "",

"deliveryMethod": "",

"deliveryPrice": "",

"discounts": {

"first": "",

"after": "",

"last": "",

"before": "",

"reverse": ""

"lines": {

"first": "",

"after": "",

"last": "",

"before": "",

"reverse": ""

"linesCount": "",

"note": "",

"orders": {

"first": "",

"after": "",

"last": "",

"before": "",

"reverse": ""

"updatedAt": ""

}

Variables

{
	"currencyCode": "",
	"customAttributes": "",
	"deliveryMethod": "",
	"deliveryPrice": "",
	"discounts": {
		"first": "",
		"after": "",
		"last": "",
		"before": "",
		"reverse": ""
	},
	"lines": {
		"first": "",
		"after": "",
		"last": "",
		"before": "",
		"reverse": ""
	},
	"linesCount": "",
	"note": "",
	"orders": {
		"first": "",
		"after": "",
		"last": "",
		"before": "",
		"reverse": ""
	},
	"updatedAt": ""
}

Schema

interface SubscriptionContractBase {
  currencyCode: CurrencyCode!
  customAttributes: [Attribute!]!
  deliveryMethod: SubscriptionDeliveryMethod
  deliveryPrice: MoneyV2!
  discounts: SubscriptionDiscountConnection
  lines: SubscriptionLineConnection!
  linesCount: Count
  note: String
  orders: OrderConnection!
  updatedAt: DateTime!
}