Cart Test
Web/Cart/{sessionKey}/Payments/Plan/NumberOfPayments
Sets a payment plan on the cart using a start date, end date and a specific number of payments to be spread across the date range.

The due date for the first payment is set to the entered beginning date, and the due date for subsequent payments is calculated by adding an equal number of days to each previous payment, based on the amount of time between the beginning and ending dates.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/Plan/NumberOfPayments

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : PaymentPlanRequest

Request object type PaymentPlanRequest 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.
BillingTypeId integer N The billing type for the payment 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.
NumberOfPayments integer Y The desired number of payments.
StartDate date Y The Start Date for the schedule. 
{
  "StartDate": "2025-04-24T05:01:02.9800364-07:00",
  "EndDate": "2025-04-24T05:01:02.9800364-07:00",
  "NumberOfPayments": 1,
  "AccountId": 1,
  "Card": {
    "PaymentMethodGroupId": 1,
    "Name": "sample string 1",
    "Number": "sample string 2",
    "ExpiryMonth": 3,
    "ExpiryYear": 4
  },
  "BillingTypeId": 1
}
<PaymentPlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountId>1</AccountId>
  <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-24T05:01:02.9800364-07:00</EndDate>
  <NumberOfPayments>1</NumberOfPayments>
  <StartDate>2025-04-24T05:01:02.9800364-07:00</StartDate>
</PaymentPlanRequest>

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-24T05:01:02.9956521-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-24T05:01:02.9956521-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-24T05:01:02.9956521-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-24T05:01:02.9956521-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