Get savings plan next recurrence date.

The endpoint allows the calculation of the next recurrence date before creating the savings plan. The next recurrence date returned from this endpoint is the same value that would be returned from the create savings plan endpoint.

SecuritybearerAuth
Request
query Parameters
frequency
required
string

The frequency of the savings plan (weekly, biweekly, monthly).

Enum: "weekly" "biweekly" "monthly"
Example: frequency=weekly
day
required
integer [ 1 .. 31 ]

Day of the savings plan execution. For a weekly & biweekly frequency, it's accepted only a value between 1...7 where 1 = Monday...7 = Sunday. For a monthly frequency it's accepted only a value between 1...31.

Example: day=5
Responses
200

Success Response.

401

Unauthorized

403

Forbidden

404

Not Found

405

Not Allowed

422

Validation Error

429

Too Many Requests

500

Internal Error

503

Maintenance or Service unavailable

get/v1/savings-plan/next-recurrence
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}