Reference
Effective savings rate, globally and per account
What the same usage would have cost at public on-demand rates against what it actually cost, for the organization and for each account that consumed the benefit. The rate is split into the part a negotiated agreement earns and the part commitments earn, because the public on-demand price sits above both and an account owning no commitment at all would otherwise report a healthy rate. esr_pct is the rate after idle commitment, and is null until the month is complete. months adds that many calendar months ending at period, for the organization, each payer and each account.
Authorization
BearerAuth In: header
Query Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/commitments/esr"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"period": "string",
"scope": "string",
"measured_share_pct": 0,
"totals": {
"measured": true,
"on_demand_equivalent": 0,
"effective_cost": 0,
"commitment_saved": 0,
"negotiated_saved": 0,
"total_saved": 0,
"commitment_rate_pct": 0,
"negotiated_rate_pct": 0,
"total_rate_pct": 0,
"unused_commitment_cost": 0,
"unused_rate_pct": 0,
"esr_pct": 0
},
"accounts": [
{
"measured": true,
"on_demand_equivalent": 0,
"effective_cost": 0,
"commitment_saved": 0,
"negotiated_saved": 0,
"total_saved": 0,
"commitment_rate_pct": 0,
"negotiated_rate_pct": 0,
"total_rate_pct": 0,
"unused_commitment_cost": 0,
"unused_rate_pct": 0,
"esr_pct": 0,
"account_id": "string",
"account_name": "string"
}
],
"latest_complete_period": "string",
"excluded_non_usd_cost": 0,
"series": [
{
"measured": true,
"on_demand_equivalent": 0,
"effective_cost": 0,
"commitment_saved": 0,
"negotiated_saved": 0,
"total_saved": 0,
"commitment_rate_pct": 0,
"negotiated_rate_pct": 0,
"total_rate_pct": 0,
"unused_commitment_cost": 0,
"unused_rate_pct": 0,
"esr_pct": 0,
"period": "string",
"complete": true,
"measured_share_pct": 0
}
],
"account_series": [
{
"account_id": "string",
"account_name": "string",
"organization_id": "string",
"months": [
{
"measured": true,
"on_demand_equivalent": 0,
"effective_cost": 0,
"commitment_saved": 0,
"negotiated_saved": 0,
"total_saved": 0,
"commitment_rate_pct": 0,
"negotiated_rate_pct": 0,
"total_rate_pct": 0,
"unused_commitment_cost": 0,
"unused_rate_pct": 0,
"esr_pct": 0,
"period": "string",
"complete": true
}
]
}
],
"organizations": [
{
"organization_id": "string",
"series": [
{
"measured": true,
"on_demand_equivalent": 0,
"effective_cost": 0,
"commitment_saved": 0,
"negotiated_saved": 0,
"total_saved": 0,
"commitment_rate_pct": 0,
"negotiated_rate_pct": 0,
"total_rate_pct": 0,
"unused_commitment_cost": 0,
"unused_rate_pct": 0,
"esr_pct": 0,
"period": "string",
"complete": true,
"measured_share_pct": 0
}
]
}
]
}
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}Get commitment detail GET
Previous Page
Where the purchase renewing this commitment stands GET
The latest purchase run of this commitment's renewal, with the steps, logs and trigger of the recommendation that renews it. not_started until somebody releases the renewal. queued once released and waiting for the term to end, or once the provider queued the purchase. in_progress while a run holds it. active once the provider reports the new commitment active, or once the renewal was completed by hand. payment_failed when the provider could not charge for it. failed when a run was refused before sending or the provider refused the purchase. indeterminate when nobody knows yet whether the purchase went through: it is reconciled, never retried. A commitment the organization does not hold is a 404.