Management API

Base Resource URL:


                    https://[server-name]/api/v01/plans

Description:

Provides access to the pricing plans available within the system.

Available sub-resources:

Resource URL	Description
https://[server-name]/api/v01/plans/[plan-id]	Provides access to configuration settings for the selected pricing plan.

Supported Actions:

create

Method: PUT	Implicit: Yes	Returns: Plan *
Consumes: json, xml		Produces: json, xml

Creates a pricing plan.

Parameters:

#	Name	Type	Required	Default	Description
01	object	Plan *	Yes		Represents information about the plan.

find

Method: GET	Implicit: Yes	Returns: Plan[] *
Consumes: xurl		Produces: json, xml

Returns a list of available pricing plans based on specified search criteria.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.
03	accountId	Integer	No		Account ID used for filtering records.
04	name	String(255)	No		Name of the Plan used for filtering Plan records.
05	billingCycleType	String	No		Type of a Billing Cycle used for filtering Plan records.
06	createDateFrom	Date	No		Date when the pricing plan has been created.
07	createDateTo	Date	No		The concluding date for filtering Plan records; only records up to and through this specified date are included.
08	amountFrom	Integer	No		The starting date for filtering Plan records; only records dated from this specific day onwards are included.
09	amountTo	Integer	No		The upper amount limit for filtering Plan records; only those with values up to and through this specified amount are included.
10	createDate	Date	No		Date used for filtering Plan records.
11	amount	Integer	No		Amount used for filtering Plan records.