Top-level input fields for updating a subscription.
subscriptionID!RequiredThe ID of the subscription to update.
Update the bank statement descriptor fields.
merchantIDThe merchant account ID used to create the subscription's transactions. Currency is also determined by merchant account ID and it must match the Plan's currency.
modificationsRecurringHow to apply add-on and discount modifications.
Optional execution flags for subscription updates.
paymentIDThe payment method identifier to use for this subscription. Accepts single-use or multi-use payment methods. A single-use payment method will be vaulted automatically.
planIDUpdating a plan only changes the association; the price is not automatically changed. You can only update to a plan with the same billing cycle. You can't edit the plan on a Past Due, Expired, or Canceled subscription.
priceAmountThe new base price for the subscription. Must be a positive decimal value (e.g., 10 or 10.00). Overrides the previous price. Cannot be changed if the subscription is Past Due, Expired, or Canceled. Currency is determined by the merchant account.
input UpdateRecurringBillingSubscriptionInput {
clientMutationId: String
subscriptionId: ID!
planId: ID
merchantAccountId: ID
price: Amount
numberOfBillingCycles: Int
paymentMethodId: ID
payPalDescription: String
modifications: RecurringBillingSubscriptionModificationInput
overrides: UpdateRecurringBillingSubscriptionOptionsInput
descriptor: RecurringBillingSubscriptionDescriptorInput
}