Help Center/ CloudPond/ API Reference/ API/ Sales Cycles/ Querying Available Sales Cycles
Updated on 2025-12-08 GMT+08:00
View PDF
Share

Querying Available Sales Cycles

Function

This API is used to query available sales cycles.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    ies::listSaleCycles

    List

    -

    -
    • ies:system:listSaleCycles

    -

URI

GET /v2/{domain_id}/sale-cycles

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID in the path.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

zone_code

No

String

Area code.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

sale_cycles

Array of SaleCycleOption objects

Sales cycle information.
Table 5 SaleCycleOption

Parameter

Type

Description

pay_mode

String

Yearly/Monthly payment.

  • FULL: full upfront

  • HALF: half upfront

  • PAID_BY_YEAR: Yearly

  • ZERO_PAID_BY_YEAR: zero upfront, yearly

period_type

String

Yearly/Monthly type.

  • year

period_num

Array of integers

Sales cycle value.

Example Requests

Example request for querying available sales cycles

GET https://{ies_endpoint}/v2/{domain_id}/sale-cycles

Example Responses

Status code: 200

successful operation

{
  "sale_cycles" : [ {
    "pay_mode" : "FULL",
    "period_type" : "year",
    "period_num" : [ 1, 3 ]
  } ]
}

Status Codes

Status Code

Description

200

successful operation

Error Codes

See Error Codes.

Parent topic: Sales Cycles