input UpdatePaymentPlanSessionInput
| Field | Type | Description |
|---|---|---|
orgId | ID! | ID of the organization this payment session belongs to. |
id | ID! | Unique identifier for the payment plan session. |
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. |
paymentPlanId | ID | ID of the payment plan created by this payment plan session |
status | PaymentPlanSessionStatus | Status of the payment plan session. |
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. |