API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

SubscriptionLineInput input object

Version unstable

Specifies the input fields required to add a new subscription line to a contract.

Input fields

currentPrice (Decimal!) Required

The price of the product.

customAttributes ([AttributeInput!])

The custom attributes for this subscription line.

pricingPolicy (SubscriptionPricingPolicyInput)

Describes expected price changes of the subscription line over time.

productVariantId (ID!) Required

The ID of the product variant the subscription line refers to.

quantity (Int!) Required

The quantity of the product.

sellingPlanId (ID)

The selling plan for the subscription line.

sellingPlanName (String)

The selling plan name for the subscription line.

Defaults to using the selling plan's current name when not specified.

Version 2021-01 (Release candidate)

Specifies the input fields required to add a new subscription line to a contract.

Input fields

currentPrice (Decimal!) Required

The price of the product.

customAttributes ([AttributeInput!])

The custom attributes for this subscription line.

pricingPolicy (SubscriptionPricingPolicyInput)

Describes expected price changes of the subscription line over time.

productVariantId (ID!) Required

The ID of the product variant the subscription line refers to.

quantity (Int!) Required

The quantity of the product.

sellingPlanId (ID)

The selling plan for the subscription line.

sellingPlanName (String)

The selling plan name for the subscription line.

Defaults to using the selling plan's current name when not specified.