Create Ondemand Deduction

post

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

Use this API for Creating Ondemand Deduction.

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 ondemand deduction generated as per Ondemand Deduction Request Signature Documentation

merchant_order_ref

string

required

The unique merchant order reference generated by the merchant

subscription_order_ref

string

required

The unique subscription order reference of the subscription link

description

string

Product name for the customer's subscription purchase

source

string

enum

required

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

Allowed:

amount

double

required

The amount of deduction, can be a floating-point number

currency

string

required

The currency of the subscription

environment

string

enum

required

The environment of transacation either live OR sandbox

Allowed:

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Failure response