Skip to main content

SubscriptionUpdateInput

The input fields for updating a subscription.

input SubscriptionUpdateInput {
  customAttributes: [CustomAttributeInput!]
  deliveryMethod: SubscriptionDeliveryMethodUpdateInput
  id: GlobalID!
  lines: [SubscriptionLineInput!]
  notes: String
  overwriteChildCustomAttributes: Boolean
  paymentMethodId: GlobalID
}

Fields​

SubscriptionUpdateInput.customAttributes ● [CustomAttributeInput!] list input types​

The subscription's custom attributes. Editable attributes left out are removed.

SubscriptionUpdateInput.deliveryMethod ● SubscriptionDeliveryMethodUpdateInput input types​

Changes to the subscription's delivery method. Fields left out keep their current values.

SubscriptionUpdateInput.id ● GlobalID! non-null scalar types​

The ID of the subscription to update.

SubscriptionUpdateInput.lines ● [SubscriptionLineInput!] list input types​

The subscription's lines. Lines left out are removed.

SubscriptionUpdateInput.notes ● String scalar types​

Notes about the subscription.

SubscriptionUpdateInput.overwriteChildCustomAttributes ● Boolean scalar types​

Whether to overwrite custom attributes that were edited on individual upcoming orders. Defaults to false.

SubscriptionUpdateInput.paymentMethodId ● GlobalID scalar types​

The ID of the payment method to charge for the subscription's orders.

Member Of​

subscriptionUpdate mutation