Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Task Management/ Changing the Billing Mode from Pay-per-Use to Yearly/Monthly
Updated on 2024-10-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Changing the Billing Mode from Pay-per-Use to Yearly/Monthly

Function

This API is used to change the billing mode of a real-time synchronization or DR task from pay-per-use to yearly/monthly.

URI

POST /v5/{project_id}/job/{job_id}/change-to-period

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

ID of the task for changing the billing mode to yearly/monthly.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

X-Language

No

String

Request language type.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

period_type

Yes

String

Order type. The values are as follows:

  • 2: monthly
  • 3: yearly

period_num

Yes

Integer

Number of subscription periods.

is_auto_renew

Yes

Boolean

Whether to enable automatic renewal.

is_auto_pay

Yes

Boolean

Whether to enable automatic payment.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

order_id

String

Order ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Changing the billing mode from pay-per-use to yearly/monthly

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/job/39cda050-66c7-4afc-8023-dd525eajb2d9/change-to-period

{
  "period_type" : "2",
  "period_num" : 1,
  "is_auto_renew" : false,
  "is_auto_pay" : false
}

Example Response

Status code: 200

OK

{
  "order_id" : "CS2405300934ADBGS"
}

Status code: 400

Bad Request

{
  "error_code" : "CMM.1009",
  "error_msg" : "Parameter for Provisioning."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Task Management