Recurring Plan API

For merchants to retrieve recurring plans info which were created from the merchant portal.


Response (JSON format)

Variable / Parameter

Type Format / Max Length

Description / Example

planID

n-9

Unique ID for each plan.

plan_name

ans-63

Plan name.

plan_desc

ans-254

Plan description.

amount

n2

The total amount to be paid in each cycle.

period

a-5

  1. month
  2. week
  3. day
  4. year
  5. quarter
  6. half year
  7. bimonthly
  8. biweekly

status

a-1

  1. On
  2. Off
  3. NA

cycle_term

n-9

Billing cycle (e.g., 6, 12, 24)

charge_on_endofmonth

a1

  1. Y
  2. N

Formula of skey

md5( {domain}{secret_key}{charge_on_endofmonth}{period}{cycle_term}{status} )

Appendix A : Error Code & Description in JSON

error_codeerror_mesg
PLAN001Missing required parameter (<FieldName>).
PLAN002Merchant info not found.
PLAN003Invalid skey.
PLAN004Plan not found.
PLAN005The system is busy now, temporarily out of service. Please try again later.
PLAN006Invalid parameter value (<FieldName>).
Language
Click Try It! to start a request and see the response here!