Top-level input fields for creating a subscription.
paymentID!RequiredThe payment method to use for this subscription. Accepts single-use or vaulted payment methods.
planID!RequiredRequired. The plan identifier.
The descriptor for bank statements.
merchantIDThe merchant account ID used to create the subscription's transactions. Currency is determined by merchant account ID and must match the plan's currency.
modificationsRecurringHow to apply add-on and discount modifications. If omitted, the plan's add-ons and discounts are inherited.
Controls when the subscription starts billing. Only one option may be provided. If omitted, the plan's default settings are used.
priceAmountThe base price for the subscription. Must be a positive value (e.g., 10 or 10.00). Overrides the plan's price regardless of billing frequency. Currency is determined by the merchant account.
input CreateRecurringBillingSubscriptionInput {
clientMutationId: String
planId: ID!
paymentMethodId: ID!
merchantAccountId: ID
descriptor: RecurringBillingSubscriptionDescriptorInput
price: Amount
numberOfBillingCycles: Int
options: RecurringBillingSubscriptionOptionsInput
payPalDescription: String
modifications: RecurringBillingSubscriptionModificationInput
}