Skip to main content
POST
Roll a managed plan into its next period

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

plan_id
integer
required

Plan id in the current organization.

Body

application/json

Validated request fields for this operation.

version
integer
required

Current plan version for optimistic concurrency. Stale versions return 409.

Required range: x >= 1
Example:

1

period_start
string<date>
required

Period start. Validation: required, date_format:Y-m-d.

Example:

"2026-10-20"

period_end
string<date>
required

Period end. Validation: required, date_format:Y-m-d, after_or_equal:period_start.

Example:

"2026-10-20"

goal_amount
number
required

Goal amount. Validation: required, numeric, min:0, max:9999999999999.99.

Required range: 0 <= x <= 9999999999999.99
Example:

25

tier
enum<string> | null

Tier. Validation: nullable; allowed values: A, B, C.

Available options:
A,
B,
C,
null
Example:

"A"

target_ask_amount
number | null

Target ask amount. Validation: nullable, numeric, min:0, max:9999999999999.99.

Required range: 0 <= x <= 9999999999999.99
Example:

25

action_donor_id
integer | null

Action donor id. Validation: nullable, integer, min:1.

Required range: x >= 1
Example:

1

include_incomplete_future_moves
boolean | null

Include incomplete future moves. Validation: nullable, boolean.

Example:

true

Response

Operation result.

status
string
Example:

"success"

data
object

Strategy fields, moves and reviews are omitted unless permissions.can_view_strategy is true; mutations return the refreshed plan workspace unless their response says otherwise.