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

1.1: CLIs

1.1.1: Change Request Planned Compute

1.1.1.1: 1.0

1.1.2: Create Request Planned Computes

1.1.2.1: 1.0

1.1.3: Get Planned Compute

1.1.3.1: 1.0

1.1.4: GetCancellationFee

1.1.4.1: 1.0

1.1.5: List Contract Type

1.1.5.1: 1.0

1.1.6: List OS System

1.1.6.1: 1.0

1.1.7: List Planned Compute Covered Resource

1.1.7.1: 1.0

1.1.8: ListServerType

1.1.8.1: 1.0

1.1.9: ListServiceType

1.1.9.1: 1.0

2: Budget

2.1: CLIs

2.1.1: CreateAccountBudget

2.1.1.1: 1.0

2.1.2: DeleteAccountBudget

2.1.2.1: 1.0

2.1.3: ListAccountBudgets

2.1.3.1: 1.0

2.1.4: SetAccountBudget

2.1.4.1: 1.0

2.1.5: ShowAccountBudget

2.1.5.1: 1.0

3: CostExplorer

3.1: CLIs

3.1.1: GetPaymentMonthly

3.1.1.1: 1.0

3.1.2: ListBills

3.1.2.1: 1.0

3.1.3: ListUsages

3.1.3.1: 1.0

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

Version	Status	Supported Until
1.0	CURRENT	-

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
planned_compute_id required	string	Planned Compute Id	`5f3688a192094ddeb0c94166a3e88935`
action optional	string	Planned Compute change request action type	`EXTEND_CHANGE`
contract_type optional	****	Contract type is required in the case of EXTEND_APPLY or EXTEND_CHANGE	`01`
server_type optional	string	Server Type is required in the case of SERVER_TYPE_CHANGE	`s1v1m2`

1.1.2 - Create Request Planned Computes

1.1.2.1 - 1.0

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

Description

Create request planned compute.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
contract_type required	string	Contract Type	`01`
os_type required	string	OS Type	`OPEN_SOURCE`
server_type required	string	Server Type	`s1v1m2`
service_id required	string	Service Id	`VIRTUAL_SERVER`
service_name optional	string	Service Name	`Virtual Server`
tag optional	array	Tag Form	`'{"key": "key1", "value": "value1"}'`

Responses

Name	Description	Example
id	Planned Compute Id	5f3688a192094ddeb0c94166a3e88935
start_date	Start date (YYYY-MM-dd)	2024-08-01
end_date	End date (YYYY-MM-dd)	2024-08-01
contract_id	Contract Id	C002612775
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
region	Region	kr-west1
service_id	Service Id	VIRTUAL_SERVER
service_name	Service Name	Virtual Server
os_type	OS Type	OPEN_SOURCE
os_name	OS Name	Open Source
server_type	Server Type	s1v1m2
server_type_description	Server Type Description
srn	SRN	srn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
resource_type	Resource Type	instance
contract_type	Contract Type	1-year
next_contract_type	Next Contract Type	1-year
first_contract_start_at	Start date (YYYY-MM-dd)	2024-08-01
next_start_date	Next Start date (YYYY-MM-dd)	2024-08-01
next_end_date	Next End date (YYYY-MM-dd)	2024-08-31
state	Planned Compute State	ACTIVE
delete_yn	Delete or not	N
resource_name	Resource Name	test-vm
created_at	Created date	2024-08-01 00:00:00
created_by	Created by	user123
modified_at	Modified date	2024-08-01 00:00:00
modified_by	Modified by	kim

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
planned_compute_id required	string	Planned Compute Id	`5f3688a192094ddeb0c94166a3e88935`

Responses

Name	Description	Example
id	Planned Compute Id	5f3688a192094ddeb0c94166a3e88935
start_date	Start date (YYYY-MM-dd)	2024-08-01
end_date	End date (YYYY-MM-dd)	2024-08-01
contract_id	Contract Id	C002612775
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
region	Region	kr-west1
service_id	Service Id	VIRTUAL_SERVER
service_name	Service Name	Virtual Server
os_type	OS Type	OPEN_SOURCE
os_name	OS Name	Open Source
server_type	Server Type	s1v1m2
server_type_description	Server Type Description
srn	SRN	srn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
resource_type	Resource Type	instance
contract_type	Contract Type	1-year
next_contract_type	Next Contract Type	1-year
first_contract_start_at	Start date (YYYY-MM-dd)	2024-08-01
next_start_date	Next Start date (YYYY-MM-dd)	2024-08-01
next_end_date	Next End date (YYYY-MM-dd)	2024-08-31
state	Planned Compute State	ACTIVE
delete_yn	Delete or not	N
resource_name	Resource Name	test-vm
created_at	Created date	2024-08-01 00:00:00
created_by	Created by	user123
modified_at	Modified date	2024-08-01 00:00:00
modified_by	Modified by	kim

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
planned_compute_id required	array	Planned Compute Id	`5`
region optional	string	Region	`kr-west1`

