v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Subscription APIs

Trigger Next Deduction

Use this API to trigger the next deduction for a regular subscription.

put/api/subscription/triggerNextDeduction

Headers

Content-Typestring

X-Portone-Client-Keystring

The PortOne Key of the merchant

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

portone_keystring required

The unique PortOne key for merchant

subscription_order_refstring required

The unique subscription order reference of the subscription link

environment'sandbox' | 'live' required

The environment of the transaction either live OR sandbox

Example request

{
  "portone_key": "gvFFggsdgGfrshuh",
  "subscription_order_ref": "2rIbzBBpNjUH681AmQilntIzz3b",
  "environment": "sandbox"
}

Response

Successful response

is_successboolean

The boolean flag denoting if the next deduction was successfully triggered

messagestring

The description of the API request execution result

status_codestring

The status_code for API request execution result

status_reasonstring

The status_reason for API request execution result