This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Financial Management

1 - BillingPlan

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of BillingPlan service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

1.1 - CLIs

1.1.1 - Change Request Planned Compute

1.1.1.1 - 1.0

scpcli billingplan set planned compute
--planned_compute_id <value>
[--action <value>]
[--contract_type <value>]
[--server_type <value>]

Description

Change action request planned compute.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
planned_compute_id
required
stringPlanned Compute Id5f3688a192094ddeb0c94166a3e88935
action
optional
stringPlanned Compute change request action typeEXTEND_CHANGE
contract_type
optional
****Contract type is required in the case of EXTEND_APPLY or EXTEND_CHANGE01
server_type
optional
stringServer Type is required in the case of SERVER_TYPE_CHANGEs1v1m2

1.1.2 - Create Request Planned Computes

1.1.2.1 - 1.0

scpcli billingplan create planned computes
--service_id <value>
--server_type <value>
--os_type <value>
--contract_type <value>
[--service_name <value>]
[--tag <value>]

Description

Create request planned compute.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
service_id
required
stringService IdVIRTUAL_SERVER
server_type
required
stringServer Types1v1m2
os_type
required
stringOS TypeOPEN_SOURCE
contract_type
required
stringContract Type01
service_name
optional
stringService NameVirtual Server
tag
optional
arrayTag Form'{"key": "key1", "value": "value1"}'

Responses

NameDescriptionExample
idPlanned Compute Id5f3688a192094ddeb0c94166a3e88935
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
contract_idContract IdC002612775
contract_typeContract Type1-year
created_atCreated date2024-08-01 00:00:00
created_byCreated byuser123
delete_ynDelete or notN
end_dateEnd date (YYYY-MM-dd)2024-08-01
first_contract_start_atStart date (YYYY-MM-dd)2024-08-01
modified_atModified date2024-08-01 00:00:00
modified_byModified bykim
next_contract_typeNext Contract Type1-year
next_end_dateNext End date (YYYY-MM-dd)2024-08-31
next_start_dateNext Start date (YYYY-MM-dd)2024-08-01
os_nameOS NameOpen Source
os_typeOS TypeOPEN_SOURCE
regionRegionkr-west1
resource_nameResource Nametest-vm
resource_typeResource Typeinstance
server_typeServer Types1v1m2
server_type_descriptionServer Type Description
service_idService IdVIRTUAL_SERVER
service_nameService NameVirtual Server
srnSRNsrn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
start_dateStart date (YYYY-MM-dd)2024-08-01
statePlanned Compute StateACTIVE

1.1.3 - Get Planned Compute

1.1.3.1 - 1.0

scpcli billingplan get planned computes
--planned_compute_id <value>

Description

Get planned compute.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
planned_compute_id
required
stringPlanned Compute Id5f3688a192094ddeb0c94166a3e88935

Responses

NameDescriptionExample
idPlanned Compute Id5f3688a192094ddeb0c94166a3e88935
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
contract_idContract IdC002612775
contract_typeContract Type1-year
created_atCreated date2024-08-01 00:00:00
created_byCreated byuser123
delete_ynDelete or notN
end_dateEnd date (YYYY-MM-dd)2024-08-01
first_contract_start_atStart date (YYYY-MM-dd)2024-08-01
modified_atModified date2024-08-01 00:00:00
modified_byModified bykim
next_contract_typeNext Contract Type1-year
next_end_dateNext End date (YYYY-MM-dd)2024-08-31
next_start_dateNext Start date (YYYY-MM-dd)2024-08-01
os_nameOS NameOpen Source
os_typeOS TypeOPEN_SOURCE
regionRegionkr-west1
resource_nameResource Nametest-vm
resource_typeResource Typeinstance
server_typeServer Types1v1m2
server_type_descriptionServer Type Description
service_idService IdVIRTUAL_SERVER
service_nameService NameVirtual Server
srnSRNsrn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
start_dateStart date (YYYY-MM-dd)2024-08-01
statePlanned Compute StateACTIVE

1.1.4 - GetCancellationFee

1.1.4.1 - 1.0

scpcli billingplan get cancellation fee
--planned_compute_id <value>
[--region <value>]

Description

