Subscription
Requires the or scope.
A calculated subscription contract that can be previewed before committing.
Anchor to FieldsFields
- billingPolicy (SubscriptionBillingPolicy!)
- currencyCode (CurrencyCode!)
- customAttributes ([Attribute!]!)
- customer (Customer!)
- customerPaymentMethod (CustomerPaymentMethod)
- deliveryMethod (SubscriptionDeliveryMethod)
- deliveryPolicy (SubscriptionDeliveryPolicy!)
- deliveryPrice (MoneyV2!)
- discounts (SubscriptionManualDiscountConnection!)
- groupedLines (SubscriptionGroupedLineConnection!)
- lines (SubscriptionLineConnection!)
- note (String)
- Anchor to billingPolicybilling•Subscription
Policy Billing Policy! non-null The billing policy associated with the subscription contract.
- 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!non-null
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 deliveryPolicydelivery•Subscription
Policy Delivery Policy! non-null The delivery policy associated with 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 groupedLinesgrouped•Subscription
Lines Grouped Line Connection! non-null The list of subscription lines grouped by bundle parent, with bundle components nested under their parent line.
- 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 notenote•String
The note field that will be applied to the generated orders.