CreateBillingPlanRequest | ePay documentation

namestring

Required

Human-readable name of the billing plan.

Length:

1 <= length <= 256

amountinteger

Required

Charge amount (in the smallest currency unit, e.g. cents).

Range:

1 <= value

currencystring

Required

ISO 4217 alpha-3 currency code (e.g., USD, EUR).

Match:

^[A-Z]{3}$

Length:

3 <= length <= 3

instantCapturestring

Nullable

The InstantCapture mode to use for all charges related to the plan.

OFF indicates that the payment should not be captured instantly (Default).

VOID indicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided.

NO_VOID indicates that the payment should be captured instantly and if the capture fails the authorization is kept (no void is made)

The `InstantCapture` mode to use for all charges related to the plan.<ul><li> `OFF` indicates that the payment should not be captured instantly (Default).</li><li> `VOID` indicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided.</li><li> `NO_VOID` indicates that the payment should be captured instantly and if the capture fails the authorization is kept (no void is made)</li></ul>

Default:

"OFF"

Possible values:

"OFF""VOID""NO_VOID"

Example:

"OFF"

maxAttemptsinteger

Required

Maximum number of billing attempts before giving up.

Range:

1 <= value <= 31

The frequency between automatic charges. A frequency=2 and period=WEEK means one charge every two weeks.

The frequency between automatic charges. A `frequency=2` and `period=WEEK` means one charge every two weeks.

periodstring

Required

The time unit of the frequency field

Possible values:

"DAY""WEEK""MONTH""YEAR"

Example:

"MONTH"

frequencyinteger

Required

The number of period's between each charge.

Range:

1 <= value <= 31

Example:

1