Recurring Payments Service Forecast

Forecast Controller

Get a Plan Forecast

get

Query parameters

end-dateanyOptional

required for monthly plans, format yyyy-mm-dd

frequencyanyRequired

frequency

frequency-dayanyRequired

if plan is weekly, indicates day of the week. if plan is monthly/yearly, indicates day of the month

frequency-monthanyOptional

if frequency is monthly, controls how many months apart payments are. if frequency is yearly, controls what month of the year the payment will fire

frequency-weekanyOptional

required if frequency is weekly; controls how many weeks apart payments are

start-dateanyRequired

format yyyy-mm-dd

Header parameters

api-keyanyRequired

API key

Responses

200

OK

application/jsonapplication/xml

401

Unauthorized

403

Forbidden

404

Not Found

get

HTTPcURLJavaScriptPython

GET //rest/v2/plan-forecast HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*

{
  "code": 200,
  "emvUrl": "text",
  "exchange-id": "ID_38839393-3938383-484848484",
  "gatewayUrl": "text",
  "links": [
    {
      "href": "/rest/v2/transactions?id=846512",
      "id": 846512,
      "rel": "transaction"
    }
  ],
  "page": {
    "first": false,
    "last": false,
    "number": 4,
    "number-of-elements": 102,
    "size": 4,
    "sort": {
      "field": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "total-elements": 102,
    "total-pages": 4
  },
  "payload": {
    "payloadType": "text"
  },
  "signature": "text",
  "status": "SUCCESS",
  "urls": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "vaultUrl": "text"
}