BillingPlan | ePay documentation

Defines the configuration for recurring billing, including price, interval, and retry behavior. Used by Billing Agreements to determine how and when ePay processes scheduled charges.

idstring

Required

Unique identifier for the billing plan.

Format:

uuid

instantCapturestring

If the payment should be captured instantly or not.

OFF indicates that the payment should not be captured instantly.

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)

If the payment should be captured instantly or not.<ul><li> `OFF` indicates that the payment should not be captured instantly.</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>

Possible values:

"OFF""VOID""NO_VOID"

namestring

Required

Human-readable name of the billing plan.

colorstring

Nullable

An optional hex color, which is used visually in the ePay backoffice

emojistring

Nullable

An optional single emoji, which is used visually in the ePay backoffice

amountinteger

Required

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

currencystring

Required

ISO 4217 three-letter currency code (e.g., USD, EUR).

Match:

^[A-Z]{3}$

Length:

3 <= length <= 3

maxAttemptsinteger

Required

Maximum number of billing attempts allowed per billing period.

Defines the recurring billing interval.

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

createdAtstring

Required

Timestamp when the billing plan was created.

Format:

date-time

BillingPlan

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "instantCapture": "OFF",  "name": "string",  "color": "string",  "emoji": "string",  "amount": 0,  "currency": "str",  "maxAttempts": 0,  "interval": {    "period": "MONTH",    "frequency": 1  },  "createdAt": "2019-08-24T14:15:22Z"}