Cart Test
Web/Cart/{sessionKey}/Payments/Plan/Installments
Sets a payment plan on the cart using a start date, end date and a list of installments with amount and due date.

The total of the installment amounts must add up to the cart total. /Web/Cart/Validation can be used to validate that the payment plan is correct by passing True for ValidatePaymentPlan in that method.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/Plan/Installments

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : PaymentPlanInstallmentRequest

Request object type PaymentPlanInstallmentRequest 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 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.
PaymentPlanInstallments Collection of PaymentPlanInstallment Y The list of installment dates and amounts. The total amount in this collection must equal the cart due total. 
{
  "PaymentPlanInstallments": [
    {
      "DueDate": "2025-04-24T09:20:36.6779924-07:00",
      "Amount": 1.0
    },
    {
      "DueDate": "2025-04-24T09:20:36.6779924-07:00",
      "Amount": 1.0
    }
  ],
  "AccountId": 1,
  "Card": {
    "PaymentMethodGroupId": 1,
    "Name": "sample string 1",
    "Number": "sample string 2",
    "ExpiryMonth": 3,
    "ExpiryYear": 4
  },
  "BillingTypeId": 1
}
<PaymentPlanInstallmentRequest 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>
  <PaymentPlanInstallments>
    <PaymentPlanInstallment>
      <Amount>1</Amount>
      <DueDate>2025-04-24T09:20:36.6779924-07:00</DueDate>
    </PaymentPlanInstallment>
    <PaymentPlanInstallment>
      <Amount>1</Amount>
      <DueDate>2025-04-24T09:20:36.6779924-07:00</DueDate>
    </PaymentPlanInstallment>
  </PaymentPlanInstallments>
</PaymentPlanInstallmentRequest>

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-24T09:20:36.6779924-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-24T09:20:36.6779924-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-24T09:20:36.6779924-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-24T09:20:36.6779924-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
Property Changed 15.0.0 PaymentPlanInstallments has changed from List`1 to PaymentPlanInstallments PaymentPlanInstallmentRequest List`1 PaymentPlanInstallments