BillingPlansListResponse

pageinteger

The current pagination page

perPageinteger

The requested number of entries per page

lastPageinteger

The last page with entries

totalinteger

The total number of entries

firstPageUrlstring

URL for the first page

lastPageUrlstring

URL for the last page

nextPageUrlstringnullable

URL for the next page

previousPageUrlstringnullable

URL for the previous page

nextPageintegernullable

The page number for the next page. Null if no next page.

previousPageintegernullable

The page number for the previous page. Null if no previous page.

frominteger

The entry offset for the first entry in the page

tointeger

The entry offset for the last entry in the page

pathstring

The path for the pagination endpoint

items object[]

The page contents

Array [

billingPlan object

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.

iduuidrequired

Unique identifier for the billing plan.

namestringrequired

Human-readable name of the billing plan.

amountintegerrequired

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

currencystringrequired

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

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

maxAttemptsintegerrequired

Maximum number of billing attempts allowed per billing period.

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

createdAtdate-timerequired

Timestamp when the billing plan was created.

]

BillingPlansListResponse

{
  "page": 0,
  "perPage": 0,
  "lastPage": 0,
  "total": 0,
  "firstPageUrl": "string",
  "lastPageUrl": "string",
  "nextPageUrl": "string",
  "previousPageUrl": "string",
  "nextPage": 0,
  "previousPage": 0,
  "from": 0,
  "to": 0,
  "path": "string",
  "items": [
    {
      "billingPlan": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "amount": 0,
        "currency": "string",
        "maxAttempts": 0,
        "interval": {
          "period": "MONTH",
          "frequency": 1
        },
        "createdAt": "2024-07-29T15:51:28.071Z"
      }
    }
  ]
}