type PaymentPlanSession
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for this payment plan session |
orgId | ID! | ID of the organization this payment session belongs to |
contactId | ID! | ID of the platform contact associated with this payment plan session |
contact | Contact | 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 |
status | PaymentPlanSessionStatus! | Status of the payment plan session |
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 |
link | URL | Link to the payment plan session. Redirect the customer here, or use it to drive an embedded payment flow, depending on the configuration provided. Always present on sessions created going forward; older sessions may carry null. The link stops working once the session is no longer Active. |
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 |
createdAt | DateTime! | Date the payment session was created |
updatedAt | DateTime! | Date the payment session was last updated |
checkoutConfigurationId | ID | The checkout configuration ID used for this payment session. |
brandLogoUrl | URL | Optional caller-supplied URL to a logo image to display during checkout, overriding the default branding. |
brandName | String | Optional caller-supplied brand or merchant name to display during checkout, overriding the organization name. |