SubscriptionContractBase

interface

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Represents subscription contract common fields.

Anchor to Fields and connectionsFields and connections

Anchor to appapp • App: The subscription app that the subscription contract is registered to.
Anchor to appAdminUrlappAdminUrl • URL: The URL of the subscription contract page on the subscription app.
Anchor to currencyCodecurrencyCode • CurrencyCode!non-null: The currency that's used for the subscription contract.
Anchor to customAttributescustomAttributes • [Attribute!]!non-null: A list of the custom attributes to be added to the generated orders.
Anchor to customercustomer • Customer: The customer to whom the subscription contract belongs.
Anchor to customerPaymentMethodcustomerPaymentMethod • CustomerPaymentMethod: The customer payment method that's used for the subscription contract.
Anchor to deliveryMethoddeliveryMethod • SubscriptionDeliveryMethod: The delivery method for each billing of the subscription contract.
Anchor to deliveryPricedeliveryPrice • MoneyV2!non-null: The delivery price for each billing of the subscription contract.
Anchor to discountsdiscounts • SubscriptionManualDiscountConnection!non-null: The list of subscription discounts associated with the subscription contract.
Anchor to lineslines • SubscriptionLineConnection!non-null: The list of subscription lines associated with the subscription contract.
Anchor to linesCountlinesCount • Count: The number of lines associated with the subscription contract.
Anchor to notenote • String: The note field that will be applied to the generated orders.
Anchor to ordersorders • OrderConnection!non-null: A list of the subscription contract's orders.
Anchor to updatedAtupdatedAt • DateTime!non-null: The date and time when the subscription contract was updated.
Anchor to lineCountlineCount • Int!non-nullDeprecated: The number of lines associated with the subscription contract. Use linesCount instead.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to SubscriptionBillingCycleEditedContract SubscriptionBillingCycleEditedContract • OBJECT
Anchor to SubscriptionContract SubscriptionContract • OBJECT

Was this section helpful?

{

"app": "",

"appAdminUrl": "",

"currencyCode": "",

"customAttributes": "",

"customer": "",

"customerPaymentMethod": {

"showRevoked": ""

"deliveryMethod": "",

"deliveryPrice": "",

"discounts": {

"first": "",

"after": "",

"last": "",

"before": "",

"reverse": ""

"lineCount": "",

"lines": {

"first": "",

"after": "",

"last": "",

"before": "",

"reverse": ""

"linesCount": "",

"note": "",

"orders": {

"first": "",

"after": "",

"last": "",

"before": "",

"reverse": ""

{
	"app": "",
	"appAdminUrl": "",
	"currencyCode": "",
	"customAttributes": "",
	"customer": "",
	"customerPaymentMethod": {
		"showRevoked": ""
	},
	"deliveryMethod": "",
	"deliveryPrice": "",
	"discounts": {
		"first": "",
		"after": "",
		"last": "",
		"before": "",
		"reverse": ""
	},
	"lineCount": "",
	"lines": {
		"first": "",
		"after": "",
		"last": "",
		"before": "",
		"reverse": ""
	},
	"linesCount": "",
	"note": "",
	"orders": {
		"first": "",
		"after": "",
		"last": "",
		"before": "",
		"reverse": ""
	},
	"updatedAt": ""
}

interface SubscriptionContractBase {
  app: App
  appAdminUrl: URL
  currencyCode: CurrencyCode!
  customAttributes: [Attribute!]!
  customer: Customer
  customerPaymentMethod: CustomerPaymentMethod
  deliveryMethod: SubscriptionDeliveryMethod
  deliveryPrice: MoneyV2!
  lineCount: Int!
  linesCount: Count
  note: String
  updatedAt: DateTime!
}