Skip to main content

Fields

paymentFrequency : String

The frequency of the payment plan (e.g., 'Monthly', 'Weekly').

paymentFrequencyMultiplier : Int

The multiplier for the payment frequency (e.g., 1, 2, 3, etc.).

paymentPlanId : String

The ID string of the payment plan.

paymentPlanStatus : String

The status of the payment plan.

totalAmountPaid : Int

Total paid into the plan in pence.

totalAmountRemaining : Int

Total remaining amount to be paid in the plan in pence.

totalPlanValue : Int

Total amount included in the plan at setup, in pence.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "paymentFrequency": "fund-size-particularly-next-light", "paymentFrequencyMultiplier": 35, "paymentPlanId": "49642969", "paymentPlanStatus": "ok-miss-threat-consumer-hot", "totalAmountPaid": 18022385, "totalAmountRemaining": 31, "totalPlanValue": 72 }