POST

/CreateSavingsPlan

http://savingsplans.{region}.amazonaws.com/CreateSavingsPlan

Creates a Savings Plan.

Access Token Required: API Key

Body Params

tagsobject

One or more tags.

commitmentstringrequired

The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.

clientTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

purchaseTimestring

The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

upfrontPaymentAmountstring

The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is <code>Partial Upfront</code>.

savingsPlanOfferingIdstringrequired

The ID of the offering.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://savingsplans.{region}.amazonaws.com/CreateSavingsPlan' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}