Cart Test
Web/Cart/{sessionKey}/Payments/Plan
Allows the billing and credit card information to be updated on an existing payment plan for the cart.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/Plan

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : UpdatePaymentPlanRequest

Request object type UpdatePaymentPlanRequest 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 Y 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. 
{
  "AccountId": 1,
  "Card": {
    "PaymentMethodGroupId": 1,
    "Name": "sample string 1",
    "Number": "sample string 2",
    "ExpiryMonth": 3,
    "ExpiryYear": 4
  },
  "BillingTypeId": 1
}
<UpdatePaymentPlanRequest 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>
</UpdatePaymentPlanRequest>

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:30.8209745-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:30.8209745-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:30.8209745-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:30.8209745-07:00</DateDue>
    <Id>1</Id>
  </PaymentPlan>
</PaymentPlans>

No entries in change log for this operation.