input CreatePaymentPlanSessionInput
| Field | Type | Description |
|---|---|---|
orgId | ID! | ID of the organization this payment session belongs to |
contactId | ID! | ID of the platform contact associated with this payment plan session |
amount | Amount! | Payment amount to be charged on the configured frequency. |
currency | Currency! | Currency of the payment |
frequency | PaymentPlanFrequency! | Frequency of the payment plan |
startDate | Date! | Start date of the payment plan |
occurrences | Int! | Number of payment occurrences to be run on the configured frequency from the start date |
callbackUrl | URL | URL to receive payment session events |
cancelUrl | URL | URL to redirect after a payment session is canceled by the customer |
successUrl | URL | URL to redirect after a payment session is completed by the customer |
expirationDate | DateTime | Optional expiration date for the payment session. ISO 8601 format. |
createPendingPaymentPlan | Boolean | Optionally create a pending payment plan record for this payment plan session. Default is false which means a payment plan record is created upon payment plan session completion. Set this to true if you require a pending payment plan to be visible in the payment plan list in the dashboard. This is useful for use cases involving payment plan sessions without expirations. This setting may only be set on payment plan session creation. |
checkoutConfigurationId | ID | The 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. |
brandLogoUrl | URL | Optional URL to a logo image to display during checkout, overriding the default branding. The caller supplies a URL that is used to render the logo. |
brandName | String | Optional brand or merchant name to display during checkout, overriding the organization name. |