input UpdatePaymentPlanSessionInput

FieldTypeDescription
orgIdID!ID of the organization this payment session belongs to.
idID!Unique identifier for the payment plan session.
contactIdIDID of the platform contact associated with this payment plan session
amountAmountPayment amount to be charged on the configured frequency.
currencyCurrencyCurrency of the payment
frequencyPaymentPlanFrequencyFrequency of the payment plan
startDateDateStart date of the payment plan
occurrencesIntNumber of payment occurrences to be run on the configured frequency from the start date
callbackUrlURLURL to receive payment session events
cancelUrlURLURL to redirect after a payment session is canceled by the customer
successUrlURLURL to redirect after a payment session is completed by the customer
expirationDateDateTimeOptional expiration date for the payment session. ISO 8601 format.
paymentPlanIdIDID of the payment plan created by this payment plan session
statusPaymentPlanSessionStatusStatus of the payment plan session.
checkoutConfigurationIdIDThe checkout configuration ID to be used for this payment plan session. If a checkout configuration ID is not provided, the default checkout configuration will be used.