Skip to main content
POST
/
api
/
v1
/
subscription
/
plan
/
create
Create Plan
curl --request POST \
  --url https://api.paytring.com/api/v1/subscription/plan/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "amount": "<string>",
  "frequency": 123,
  "key": "<string>",
  "mer_reference_id": "<string>",
  "hash": "<string>",
  "cycle": 12,
  "currency": "<string>",
  "notes": {
    "udf1": "<string>",
    "udf2": "<string>",
    "udf3": "<string>",
    "udf4": "<string>",
    "udf5": "<string>"
  }
}
'
{}
This API is used to create a subscription plan.

​
Request Body

{
  "name": "string", // Name of the subscription plan
  "amount": "integer", // Amount in cents/paisa
  "currency": "string", // Currency code (e.g., USD, INR)
  "interval": "string", // Billing interval (e.g., monthly, yearly)
  "hash": "string" // Calculated hash for request validation
}

​
Responses

​
200 OK

{
  "status": true,
  "plan_id": "string",
  "message": "Plan created successfully"
}

​
400 Bad Request

{
  "status": false,
  "error": {
    "message": "Invalid request",
    "code": 400
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
title
string
required
​
description
string
required
​
amount
string
required
​
frequency
integer<int32>
required

no of days

​
key
string
required

Merchant key, available in dashboard profile section

​
mer_reference_id
string
required
​
hash
string
required

to be calculated by key sort of all non-object key values of this request

​
cycle
integer<int32>
default:12
required

how many times will we deduct this money.

​
currency
string
​
notes
object

Response

200

The response is of type object.