CreateBillingPlanRequest

namestringrequired

Human-readable name of the billing plan.

Possible values: non-empty and <= 256 characters

amountintegerrequired

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

Possible values: >= 1

currencystringrequired

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

Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

instantCapturestringnullable

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)

Possible values: [OFF, VOID, NO_VOID]

Default value: OFF

Example: OFF

maxAttemptsintegerrequired

Maximum number of billing attempts before giving up.

Possible values: >= 1 and <= 31

interval objectrequired

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

periodstringrequired

The time unit of the frequency field

Possible values: [DAY, WEEK, MONTH, YEAR]

Example: MONTH

frequencyintegerrequired

The number of period's between each charge.

Possible values: >= 1 and <= 31

Example: 1

CreateBillingPlanRequest

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