GET api/PaymentPlan/{token}

Get payment plans available for this booking

Request Information

URI Parameters

Name	Description	Type	Additional information
token	The tour search token	string	Required

Body Parameters

None.

Response Information

Resource Description

PaymentPlanResponse

Name	Description	Type	Additional information
token	The tour search token	string	None.
response	The response object	PaymentPlanGroups	None.
status	The response status	ResponseStatus	None.
success	An indication that the request was successfully completed or failed	boolean	None.
datestamp	The date and time that the request was completed	date	None.

Response Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "response": {
    "tourCode": 1,
    "departureDate": "sample string 1",
    "totalPrice": 1.1,
    "deposit": 1.1,
    "balanceDueDate": "sample string 2",
    "bookDate": "sample string 3",
    "startAfterXDaysOfBooking": 1,
    "endBeforeXDaysAfterBalanceDueDate": 1,
    "bookedXDaysBeforeBalanceDueDate": 1,
    "earliestStartDate": "sample string 4",
    "latestEndDate": "sample string 5",
    "paymentDays": [
      1,
      2
    ],
    "plans": [
      {
        "paymentDay": 1,
        "initialPayment": 2.1,
        "recurringPayment": 3.1,
        "numberOfPayments": 4,
        "outstandingAmount": 5.1,
        "period": "sample string 6",
        "startDate": "sample string 7",
        "endDate": "sample string 8",
        "paymentDates": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "paymentDay": 1,
        "initialPayment": 2.1,
        "recurringPayment": 3.1,
        "numberOfPayments": 4,
        "outstandingAmount": 5.1,
        "period": "sample string 6",
        "startDate": "sample string 7",
        "endDate": "sample string 8",
        "paymentDates": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  },
  "status": {
    "code": 1,
    "message": "sample string 2"
  },
  "success": true,
  "datestamp": "2026-08-03T20:53:22.7352307+01:00"
}