Subscription
Requires the or scope.
A Subscription Contract.
Anchor to FieldsFields
- billingPolicy (SubscriptionBillingPolicy!)
- createdAt (DateTime!)
- currencyCode (CurrencyCode!)
- customAttributes ([Attribute!]!)
- deliveryMethod (SubscriptionDeliveryMethod)
- deliveryPolicy (SubscriptionDeliveryPolicy!)
- deliveryPrice (MoneyV2!)
- discounts (SubscriptionDiscountConnection)
- id (ID!)
- lastBillingAttemptErrorType (SubscriptionContractLastBillingErrorType)
- lastPaymentStatus (SubscriptionContractLastPaymentStatus)
- lines (SubscriptionLineConnection!)
- linesCount (Count)
- nextBillingDate (DateTime)
- note (String)
- orders (OrderConnection!)
- originOrder (Order)
- revisionId (UnsignedInt64!)
- status (SubscriptionContractSubscriptionStatus!)
- upcomingBillingCycles (SubscriptionBillingCycleConnection!)
- updatedAt (DateTime!)
- Anchor to billingPolicybilling•Subscription
Policy Billing Policy! non-null The billing policy associated with the subscription contract.
Show fields
- 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 used for the subscription contract.
Show enum values
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null A list of custom attributes to be added to the generated orders.
Show fields
- Anchor to deliveryMethoddelivery•Subscription
Method Delivery Method The delivery method for each billing of the subscription contract.
Show union types
- Anchor to deliveryPolicydelivery•Subscription
Policy Delivery Policy! non-null The delivery policy associated with the subscription contract.
Show fields
- Anchor to deliveryPricedelivery•Money
Price V2! non-null The delivery price for each billing of the subscription contract.
Show fields
- Anchor to discountsdiscounts•Subscription
Discount Connection 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
- •ID!non-null
A globally-unique ID.
- Anchor to lastBillingAttemptErrorTypelast•Subscription
Billing Attempt Error Type Contract Last Billing Error Type The last billing error type of the contract.
Show enum values
- Anchor to lastPaymentStatuslast•Subscription
Payment Status Contract Last Payment Status The current status of the last payment.
Show enum values
- Anchor to lineslines•Subscription
Line Connection! non-null A 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 nextBillingDatenext•Date
Billing Date Time The next billing date for the subscription contract.
- Anchor to notenote•String
A note 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 originOrderorigin•Order
Order The order from which the contract originated.
Show fields
- Anchor to revisionIdrevision•Unsigned
Id Int64! non-null The revision ID of the contract.
- Anchor to statusstatus•Subscription
Contract Subscription Status! non-null The current status of the subscription contract.
Show enum values
- Anchor to upcomingBillingCyclesupcoming•Subscription
Billing Cycles Billing Cycle Connection! non-null The upcoming billing cycles on 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.
- 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 updatedAtupdated•Date
At Time! non-null The date and time when the subscription contract was updated.
Anchor to MutationsMutations
- subscriptionContractActivate (SubscriptionContractActivatePayload)
- subscriptionContractCancel (SubscriptionContractCancelPayload)
- subscriptionContractPause (SubscriptionContractPausePayload)
- subscriptionContractSelectDeliveryMethod (SubscriptionContractSelectDeliveryMethodPayload)
- •mutation
Activates a Subscription Contract. Contract status must be either active, paused, or failed.
Show payload
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract to activate.
Arguments
- •mutation
Cancels a Subscription Contract.
Show payload
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the Subscription Contract to cancel.
Arguments
- •mutation
Pauses a Subscription Contract.
Show payload
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract to pause.
Arguments
- •mutation
Selects an option from a delivery options result and updates the delivery method on a Subscription Contract.
Show payload
- Anchor to deliveryMethodInputdelivery•Subscription
Method Input Delivery Method Input! required The delivery method selected for the subscription contract.
Show input fields
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract.
- Anchor to subscriptionDeliveryOptionsResultTokensubscription•String!
Delivery Options Result Token required The token associated with the successfully fetched delivery options result for the subscription contract.
Arguments