Choose a version:

AttributeInput

input_object

The input fields for an attribute.

Anchor to FieldsFields

Anchor to keykey •String! non-null: Key or name of the attribute.
Anchor to valuevalue •String! non-null: Value of the attribute.

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to DraftOrderInput.customAttributes DraftOrderInput.customAttributes •INPUT OBJECT: The input fields used to create or update a draft order.
Anchor to DraftOrderLineItemInput.customAttributes DraftOrderLineItemInput.customAttributes •INPUT OBJECT: The input fields for a line item included in a draft order.
Anchor to OrderInput.customAttributes OrderInput.customAttributes •INPUT OBJECT: The input fields for specifying the information to be updated on an order when using the orderUpdate mutation.
Anchor to SubscriptionContractCalculationBillingCycleEditInput.customAttributes SubscriptionContractCalculationBillingCycleEditInput.customAttributes •INPUT OBJECT: The input fields for editing a subscription contract for a single billing cycle, used for contract calculation. Any field provided will update or replace the corresponding value for the targeted cycle. Fields that are omitted will be left unchanged. Contract-level attributes such as billing policy, delivery policy, and payment method cannot be changed by a billing cycle edit.
Anchor to SubscriptionContractCalculationContractCreateInput.customAttributes SubscriptionContractCalculationContractCreateInput.customAttributes •INPUT OBJECT: The input fields for calculating a new subscription contract. Provide the complete desired state of the contract. The contract isn't created until you commit the calculation with the subscriptionContractCalculationCommit mutation.

Learn how to build a subscription contract.
Anchor to SubscriptionContractCalculationContractUpdateInput.customAttributes SubscriptionContractCalculationContractUpdateInput.customAttributes •INPUT OBJECT: The input fields for calculating changes to an existing subscription contract. Each field you provide replaces the corresponding value on the contract, and omitted fields remain unchanged. For list fields, provide the complete replacement list, including the id of each existing item that you want to keep.

Learn how to update a subscription contract.
Anchor to SubscriptionContractCalculationCustomLineInput.customAttributes SubscriptionContractCalculationCustomLineInput.customAttributes •INPUT OBJECT: The input fields for custom subscription lines in the calculate API.
Anchor to SubscriptionContractCalculationProductVariantLineInput.customAttributes SubscriptionContractCalculationProductVariantLineInput.customAttributes •INPUT OBJECT: The input fields for product variant subscription lines in the calculate API.
Anchor to SubscriptionContractCalculationProductVariantParentLineInput.customAttributes SubscriptionContractCalculationProductVariantParentLineInput.customAttributes •INPUT OBJECT: The input fields for product variant bundle parent subscription lines in the calculate API.
Anchor to SubscriptionDraftInput.customAttributes SubscriptionDraftInput.customAttributes •INPUT OBJECT: The input fields required to create a Subscription Draft.
Anchor to SubscriptionLineInput.customAttributes SubscriptionLineInput.customAttributes •INPUT OBJECT: The input fields required to add a new subscription line to a contract.
Anchor to SubscriptionLineUpdateInput.customAttributes SubscriptionLineUpdateInput.customAttributes •INPUT OBJECT: The input fields required to update a subscription line on a contract.

Was this section helpful?