HppRecurringPlan
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The recurring-schedule definition inlined onto a `HostedPaymentPage` (and snapshotted onto the session it creates) for the `SaveCardWithInitialCharge` flow. Carries the economics a Contract is built from after the initial charge: the recurring amount, cadence, total payment count, and an optional first-charge override. It is a definition, not a live schedule: no per-customer state, next-run date, or payment method (those land on the `Contract` created from it under the paying customer).
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
recurringAmount
required |
number (double) | The amount charged on each recurring payment after the initial charge.
greater than 0
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
frequency
required |
Frequency Frequency | The frequency unit of the recurring schedule (e.g. Monthly, Weekly).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
interval
required |
integer (int32) | The interval multiplier for `frequency` (e.g. `Frequency = Monthly` with
`Interval = 3` is every three months). Defaults to 1.
min 1
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
numberOfPayments
required |
integer (int32) | Total number of payments in the schedule, <b>including</b> the initial charge. A Contract
instantiated from this definition covers the payments after the initial charge
(`GetScheduledPaymentCount`).
min 2
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
initialChargeAmount
required |
number (double) | Optional override for the first (initial) charge amount. When `null`, the initial charge
uses `recurringAmount`. Lets a merchant charge a different amount up front (e.g. a
setup fee bundled into payment one) while the recurring schedule stays at
`recurringAmount`.
Conditional: When InitialChargeAmount is not null. Must be > 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
managementUrl
required |
string | The HTTPS address of a page where the payer can update or cancel this recurring payment.
Apple Pay shows it on the recurring payment sheet and requires it on a recurring request, so a
plan without one never asks Apple Pay for a merchant token, and Apple Pay is not offered on its
sessions. Optional, 200 characters or fewer. Snapshotted onto the session with the rest of the
plan, so a payer enrolls under the address that was in effect when their link was created.
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.