Get Cancellation Fee

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
planned_compute_id
required
arrayPlanned Compute Id5
region
optional
stringRegionkr-west1

Responses

NameDescriptionExample
codeCurrency codeKRW
symbolCurrency Symbol

1.1.5 - List Contract Type

1.1.5.1 - 1.0

scpcli billingplan list planned compute contract types
[--service_id <value>]
[--server_type <value>]

Description

Get Contract Type List.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
service_id
optional
stringService IdVIRTUAL_SERVER
server_type
optional
stringServer Types1v1m2

Responses

NameDescriptionExample
codeContract Code01
display_nameDisplay Name1-year

1.1.6 - List OS System

1.1.6.1 - 1.0

scpcli billingplan list os types
[--service_id <value>]

Description

Get Os System List.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
service_id
optional
stringService IdVIRTUAL_SERVER

Responses

NameDescriptionExample
display_nameDisplay NameOpen Source
os_type_idOS Type idOPEN_SOURCE
os_type_valueDisplay Nameopensource

1.1.7 - List Planned Compute Covered Resource

1.1.7.1 - 1.0

scpcli billingplan list planned compute instances
--end_date <value>
--start_date <value>
--server_type <value>
--os_type <value>
--service_id <value>

Description

Get Planned Compute Covered Resource List.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
end_date
required
stringEnd date (YYYY-MM-dd)2024-08-01
start_date
required
stringStart date (YYYY-MM-dd)2024-08-01
server_type
required
stringServer Types1v1m2
os_type
required
stringOS TypeOPEN_SOURCE
service_id
required
stringService IdVIRTUAL_SERVER

Responses

NameDescriptionExample
contract_idContract IdC002612775
non_applied_amountNon Applied Amount
request_atRequest At2024-08-01 00:00:00
resource_nameResource Nametest-vm
unit_priceUnit Price
used_amountUsed amount
used_timeUsed time Hour10

1.1.8 - ListServerType

1.1.8.1 - 1.0

scpcli billingplan list planned compute server types
[--service_id <value>]
[--current_server_type <value>]
[--os_type <value>]

Description

Get Server Type List

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
service_id
optional
stringService IdVIRTUAL_SERVER
current_server_type
optional
stringServer Types1v1m2
os_type
optional
stringOS TypeOPEN_SOURCE

Responses

NameDescriptionExample
coreInstance Core1
gpu_nameGpu Model Namea100
instance_typeInstance Types1
memory_gbInstance Memory GB2
scale_up_ynScale up or not. If server_type > current_server_type, it’s represented as Y. if smaller N.Y
server_typeServer Types1v1m2
server_type_descriptionServer Type Description

1.1.9 - ListServiceType

1.1.9.1 - 1.0

scpcli billingplan list planned compute service types

Description

Get Service Type List

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Responses

NameDescriptionExample
display_nameDisplay NameVirtual Server
service_idService IdVIRTUAL_SERVER

2 - Budget

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Budget service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

2.1 - CLIs

2.1.1 - CreateAccountBudget

2.1.1.1 - 1.0

scpcli budget account budget create
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]

Description

create a account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
unit
required
stringBudget management unit (MONTHLY or OVERALL)MONTHLY
start_month
required
stringBudget start month (ex.YYYY-MM)2026-01
name
required
stringBudget nametest_budget
amount
required
integerBudget amount1000000
is_use_notification
optional
booleanNotification use stateTrue
notification_send_period
optional
stringThe notification frequency can be FIRST, DAILY, or NONE.FIRST
receivers
optional
arrayPrevention notification recipient email list.test_user1@test.com
thresholds
optional
arrayThresholds for receiving threshold exceed notification email: 70/80/90/100.80
is_use_prevention
optional
booleanAuto Generation prevent use stateTrue
threshold
optional
integerThreshold for receiving prevention notification email: 70/80/90/100.80

Responses

NameDescriptionExample
idBudget id240200fd2b02490ca63bb3965048b493
amountBudget amount1000000
created_atCreated datetime2025-11-01T00:00:00
created_byCreated userTEST
modified_atModified datetime2025-11-01T00:00:00
modified_byModified userTEST
nameBudget namemy_budget_ex
start_monthBudget start month (ex.YYYY-MM)2025-11
typeBudget typeCOST
unitBudget management unit (MONTHLY or OVERALL)MONTHLY

