Skip to main content
GET
/
v2
/
org
/
{org_id}
/
partners
/
purchase-plans-v2
/
recommended
/recommended
curl --request GET \
  --url https://api.example.com/v2/org/{org_id}/partners/purchase-plans-v2/recommended \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data_source": "<string>",
  "name": "<string>",
  "description": "<string>",
  "segment_id": "<string>",
  "meta_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "<string>",
  "last_modified": "2023-11-07T05:31:56Z",
  "plan_type": "purchase",
  "coverage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "is_calculating": true,
  "is_saved": true,
  "is_locked": true,
  "max_upfront_cost": 123,
  "minimum_upfront_interest_rate": 123,
  "preferred_payment_option": "<string>",
  "included_contract_types": [
    "leased_db_ris"
  ],
  "included_contract_specs": [
    {
      "commitment_type": "<string>",
      "properties": {}
    }
  ],
  "included_contract_terms": [
    "one_year"
  ],
  "recommend_within_covered_accounts": true,
  "status": "new",
  "is_recommended": true,
  "is_default": true,
  "is_renewal": true,
  "execution_policy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "last_modified": "2023-11-07T05:31:56Z",
    "schedule": "quarterly",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "enabled": true,
    "next_execution_date": "2023-11-07T05:31:56Z",
    "meta_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_plan_name": "<string>",
    "min_savings": 123,
    "meta_plan": {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "created_by": {
      "username": "<string>",
      "id": "<string>",
      "full_name": "<string>"
    },
    "plans": [
      {
        "id": "<string>",
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "segment": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "is_default": true,
    "provider": "aws"
  },
  "flagged_actions": [
    {
      "plan_id": "<string>",
      "id": "<string>",
      "org_id": "<string>",
      "user_id": "<string>",
      "provider": "<string>",
      "action_type": "<string>",
      "action_description": null,
      "status": "submitted",
      "creation_time": "2023-11-07T05:31:56Z",
      "execution_time": "2023-11-07T05:31:56Z",
      "execution_info": null,
      "plan": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "is_default": true,
        "status": "new"
      }
    }
  ],
  "created_by": {
    "username": "<string>",
    "id": "<string>",
    "full_name": "<string>"
  },
  "resource_ids": [
    "<string>"
  ],
  "reservation_ids": [
    "<string>"
  ],
  "max_term": "<string>",
  "covered_ondemand_cost": 123,
  "before_ondemand_cost": 123,
  "before_reserved_cost": 123,
  "amortized_cost": 123,
  "recurring_cost": 123,
  "upfront_cost": 123,
  "before_cost": 123,
  "after_cost": 123,
  "total_cost": 123,
  "savings": 123,
  "fee": 123,
  "commitment_coverage": 123,
  "minimum_commitment_cost": 123,
  "breakeven_hours": 123,
  "total_savings": 123,
  "monthly_savings": 123,
  "total_monthly_before_cost": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "aggregate_metrics": {
    "potential_coverage": 123,
    "current_coverage": 123,
    "summaries": {}
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
org_id
string<uuid>
required

Query Parameters

​
provider
enum<string>
required
Available options:
aws,
azure,
gcp,
kubernetes,
unknown

Response

OK

​
id
string<uuid>
required
​
data_source
string
required
Maximum string length: 20
​
name
string
required
​
description
string | null
required
​
segment_id
string
required
Maximum string length: 50
​
meta_plan_id
string<uuid> | null
required
​
org_id
string
required
Maximum string length: 50
​
last_modified
string<date-time> | null
required
​
plan_type
enum<string>
required
Available options:
purchase,
renewal,
infrastructure
​
coverage_id
string<uuid> | null
required
​
created_at
string<date-time>
required
​
is_calculating
boolean
required
​
is_saved
boolean
required
​
is_locked
boolean
required
​
max_upfront_cost
number
required
​
minimum_upfront_interest_rate
number
required
​
preferred_payment_option
string
required
​
included_contract_types
enum<string>[]
required
Available options:
leased_db_ris,
db_ris,
leased_ris,
standard_ris,
compute_plans,
instance_plans,
convertible_ris,
ris,
sagemaker_plans,
leased_compute_plans,
leased_sagemaker_plans,
dynamodb,
leased_dynamodb,
apache_cassandra,
app_service,
azure_monitor,
arcdb,
backup,
cognitive_services,
container_apps,
container_instances,
cosmosdb,
data_explorer,
data_factory_v2,
databricks,
functions,
mariadb,
microsoft_defender,
microsoft_fabric,
mysql,
netapp_files,
postgresql,
redis_cache,
sentinel,
specialized_compute,
specialized_compute_avs,
specialized_compute_sap_hana,
specialized_compute_nutanix,
spring_cloud,
sql_database,
sql_edge,
sql_managed_instance,
storage,
synapse_analytics,
synapse_analytics_warehouse,
vm,
vml,
avs,
leased_apache_cassandra,
leased_app_service,
leased_azure_monitor,
leased_arcdb,
leased_backup,
leased_cognitive_services,
leased_container_apps,
leased_container_instances,
leased_cosmosdb,
leased_data_explorer,
leased_data_factory_v2,
leased_databricks,
leased_functions,
leased_mariadb,
leased_microsoft_defender,
leased_microsoft_fabric,
leased_mysql,
leased_netapp_files,
leased_postgresql,
leased_redis_cache,
leased_sentinel,
leased_specialized_compute,
leased_specialized_compute_avs,
leased_specialized_compute_sap_hana,
leased_specialized_compute_nutanix,
leased_spring_cloud,
leased_sql_database,
leased_sql_edge,
leased_sql_managed_instance,
leased_storage,
leased_synapse_analytics,
leased_synapse_analytics_warehouse,
leased_vm,
leased_vml,
leased_avs
​
included_contract_specs
object[]
required
​
included_contract_terms
enum<string>[]
required
Available options:
one_year,
three_year,
one_year_gris,
thirty_day_gris
​
recommend_within_covered_accounts
boolean | null
required
​
status
enum<string>
required
Available options:
new,
reviewed,
scheduled,
completed,
draft,
needs_review,
in_progress
​
is_recommended
boolean
required
​
is_default
boolean
required
​
is_renewal
boolean
required
​
execution_policy
object
required
​
segment
object
required
​
flagged_actions
object[]
required
​
created_by
object
required
​
resource_ids
string[]
required
​
reservation_ids
string[]
required
​
max_term
string
required
​
covered_ondemand_cost
number
required
​
before_ondemand_cost
number
required
​
before_reserved_cost
number
required
​
amortized_cost
number
required
​
recurring_cost
number
required
​
upfront_cost
number
required
​
before_cost
number
required
​
after_cost
number
required
​
total_cost
number
required
​
savings
number
required
​
fee
number
required
​
commitment_coverage
number
required
​
minimum_commitment_cost
number
required
​
breakeven_hours
number
required
​
total_savings
number
required
​
monthly_savings
number
required
​
total_monthly_before_cost
number
required
​
start_date
string<date-time> | null
​
end_date
string<date-time> | null
​
aggregate_metrics
object