Subscription
The input fields for custom subscription lines in the calculate API.
Anchor to FieldsFields
- appManagedPricingPolicy (SubscriptionContractCalculationAppManagedPricingPolicyInput)
- customAttributes ([AttributeInput!]!)
- discounts ([SubscriptionContractCalculationLineDiscountInput!]!)
- id (ID)
- originSellingPlanId (ID)
- price (MoneyInput!)
- quantity (Int!)
- requiresShipping (Boolean!)
- sellingPlanName (String)
- sku (String)
- taxable (Boolean!)
- title (String!)
- variantTitle (String)
- weight (WeightInput)
- Anchor to appManagedPricingPolicyapp•Subscription
Managed Pricing Policy Contract Calculation App Managed Pricing Policy Input The app-managed pricing policy for this line. It's stored as metadata and doesn't affect the calculated price. When omitted, the stored policy is cleared.
Show input fields
- Anchor to customAttributescustom•[Attribute
Attributes Input!]! requiredDefault:[] The custom attributes for this subscription line. Defaults to an empty list when omitted, which clears the line's stored attributes.
Show input fields
- Anchor to discountsdiscounts•[Subscription
Contract Calculation Line Discount Input!]! required The line-scoped manual discounts for this line. Each applies only to this line. You must state this list whenever you provide the line; pass an empty list to clear its discounts.
Show input fields
- •ID
The ID of an existing line to update. Omit for new lines. The ID keeps the line's identity but doesn't carry over any stored values, so restate every field of the line.
- Anchor to originSellingPlanIdorigin•ID
Selling Plan Id The ID of the selling plan this line was originally created with. It's used to find the associated delivery profile, and isn't applied as a selling plan during calculation.
- Anchor to priceprice•Money
Input! required The price of the custom line item. The amount must be greater than or equal to 0.
Show input fields
- Anchor to quantityquantity•Int!non-null
The quantity of the custom line item. Must be at least 1.
- Anchor to requiresShippingrequires•Boolean!
Shipping non-null Whether this custom line requires shipping.
- Anchor to sellingPlanNameselling•String
Plan Name The selling plan name for this line, describing the order line items it creates. Defaults to the origin selling plan's current name when not specified. When
is also omitted, the line stores no name and order line items use a name built from the contract's billing and delivery policies.- •String
The SKU of the custom line item.
- Anchor to taxabletaxable•Boolean!non-null
Whether this custom line is taxable.
- Anchor to titletitle•String!non-null
The title of the custom line item.
- Anchor to variantTitlevariant•String
Title The title of the variant.
- Anchor to weightweight•Weight
Input The weight of the custom line item.
Show input fields
Anchor to Input objects using this inputInput objects using this input
- Anchor to SubscriptionContractCalculationLineInput.customLineSubscription•INPUT OBJECT
Contract Calculation Line Input.customLine The input fields for subscription lines used for contract calculation. This is a oneOf input: one, and only one, field can be provided.