Create Subscription

post

https://api.portone.cloud/api/subscription/createSubscription

Create a Subscription link. In response you will get the Subscription Link reference and the Subscription link URL. You can share the subscription link with your customer. The master merchant can also create the subscription link for their sub-merchants, by passing the sub-merchant key as a header. Refer API docs for additional information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

portone_key

string

required

The unique PortOne key for merchant

signature_hash

string

required

The signature_hash of subscription generated as per Regular Subscription Request Signature Documentation or Ondemand Subscription Request Signature Documentation

merchant_order_ref

string

required

The unique merchant order reference generated by the merchant

description

string

Product name for the customer's subscription purchase

source

string

enum

required

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

Allowed:

customer_email_address

string

Email address of the customer

customer_name

string

Name of the customer

customer_phone_number

string

Phone number of the customer

currency

string

required

The currency of the subscription

environment

string

enum

required

The environment of transacation either live OR sandbox

Allowed:

notify_by_email

boolean

Specifies if email notifications should be sent

notify_by_phone

boolean

Specifies if phone notifications should be sent

plan_order_ref

string

required

The reference ID for the plan order

notes

array of objects

Additional Notes

additional_costs

array of objects

Additional Cost. Optional for REGULAR Subscription, not available for ONDEMAND Subscription

success_url

string

required

The URL to redirect to after a successful subscription

failure_url

string

required

The URL to redirect to after a failed subscription

pending_url

string

required

The URL to redirect to for a pending subscription

subscription_type

string

enum

required

The type of subscription

Allowed:

initial_amount

double

≥ 1

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

first_txn_auto_refund

boolean

Indicates whether the first transaction should be auto-refunded. Available only for ONDEMAND Subscription, not available for REGULAR Subscription

allow_accumulate

string

enum

Indicates whether accumulated payments are allowed. Possible values Y or N. Required only for REGULAR Subscription, not available for ONDEMAND Subscription

Allowed:

quantity

integer

≥ 1

The quantity of the item being subscribed. Required only for REGULAR Subscription, not available for ONDEMAND Subscription

recurrance_count

number

≥ 1

The number of times the subscription will recur. Required only for REGULAR Subscription, not available for ONDEMAND Subscription

started_at

string

The start date and time of the subscription. Send empty value to start immediately, not available for ONDEMAND Subscription

trial_frequency

integer

≥ 1

To have a trial set the trial frequency greater than 0. Use either start_date or trial_frequency and trial_period for REGULAR Subscription, not available for ONDEMAND Subscription

trial_period

string

enum

To have a trial set the trial period. Use either start_date or trial_frequency and trial_period for REGULAR Subscription, not available for ONDEMAND Subscription. Hour trial_period is only for testing purpose

Allowed:

expiry_date

string

The expire date and time of the subscription link

Headers

Content-Type

string

X-Portone-Client-Key

string

The PortOne Key of the merchant

Authorization

string

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

Responses

200Successful response

400Failure response