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

Querying Available Sales Cycles

Function

This API is used to query available sales cycles.

URI

GET /v2/{domain_id}/sale-cycles

Table 1 URI parameter

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID in the URI.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

zone_code

No

String

Area code.

Request Parameters

Table 3 Request header parameter

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 type. Options:

  • FULL: All upfront payments

  • HALF: Half upfront payments

  • PAID_BY_YEAR: Yearly payments

  • ZERO_PAID_BY_YEAR: Yearly payments without upfront

period_type

String

Subscription period type.

  • year: Yearly

period_num

Array of integers

Sales cycle value.

Example Request

Querying available sales cycles.

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

Example Response

Status code: 200

successful operation

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

Status Code

Status Code

Description

200

successful operation

Error Codes

For details, see Error Codes.

Parent topic: Sales Cycles