Cart Test
Web/Cart/{sessionKey}/Payments/Plan/Schedule
Sets a payment plan on the cart using a start date, end date and a pre-defined billing schedule.

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

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : PaymentPlanScheduleRequest

Request object type PaymentPlanScheduleRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountId integer The account to use for billing. This account must belong to the logged in constituent.
BillingScheduleId integer Y The Billing Schedule to use to create this plan.
FK: TR_BILLING_SCHEDULE.id   Resource: BillingSchedules
BillingTypeId integer N The billing type for this plan.
FK: TR_BILLING_TYPE.id   Resource: BillingTypes
Card PaymentPlanCard The Credit card to use for the payment plan. Required if the specified billing type is marked as "Auto Bill" and an AccountId is not being passed in.
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:23.2647935-07:00",
  "EndDate": "2025-04-24T04:58:23.2647935-07:00",
  "BillingScheduleId": 1,
  "AccountId": 1,
  "Card": {
    "PaymentMethodGroupId": 1,
    "Name": "sample string 1",
    "Number": "sample string 2",
    "ExpiryMonth": 3,
    "ExpiryYear": 4
  },
  "BillingTypeId": 1,
  "OverrideAmountToSchedule": 1.0
}
<PaymentPlanScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountId>1</AccountId>
  <BillingScheduleId>1</BillingScheduleId>
  <BillingTypeId>1</BillingTypeId>
  <Card>
    <ExpiryMonth>3</ExpiryMonth>
    <ExpiryYear>4</ExpiryYear>
    <Name>sample string 1</Name>
    <Number>sample string 2</Number>
    <PaymentMethodGroupId>1</PaymentMethodGroupId>
  </Card>
  <EndDate>2025-04-24T04:58:23.2647935-07:00</EndDate>
  <OverrideAmountToSchedule>1</OverrideAmountToSchedule>
  <StartDate>2025-04-24T04:58:23.2647935-07:00</StartDate>
</PaymentPlanScheduleRequest>

Response object type : Collection of PaymentPlan

Response object type Collection of PaymentPlan has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountId integer
AmountDue decimal number
BillingType EntitySummary
Card PaymentPlanCard
DateDue date
Id integer 
[
  {
    "Id": 1,
    "AmountDue": 2.0,
    "AccountId": 3,
    "DateDue": "2025-04-24T04:58:23.2647935-07:00",
    "BillingType": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "Card": {
      "PaymentMethodGroupId": 1,
      "Name": "sample string 1",
      "Number": "sample string 2",
      "ExpiryMonth": 3,
      "ExpiryYear": 4
    }
  },
  {
    "Id": 1,
    "AmountDue": 2.0,
    "AccountId": 3,
    "DateDue": "2025-04-24T04:58:23.2647935-07:00",
    "BillingType": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "Card": {
      "PaymentMethodGroupId": 1,
      "Name": "sample string 1",
      "Number": "sample string 2",
      "ExpiryMonth": 3,
      "ExpiryYear": 4
    }
  }
]
<PaymentPlans xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentPlan>
    <AccountId>3</AccountId>
    <AmountDue>2</AmountDue>
    <BillingType>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </BillingType>
    <Card>
      <ExpiryMonth>3</ExpiryMonth>
      <ExpiryYear>4</ExpiryYear>
      <Name>sample string 1</Name>
      <Number>sample string 2</Number>
      <PaymentMethodGroupId>1</PaymentMethodGroupId>
    </Card>
    <DateDue>2025-04-24T04:58:23.2647935-07:00</DateDue>
    <Id>1</Id>
  </PaymentPlan>
  <PaymentPlan>
    <AccountId>3</AccountId>
    <AmountDue>2</AmountDue>
    <BillingType>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </BillingType>
    <Card>
      <ExpiryMonth>3</ExpiryMonth>
      <ExpiryYear>4</ExpiryYear>
      <Name>sample string 1</Name>
      <Number>sample string 2</Number>
      <PaymentMethodGroupId>1</PaymentMethodGroupId>
    </Card>
    <DateDue>2025-04-24T04:58:23.2647935-07:00</DateDue>
    <Id>1</Id>
  </PaymentPlan>
</PaymentPlans>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required