Skip to main content
Anchor to SubscriptionContractBase

SubscriptionContractBase

interface

Requires customer_read_customers access scope.

The common fields of a subscription contract.

•CurrencyCode!
non-null

The currency used for the subscription contract.

•[Attribute!]!
non-null

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

•SubscriptionDeliveryMethod

The delivery method for each billing of the subscription contract.

•MoneyV2!
non-null

The delivery price for each billing of the subscription contract.

•SubscriptionDiscountConnection

The list of subscription discounts associated with the subscription contract.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•SubscriptionLineConnection!
non-null

A list of subscription lines associated with the subscription contract.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•Count

The number of lines associated with the subscription contract.

•String

A note that will be applied to the generated orders.

•OrderConnection!
non-null

A list of the subscription contract's orders.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•DateTime!
non-null

The date and time when the subscription contract was updated.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

A Subscription Contract.

•SubscriptionBillingPolicy!
non-null

The billing policy associated with the subscription contract.

•DateTime!
non-null

The date and time when the subscription contract was created.

•CurrencyCode!
non-null

The currency used for the subscription contract.

•[Attribute!]!
non-null

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

•SubscriptionDeliveryMethod

The delivery method for each billing of the subscription contract.

•SubscriptionDeliveryPolicy!
non-null

The delivery policy associated with the subscription contract.

•MoneyV2!
non-null

The delivery price for each billing of the subscription contract.

•SubscriptionDiscountConnection

The list of subscription discounts associated with the subscription contract.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•ID!
non-null

A globally-unique ID.

Anchor to lastBillingAttemptErrorTypelastBillingAttemptErrorType
•SubscriptionContractLastBillingErrorType

The last billing error type of the contract.

•SubscriptionContractLastPaymentStatus

The current status of the last payment.

•SubscriptionLineConnection!
non-null

A list of subscription lines associated with the subscription contract.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•Count

The number of lines associated with the subscription contract.

•DateTime

The next billing date for the subscription contract.

•String

A note that will be applied to the generated orders.

•OrderConnection!
non-null

A list of the subscription contract's orders.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•Order

The order from which the contract originated.

•UnsignedInt64!
non-null

The revision ID of the contract.

•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

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.

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


•DateTime!
non-null

The date and time when the subscription contract was updated.


Was this section helpful?