Sign in
Commitment Plans

/commitment-plans/{plan_id}

Retrieves detailed information about a specific commitment plan, including costs, savings projections, and commitment coverage.

get/v1/org/{org_id}/commitment-plans/{plan_id}

Response

OK

idstring uuid required
namestring required
descriptionstring nullable
org_idstring uuid required
created_atstring date-time required
is_calculatingboolean required
status'new' | 'reviewed' | 'scheduled' | 'completed' | 'draft' | 'needs_review' | 'in_progress' required
max_termstring nullable required
covered_ondemand_cost_hourlynumber required
before_ondemand_cost_hourlynumber required
before_reserved_cost_hourlynumber required
amortized_cost_hourlynumber required
recurring_cost_hourlynumber required
upfront_cost_hourlynumber required
before_cost_hourlynumber required
after_cost_hourlynumber required
total_cost_hourlynumber required
savings_hourlynumber required
fee_hourlynumber required
commitment_coveragenumber required
minimum_commitment_costnumber required
breakeven_hoursnumber required
total_savingsnumber required
monthly_savingsnumber required
total_monthly_before_costnumber required

Changes

No recorded changes to this endpoint across all 6 revisions of this API.