2.1.2 - DeleteAccountBudget

2.1.2.1 - 1.0

scpcli budget account budget delete
--budget_id <value>

Description

delete a specific account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493

2.1.3 - ListAccountBudgets

2.1.3.1 - 1.0

scpcli budget account budget list
[--size <value>]
[--page <value>]
[--sort <value>]
[--search_name <value>]
[--budget_name <value>]

Description

get account budgets list

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
search_name
optional
stringBudget namemy_budget_ex
budget_name
optional
stringBudget namemy_budget_ex

Responses

NameDescriptionExample
idBudget id240200fd2b02490ca63bb3965048b493
amountBudget amount1000000
created_atCreated datetime2025-11-01T00:00:00
created_byCreated userTEST
modified_atModified datetime2025-11-01T00:00:00
modified_byModified userTEST
nameBudget namemy_budget_ex
start_monthBudget start month (ex.YYYY-MM)2025-11
typeBudget typeCOST
unitBudget management unit (MONTHLY or OVERALL)MONTHLY

2.1.4 - SetAccountBudget

2.1.4.1 - 1.0

scpcli budget account budget set
--budget_id <value>
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]

Description

set a specific account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493
unit
required
stringBudget management unit (MONTHLY or OVERALL)MONTHLY
start_month
required
stringBudget start month (ex.YYYY-MM)2026-01
name
required
stringBudget nametest_budget
amount
required
integerBudget amount1000000
is_use_notification
optional
booleanNotification use stateTrue
notification_send_period
optional
stringThe notification frequency can be FIRST, DAILY, or NONE.FIRST
receivers
optional
arrayPrevention notification recipient email list.test_user1@test.com
thresholds
optional
arrayThresholds for receiving threshold exceed notification email: 70/80/90/100.80
is_use_prevention
optional
booleanAuto Generation prevent use stateTrue
threshold
optional
integerThreshold for receiving prevention notification email: 70/80/90/100.80

2.1.5 - ShowAccountBudget

2.1.5.1 - 1.0

scpcli budget account budget show
--budget_id <value>

Description

show a specific account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493

Responses

NameDescriptionExample
idBudget id240200fd2b02490ca63bb3965048b493
amountBudget amount1000000
created_atCreated datetime2025-11-01T00:00:00
created_byCreated userTEST
modified_atModified datetime2025-11-01T00:00:00
modified_byModified userTEST
nameBudget namemy_budget_ex
start_monthBudget start month (ex.YYYY-MM)2025-11
typeBudget typeCOST
unitBudget management unit (MONTHLY or OVERALL)MONTHLY

3 - CostExplorer

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of CostExplorer service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

3.1 - CLIs

3.1.1 - GetPaymentMonthly

3.1.1.1 - 1.0

scpcli costexplorer payment monthly show
[--size <value>]
[--page <value>]

Description

Get payment monthly data.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integerSize10
page
optional
integerPage1

Responses

NameDescriptionExample
accumulated_unpaid_amount
bill_amount
bill_currencyCurrencyKRW
bill_year_monthBill year Month2024-08
paid_amount
payer_account_idPayer Account Id228cb9e4a7934f84853594c7f26f7a21
payer_account_namePayer Account Nametest-account
payer_account_typePayer Account TypeMEMBER
payment_currencyCurrencyKRW
payment_datePayment date2024-08-01
payment_stateBilling StatePAID
suspended_year_monthYear-Month (YYYY-mm)2024-08
unpaid_amount
used_amount
used_year_monthYear-Month (YYYY-mm)2024-08

3.1.2 - ListBills

3.1.2.1 - 1.0

scpcli costexplorer bill list
[--start_year_month <value>]
[--end_year_month <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]
[--bill_year_month <value>]
[--bill_state <value>]

Description

Get bill list.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
start_year_month
optional
stringStart year-month (YYYY-mm)2024-08
end_year_month
optional
stringEnd year-month (YYYY-mm)2024-08
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Id228cb9e4a7934f84853594c7f26f7a21
service_category
optional
stringService CategoryCOMPUTE
billing_item_id
optional
stringBilling Item IdVIRTUAL_SERVER
resource_name
optional
stringResource Nametest-vm
region
optional
stringRegionkr-west1
contract_id
optional
stringContract IdC002612775
order_status
optional
stringCCBS Order Status04
bill_year_month
optional
stringBill Date (YYYY-MM)2024-07
bill_state
optional
stringBilling StateUSED

