API Reference

Create Subscription

post
https://example.com/tnc/checkout/apis/v1/subscriptions

This API is used to create a subscription that defines a recurring billing agreement between the customer and the merchant before any recurring charges are initiated.

Transaction Idempotency

If appUtr and plan.name is present in the API request, then the Subscription transaction will be made idempotent. If another Subscription transaction is requested with the duplicate appUtr and plan.name, then the API will reject the subscription transaction.

HTTP Status and Response Status Matrix

HTTP
Status		Response StatusResponse Message
200SUCCESSSubscription created successfully.
400VALIDATION_ERRORRequest body validation failed.
400REJECTEDApp UTR provided is already used.
400ERROR_FROM_PGThis will be populated by PG.
500INTERNAL_PROCESSING_ERRORGateway account not found.
500ERROR_CONNECTING_PGGateway connectivity unavailable.
503ERROR_CONNECTING_PGGateway connectivity unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 250
^[A-Za-z0-9#_,/().&:\\-]+$

Description of the subscription.

date-time
yyyy-MM-dd HH:mm:ss

Subscription start date Provide DateTime in local timezone.

date-time
yyyy-MM-dd HH:mm:ss

Subscription End date. This must be before the Plan end date. Provide DateTime in local timezone.

plan
object
app
object
required
notes
object

Notes of the transaction. O – It will be provided back in response to the Check Transaction Status API and webhook.

string
required
length ≤ 18
^[0-9A-Za-z]+$

Order Id of the transaction. This will be forwarded to the PG if the underlying PG supports it. It may be present in the bank records/statements. NOTE: This is not considered for transaction idempotency

string
required
length ≤ 25

The payment modes allowed for the transaction.

customerDetails
object
required

Customer details including address. C – When provided it will be sent to PG if supported by PG. NOTE: Checkout is not storing any of the customer details.

Headers
string
string
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?