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

Create payment plan to define recurring billing schedules. - Determines billing frequency and charge amount. - Can be configured for perpetual billing or fixed number of billing periods. - Foundational to subscription billing; ensure configuration matches pricing structure. - Multiple customers can subscribe to a single plan for standard pricing tiers.

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 from the search result.\n\r\n> Note: Default: `0`. Used with limit parameter for pagination.\n\r\n> Tip: Use this field for implementing paginated results.
02	limit	Integer	No	100	Maximum number of records to load per search call.\n\r\n> Note: Default: `100`. Adjust based on performance requirements.\n\r\n> Tip: Use this field to balance response size and performance.
03	accountId	Integer	No		Specifies the merchant account to associate with the plan. This field is required for all plan operations.\n\r\n> Note: If your API user is associated with multiple merchant accounts, you must specify which account this plan belongs to.
04	name	String(255)	No		Name of the payment plan. This field is required.\n\r\n> Note: This name appears in reports and may be visible to customers depending on your implementation.
05	billingCycleType	String	No		Billing cycle type applied to the plan. This field is required.\n\r\n> Note: Default: `M` (Monthly). Determines how often customers are billed.
06	createDateFrom	Date	No		Date when the plan was created.\n\r\n> Note: Auto-generated by the system; do not include in the create request. Format: yyyy-MM-dd HH:mm:ss.
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 amount charged on each billing cycle, specified in cents. This field is required.\n\r\n> Note: Specify amount in cents, not dollars. For example: $5.00 = 500 cents.
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 when the plan was created.\n\r\n> Note: Auto-generated by the system; do not include in the create request. Format: yyyy-MM-dd HH:mm:ss.
11	amount	Integer	No		The amount charged on each billing cycle, specified in cents. This field is required.\n\r\n> Note: Specify amount in cents, not dollars. For example: $5.00 = 500 cents.