ID of the organization this payment session belongs to

ID of the platform contact associated with this payment plan session

Payment amount to be charged on the configured frequency.

Currency of the payment

Frequency of the payment plan

Start date of the payment plan

Number of payment occurrences to be run on the configured frequency from the start date

URL to receive payment session events

URL to redirect after a payment session is canceled by the customer

URL to redirect after a payment session is completed by the customer

Optional expiration date for the payment session. ISO 8601 format.

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.

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.

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.

Optional brand or merchant name to display during checkout, overriding the organization name.

Optional key-value pairs stored with the session and returned unchanged, for your own references such as a subscription or customer id. At most 25 entries, each key unique. A key is 1 to 40 characters of letters, digits, underscores, hyphens and periods; a value is at most 500 bytes of UTF-8. Metadata is not shown to the customer, and may only be set on payment plan session creation.