API Reference

Create Plan

post
https://api.portone.cloud/api/subscription/createPlan

Use this API for Creating Plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The unique PortOne key for merchant

string
required

The signature_hash of plan generated as per Regular Plan Request Signature Documentation or Ondemand Plan Request Signature Documentation

string
required

The unique merchant order reference generated by the merchant

string
enum
required

default, api or checkout -- The Source of Plan creation.

Allowed:
string

The description of the plan

string
enum
required

The environment of plan. Either live OR sandbox

Allowed:
string
required

The name of the plan

notes
array of objects

Additional Notes

Additional Notes
string
required

The currency of the plan

string
enum
required

The type of plan

Allowed:
double

The amount of the plan, can be a floating-point number. Required only for REGULAR Plan, not available for ONDEMAND Plan

integer
≥ 1

The frequency of the plan (must be greater than 0). Required only for REGULAR Plan, not available for ONDEMAND Plan

string
enum

The period of the plan. Required only for REGULAR Plan, not available for ONDEMAND Plan. Hour period is only for testing purpose.

Allowed:
Headers
string
string

The PortOne Key of the merchant

string

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token in this guide

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Have Questions? Contact Us
© 2024 PortOne SG Pte. Ltd