Looking for ePay classic docs? Go to docs.epay.dk
ePay documentationDocsePay documentation

CreateBillingPlanRequest

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)
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.

CreateBillingPlanRequest
{  "name": "string",  "amount": 1,  "currency": "str",  "instantCapture": "OFF",  "maxAttempts": 1,  "interval": {    "period": "MONTH",    "frequency": 1  }}