Subscription
Requires the or scope.
Represents subscription contract common fields.
Anchor to FieldsFields
- app (App)
- appAdminUrl (URL)
- currencyCode (CurrencyCode!)
- customAttributes ([Attribute!]!)
- customer (Customer)
- customerPaymentMethod (CustomerPaymentMethod)
- deliveryMethod (SubscriptionDeliveryMethod)
- deliveryPrice (MoneyV2!)
- discounts (SubscriptionManualDiscountConnection!)
- lines (SubscriptionLineConnection!)
- linesCount (Count)
- note (String)
- orders (OrderConnection!)
- updatedAt (DateTime!)
- lineCount (Int!): deprecated
- •App
The subscription app that the subscription contract is registered to.
- Anchor to appAdminUrlapp•URL
Admin Url The URL of the subscription contract page on the subscription app.
- Anchor to currencyCodecurrency•Currency
Code Code! non-null The currency that's used for the subscription contract.
- Anchor to customAttributescustom•[Attribute!]!
Attributes 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 customerPaymentMethodcustomer•Customer
Payment Method Payment Method The customer payment method that's used for the subscription contract.
- Anchor to showRevokedshow•Boolean
Revoked Default:false Whether to show the customer's revoked payment method.
Arguments
- Anchor to deliveryMethoddelivery•Subscription
Method Delivery Method The delivery method for each billing of the subscription contract.
- Anchor to deliveryPricedelivery•Money
Price V2! non-null The delivery price for each billing of the subscription contract.
- Anchor to discountsdiscounts•Subscription
Manual Discount Connection! non-null The list of subscription discounts associated with the subscription contract.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to lineslines•Subscription
Line Connection! non-null The list of subscription lines associated with the subscription contract.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to linesCountlines•Count
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•Order
Connection! non-null A list of the subscription contract's orders.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the subscription contract was updated.
- Anchor to lineCountline•Int!
Count non-nullDeprecated
Anchor to Types implemented inTypes implemented in
- SubscriptionBillingCycleEditedContract (SubscriptionBillingCycleEditedContract)
- SubscriptionContract (SubscriptionContract)
- •OBJECT
Represents a subscription contract with billing cycles.
- •OBJECT
A subscription contract that defines recurring purchases for a customer. Each contract specifies what products to deliver, when to bill and ship them, and at what price.
The contract includes
andthat control the frequency of charges and fulfillments.items define the products, quantities, and pricing for each recurringOrder. The contract tracksrecords, payment status, and generated orders throughout its lifecycle.Appinstances manage contracts through various status transitions including active, paused, failed, cancelled, or expired states.Learn more about building subscription contracts and updating subscription contracts.