Responses

NameDescriptionExample
idBill Id5f3688a192094ddeb0c94166a3e88935
account_cost_savingsAccount Cost Savings{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_creditAccount Credit{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
amountsTotal Amounts{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
assetAsset amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
bill_stateBilling StateUSED
bill_year_monthBill year Month2024-07
billing_item_idBilling Item IdVIRTUAL_SERVER
cancellation_fee해지 수수료{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
contract_idContract IdC002612775
discount_amountsTotal Discount Amounts{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
edpEDP{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
msp_discountMSP 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
new_business_discount신규 사업 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
operationOperation amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
optionOption amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
order_statusCCBS Order Status04
planned_computePlanned Compute{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_cost_savingsProject Cost Savings{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_creditProject Credit{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
regionRegionkr-west1
reseller_discount리셀러 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
resource_idResource Id7f6741f3-d9f0-4262-9a5f-627e373567a7
resource_nameResource Nametest-vm
sales_discount영업(기타) 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
service_categoryService CategoryCOMPUTE
sla_discountSLA{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
support_planSupport Plan{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}

3.1.3 - ListUsages

3.1.3.1 - 1.0

scpcli costexplorer usages list
[--start_date <value>]
[--end_date <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]

Description

Get usage list.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
start_date
optional
stringStart date (YYYY-MM-dd)2024-08-01
end_date
optional
stringEnd date (YYYY-MM-dd)2024-08-01
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Id228cb9e4a7934f84853594c7f26f7a21
service_category
optional
stringService CategoryCOMPUTE
billing_item_id
optional
stringBilling Item IdVIRTUAL_SERVER
resource_name
optional
stringResource Nametest-vm
region
optional
stringRegionkr-west1
contract_id
optional
stringContract IdC002612775
order_status
optional
stringCCBS Order Status04

Responses

NameDescriptionExample
idUsages Id5f3688a192094ddeb0c94166a3e88935
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
amountsAmount{‘krw’: ‘500.0000000000’, ‘usd’: ‘0.0’}
billing_item_idBilling Item IdVIRTUAL_SERVER
ccbs_product_codeCCBS Product CodePD00013862
contract_idContract IdC002612775
order_statusCCBS Order Status04
resource_idResource Id7f6741f3-d9f0-4262-9a5f-627e373567a7
service_categoryService CategoryCOMPUTE
status_codeUsage status code0
usage_dateUsage date2024-08-01T00:00:00

4 - Pricing

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Pricing service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

4.1 - CLIs

4.1.1 - ListBillingItemIds

4.1.1.1 - 1.0

scpcli pricing 

Description

Get billing item ID list.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Responses

NameDescriptionExample
billing_item_idsList of all billing item IDsVIRTUAL_SERVER

4.1.2 - ListOffering

4.1.2.1 - 1.0

scpcli pricing 

Description

Get offering list.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Responses

NameDescriptionExample
offeringsList of offering types[‘PS’, ‘PP’, ‘PG’]

4.1.3 - ListReportPrice

4.1.3.1 - 1.0

scpcli pricing 
[--size <value>]
[--page <value>]
[--sort <value>]
[--billing_item_id <value>]
[--offering <value>]

Description

Get prices with optional filtering by billing_item_id and offering.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
billing_item_id
optional
stringFilter by billing item IDVIRTUAL_SERVER
offering
optional
stringFilter by offering type (PS/PP/PG)PP

Responses

NameDescriptionExample
attributesPrice attributes
billing_item_idBilling Item IDVIRTUAL_SERVER
currency_codeCurrency CodeVIRTUAL_SERVER
offeringOffering type (PP/PS/PG)PP
price_modelPrice model enum nameVIRTUAL_SERVER
price_unitPrice unit enum nameVIRTUAL_SERVER
pricesPrice ranges
proration_ruleProration rule enum namePRORATION
rounding_positionRounding positionVIRTUAL_SERVER
rounding_ruleRounding rule enum nameROUND_DOWN