stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > SubscriptionContract

AdminTypes.SubscriptionContract interface

Represents a Subscription Contract.

Signature:

export interface SubscriptionContract extends Node, SubscriptionContractBase 

Extends: Node, SubscriptionContractBase

Properties

Property Modifiers Type Description
app?   Maybe<App> (Optional) The subscription app that the subscription contract is registered to.
appAdminUrl?   Maybe<Scalars[‘URL’][‘output’]> (Optional) The URL of the subscription contract page on the subscription app.
billingAttempts   SubscriptionBillingAttemptConnection The list of billing attempts associated with the subscription contract.
billingPolicy   SubscriptionBillingPolicy The billing policy associated with the subscription contract.
createdAt   Scalars[‘DateTime’][‘output’] The date and time when the subscription contract was created.
currencyCode   CurrencyCode | `${CurrencyCode}` The currency that’s used for the subscription contract.
customAttributes   Array<Attribute> A list of the custom attributes to be added to the generated orders.
customer?   Maybe<Customer> (Optional) The customer to whom the subscription contract belongs.
customerPaymentMethod?   Maybe<CustomerPaymentMethod> (Optional) The customer payment method that’s used for the subscription contract.
deliveryMethod?   Maybe<SubscriptionDeliveryMethod> (Optional) 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.
discounts   SubscriptionManualDiscountConnection The list of subscription discounts associated with the subscription contract.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
lastPaymentStatus?   Maybe<SubscriptionContractLastPaymentStatus | `${SubscriptionContractLastPaymentStatus}`> (Optional) The current status of the last payment.
lineCount   Scalars[‘Int’][‘output’] The number of lines associated with the subscription contract.
lines   SubscriptionLineConnection The list of subscription lines associated with the subscription contract.
nextBillingDate?   Maybe<Scalars[‘DateTime’][‘output’]> (Optional) The next billing date for the subscription contract.
note?   Maybe<Scalars[‘String’][‘output’]> (Optional) The note field that will be applied to the generated orders.
orders   OrderConnection A list of the subscription contract’s orders.
originOrder?   Maybe<Order> (Optional) The order from which this contract originated.
revisionId   Scalars[‘UnsignedInt64’][‘output’] The revision id of the contract.
status   SubscriptionContractSubscriptionStatus | `${SubscriptionContractSubscriptionStatus}` The current status of the subscription contract.
updatedAt   Scalars[‘DateTime’][‘output’] The date and time when the subscription contract was updated.