Subscription
Requires the or scope.
Represents a subscription contract with billing cycles.
Anchor to FieldsFields
- app (App)
- appAdminUrl (URL)
- billingCycles (SubscriptionBillingCycleConnection!)
- createdAt (DateTime!)
- 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.
Show fields
- Anchor to appAdminUrlapp•URL
Admin Url The URL of the subscription contract page on the subscription app.
- Anchor to billingCyclesbilling•Subscription
Cycles Billing Cycle Connection! non-null The billing cycles that the edited contract belongs to.
Show fields
- 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.
- Anchor to sortKeysort•Subscription
Key Billing Cycles Sort Keys 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.
Show enum values
Arguments
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the subscription contract was created.
- Anchor to currencyCodecurrency•Currency
Code Code! non-null The currency that's used for the subscription contract.
Show enum values
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null A list of the custom attributes to be added to the generated orders.
Show fields
- Anchor to customercustomer•Customer
The customer to whom the subscription contract belongs.
Show fields
- Anchor to customerPaymentMethodcustomer•Customer
Payment Method Payment Method The customer payment method that's used for the subscription contract.
Show fields
- 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.
Show union types
- Anchor to deliveryPricedelivery•Money
Price V2! non-null The delivery price for each billing of the subscription contract.
Show fields
- Anchor to discountsdiscounts•Subscription
Manual Discount Connection! non-null The list of subscription discounts associated with the subscription contract.
Show fields
- 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.
Show fields
- 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.
Show fields
- 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.
Show fields
- 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 MutationsMutations
- subscriptionBillingCycleContractDraftCommit (SubscriptionBillingCycleContractDraftCommitPayload)
- •mutation
Commits the updates of a Subscription Billing Cycle Contract draft.
Show payload
- Anchor to draftIddraft•ID!
Id required The gid of the Subscription Contract draft to commit.
Arguments