PaymentPlanSession
Mutations
createPaymentPlanSessionAuthenticatedCreates a payment plan session used by the checkout process to create and authorize a payment plan.updatePaymentPlanSessionAuthenticatedUpdates a payment plan session used by the checkout process to create and authorize a payment plan.sendPaymentPlanSessionLinkAuthenticatedSends the payment plan session's link to the customer via the requested channel. The session must be Active. Fails when no recipient is available — either the contact lacks an email/phone for the chosen channel and no `to` override was provided.
Types
AmountA monetary amount with up to two decimal places. Ex. 111.11ContactCreatePaymentPlanSessionInputCurrencyThree letter ISO 4217 currency code. Ex. USDDateISO 8601 formatted date in the format YYYY-MM-DDDateTimeISO 8601 formatted date time. Ex. 2023-11-23T14:30:00ZEmailAn email addressOperationSuccessOperational return type representing success or failure with a message.PaymentPlanFrequencyPaymentPlanSessionPaymentPlanSessionStatusPaymentSessionLinkChannelChannel used to deliver a session link to the merchant's customer.PhoneE.164 formatted phone number. Ex. +14155554345SendPaymentPlanSessionLinkInputUpdatePaymentPlanSessionInputURLA URL with protocol and port. ex. https://example.com