Responses

Name	Description	Example
code	Currency code	KRW
symbol	Currency 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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
service_id optional	string	Service Id	`VIRTUAL_SERVER`
server_type optional	string	Server Type	`s1v1m2`

Responses

Name	Description	Example
code	Contract Code	01
display_name	Display Name	1-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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
service_id optional	string	Service Id	`VIRTUAL_SERVER`

Responses

Name	Description	Example
os_type_id	OS Type id	OPEN_SOURCE
display_name	Display Name	Open Source
os_type_value	Display Name	opensource

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
end_date required	string	End date (YYYY-MM-dd)	`2024-08-01`
start_date required	string	Start date (YYYY-MM-dd)	`2024-08-01`
server_type required	string	Server Type	`s1v1m2`
os_type required	string	OS Type	`OPEN_SOURCE`
service_id required	string	Service Id	`VIRTUAL_SERVER`

Responses

Name	Description	Example
resource_name	Resource Name	test-vm
contract_id	Contract Id	C002612775
used_time	Used time Hour	10
unit_price	Unit Price
used_amount	Used amount
non_applied_amount	Non Applied Amount
request_at	Request At	2024-08-01 00:00:00

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
service_id optional	string	Service Id	`VIRTUAL_SERVER`
current_server_type optional	string	Server Type	`s1v1m2`
os_type optional	string	OS Type	`OPEN_SOURCE`

Responses

Name	Description	Example
server_type	Server Type	s1v1m2
server_type_description	Server Type Description
instance_type	Instance Type	s1
core	Instance Core	1
memory_gb	Instance Memory GB	2
gpu_name	Gpu Model Name	a100
scale_up_yn	Scale up or not. If server_type > current_server_type, it’s represented as Y. if smaller N.	Y

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)

Version	Supported Until
1.0	-

Responses

Name	Description	Example
service_id	Service Id	VIRTUAL_SERVER
display_name	Display Name	Virtual 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

Version	Status	Supported Until

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
unit required	string	Budget management unit (MONTHLY or OVERALL)	`MONTHLY`
start_month required	string	Budget start month (ex.YYYY-MM)	`2026-01`
name required	string	Budget name	`test_budget`
amount required	integer	Budget amount	`1000000`
is_use_notification optional	boolean	Notification use state	`True`
notification_send_period optional	string	The notification frequency can be FIRST, DAILY, or NONE.	`FIRST`
receivers optional	array	Prevention notification recipient email list.	`test_user1@test.com`
thresholds optional	array	Thresholds for receiving threshold exceed notification email: 70/80/90/100.	`80`
is_use_prevention optional	boolean	Auto Generation prevent use state	`True`
threshold optional	integer	Threshold for receiving prevention notification email: 70/80/90/100.	`80`

Responses

Name	Description	Example
id	Budget id	240200fd2b02490ca63bb3965048b493
amount	Budget amount	1000000
created_at	Created datetime	2025-11-01T00:00:00
created_by	Created user	TEST
modified_at	Modified datetime	2025-11-01T00:00:00
modified_by	Modified user	TEST
name	Budget name	my_budget_ex
start_month	Budget start month (ex.YYYY-MM)	2025-11
type	Budget type	COST
unit	Budget 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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
budget_id required	string	Budget id	`240200fd2b02490ca63bb3965048b493`

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
search_name optional	string	Budget name	`my_budget_ex`
budget_name optional	string	Budget name	`my_budget_ex`

Responses

Name	Description	Example
id	Budget id	240200fd2b02490ca63bb3965048b493
amount	Budget amount	1000000
created_at	Created datetime	2025-11-01T00:00:00
created_by	Created user	TEST
modified_at	Modified datetime	2025-11-01T00:00:00
modified_by	Modified user	TEST
name	Budget name	my_budget_ex
start_month	Budget start month (ex.YYYY-MM)	2025-11
type	Budget type	COST
unit	Budget 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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
budget_id required	string	Budget id	`240200fd2b02490ca63bb3965048b493`
unit required	string	Budget management unit (MONTHLY or OVERALL)	`MONTHLY`
start_month required	string	Budget start month (ex.YYYY-MM)	`2026-01`
name required	string	Budget name	`test_budget`
amount required	integer	Budget amount	`1000000`
is_use_notification optional	boolean	Notification use state	`True`
notification_send_period optional	string	The notification frequency can be FIRST, DAILY, or NONE.	`FIRST`
receivers optional	array	Prevention notification recipient email list.	`test_user1@test.com`
thresholds optional	array	Thresholds for receiving threshold exceed notification email: 70/80/90/100.	`80`
is_use_prevention optional	boolean	Auto Generation prevent use state	`True`
threshold optional	integer	Threshold 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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
budget_id required	string	Budget id	`240200fd2b02490ca63bb3965048b493`

