Cart Test
Web/Cart/{sessionKey}/Payments/Plan/Schedule/Preview
Returns the payment schedule that would be applied to the current cart for the selected billing schedule without applying it to the cart.

The number of payments, payment amounts, and payment due dates are calculated based on the selected billing schedule. For details on setting up billing schedules see the TR_BILLING_SCHEDULE section of the System Tables document.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/Plan/Schedule/Preview

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : PaymentPlanSchedulePreviewRequest

Request object type PaymentPlanSchedulePreviewRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
BillingScheduleId integer Y The Billing Schedule to use to preview this plan.
FK: TR_BILLING_SCHEDULE.id   Resource: BillingSchedules
EndDate date Y The End Date for the schedule.
OverrideAmountToSchedule decimal number N If supplied, this value will be used for the amount to schedule instead of the cart total. Any additional amount due in the cart will be included in a payment due on the cart date.
StartDate date Y The Start Date for the schedule. 
{
  "StartDate": "2025-04-24T04:58:25.9057624-07:00",
  "EndDate": "2025-04-24T04:58:25.9057624-07:00",
  "BillingScheduleId": 1,
  "OverrideAmountToSchedule": 1.0
}
<PreviewPaymentPlanScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BillingScheduleId>1</BillingScheduleId>
  <EndDate>2025-04-24T04:58:25.9057624-07:00</EndDate>
  <OverrideAmountToSchedule>1</OverrideAmountToSchedule>
  <StartDate>2025-04-24T04:58:25.9057624-07:00</StartDate>
</PreviewPaymentPlanScheduleRequest>

Response object type : Collection of PaymentPlanPreview

Response object type Collection of PaymentPlanPreview has the following properties.
Property Name Data Type Length Required Readonly Notes
AmountDue decimal number
DateDue date 
[
  {
    "AmountDue": 1.0,
    "DateDue": "2025-04-24T04:58:25.9057624-07:00"
  },
  {
    "AmountDue": 1.0,
    "DateDue": "2025-04-24T04:58:25.9057624-07:00"
  }
]
<PaymentPlanPreviews xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentPlanPreview>
    <AmountDue>1</AmountDue>
    <DateDue>2025-04-24T04:58:25.9057624-07:00</DateDue>
  </PaymentPlanPreview>
  <PaymentPlanPreview>
    <AmountDue>1</AmountDue>
    <DateDue>2025-04-24T04:58:25.9057624-07:00</DateDue>
  </PaymentPlanPreview>
</PaymentPlanPreviews>
Change Version Description Contract Old New
Operation Added 15.1.0 PreviewPaymentPlanBasedOnBillingSchedule has been added. PreviewPaymentPlanBasedOnBillingSchedule