BillingAgreementsListResponse | ePay documentation

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

nextPageUrlstring

Nullable

URL for the next page

previousPageUrlstring

Nullable

URL for the previous page

nextPageinteger

Nullable

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

previousPageinteger

Nullable

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

The page contents

Represents an automated, recurring payment agreement between a merchant and a cardholder. Links a Subscription to a Billing Plan so ePay can manage scheduled charges and track billing status.

BillingAgreementsListResponse

{  "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": [    {      "billingAgreement": {        "id": "019a729e-2d93-7612-9329-8f783f66f834",        "billingPlanId": "019a729e-41c2-7d16-a1e2-fdb15a8146bb",        "subscriptionId": "019a729e-51ed-7426-b7c9-0e212b2d77d4",        "sessionId": "019a729e-660a-7a05-90ad-5160ad0decc5",        "customerId": "user-1",        "nextChargeAt": "2030-08-29T15:51:28.071Z",        "lastChargeAt": "2030-07-29T15:51:28.071Z",        "desiredDate": 30,        "state": "PENDING",        "stateChangedAt": "2030-07-29T15:51:28.071Z",        "reference": "agreement-1",        "createdAt": "2030-07-29T15:51:28.071Z"      }    }  ]}