Responses

Name	Description	Example
id	Budget id	240200fd2b02490ca63bb3965048b493
amount	Budget amount	1000000
created_at	Created datetime	2025-11-01T00:00:00
created_by	Created user	TEST
modified_at	Modified datetime	2025-11-01T00:00:00
modified_by	Modified user	TEST
name	Budget name	my_budget_ex
start_month	Budget start month (ex.YYYY-MM)	2025-11
type	Budget type	COST
unit	Budget 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

Version	Status	Supported Until
1.0	CURRENT	-

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
size optional	integer	Size	`10`
page optional	integer	Page	`1`

Responses

Name	Description	Example
payer_account_id	Payer Account Id	228cb9e4a7934f84853594c7f26f7a21
payer_account_name	Payer Account Name	test-account
payer_account_type	Payer Account Type	MEMBER
bill_year_month	Bill year Month	2024-08
used_year_month	Year-Month (YYYY-mm)	2024-08
payment_date	Payment date	2024-08-01
bill_currency	Currency	KRW
payment_currency	Currency	KRW
payment_state	Billing State	PAID
bill_amount
used_amount
unpaid_amount
paid_amount
accumulated_unpaid_amount
suspended_year_month	Year-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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
start_year_month optional	string	Start year-month (YYYY-mm)	`2024-08`
end_year_month optional	string	End year-month (YYYY-mm)	`2024-08`
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
account_id optional	string	Account Id	`228cb9e4a7934f84853594c7f26f7a21`
service_category optional	string	Service Category	`COMPUTE`
billing_item_id optional	string	Billing Item Id	`VIRTUAL_SERVER`
resource_name optional	string	Resource Name	`test-vm`
region optional	string	Region	`kr-west1`
contract_id optional	string	Contract Id	`C002612775`
order_status optional	string	CCBS Order Status	`04`
bill_year_month optional	string	Bill Date (YYYY-MM)	`2024-07`
bill_state optional	string	Billing State	`USED`

Responses

Name	Description	Example
id	Bill Id	5f3688a192094ddeb0c94166a3e88935
amounts	Total Amounts	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
discount_amounts	Total Discount Amounts	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
asset	Asset amount	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
operation	Operation amount	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
option	Option amount	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
support_plan	Support Plan	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
cancellation_fee	해지 수수료	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
planned_compute	Planned Compute	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
msp_discount	MSP 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
new_business_discount	신규 사업 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
sales_discount	영업(기타) 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
sla_discount	SLA	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
reseller_discount	리셀러 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_cost_savings	Account Cost Savings	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_cost_savings	Project Cost Savings	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_credit	Account Credit	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_credit	Project Credit	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
edp	EDP	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
service_category	Service Category	COMPUTE
billing_item_id	Billing Item Id	VIRTUAL_SERVER
resource_id	Resource Id	7f6741f3-d9f0-4262-9a5f-627e373567a7
resource_name	Resource Name	test-vm
region	Region	kr-west1
contract_id	Contract Id	C002612775
order_status	CCBS Order Status	04
bill_year_month	Bill year Month	2024-07
bill_state	Billing State	USED

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)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
start_date optional	string	Start date (YYYY-MM-dd)	`2024-08-01`
end_date optional	string	End date (YYYY-MM-dd)	`2024-08-01`
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
account_id optional	string	Account Id	`228cb9e4a7934f84853594c7f26f7a21`
service_category optional	string	Service Category	`COMPUTE`
billing_item_id optional	string	Billing Item Id	`VIRTUAL_SERVER`
resource_name optional	string	Resource Name	`test-vm`
region optional	string	Region	`kr-west1`
contract_id optional	string	Contract Id	`C002612775`
order_status optional	string	CCBS Order Status	`04`

Responses

Name	Description	Example
id	Usages Id	5f3688a192094ddeb0c94166a3e88935
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
service_category	Service Category	COMPUTE
billing_item_id	Billing Item Id	VIRTUAL_SERVER
ccbs_product_code	CCBS Product Code	PD00013862
resource_id	Resource Id	7f6741f3-d9f0-4262-9a5f-627e373567a7
contract_id	Contract Id	C002612775
order_status	CCBS Order Status	04
usage_date	Usage date	2024-08-01T00:00:00
amounts	Amount	{‘krw’: ‘500.0000000000’, ‘usd’: ‘0.0’}
status_code	Usage status code	0