BillingPlan
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:
uuidinstantCapturestring
If the payment should be captured instantly or not.
OFFindicates that the payment should not be captured instantly.VOIDindicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided.NO_VOIDindicates that the payment should be captured instantly and if the capture fails the authorization is kept (no void is made)
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 <= 3maxAttemptsinteger
Required
Maximum number of billing attempts allowed per billing period.
Defines the recurring billing interval.
createdAtstring
Required
Timestamp when the billing plan was created.
Format:
date-time