Create Subscriptions
curl --request POST \
--url https://api.paytring.com/api/v1/subscription/create \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"callback_url": "<string>",
"cname": "<string>",
"email": "<string>",
"phone": "<string>",
"plan_id": "<string>",
"mer_reference_id": "<string>",
"hash": "<string>",
"pg": "<string>",
"pg_pool_id": "<string>",
"initial_amount": "<string>",
"notes": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>",
"udf5": "<string>"
},
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"shipping_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
}
}
'import requests
url = "https://api.paytring.com/api/v1/subscription/create"
payload = {
"key": "<string>",
"callback_url": "<string>",
"cname": "<string>",
"email": "<string>",
"phone": "<string>",
"plan_id": "<string>",
"mer_reference_id": "<string>",
"hash": "<string>",
"pg": "<string>",
"pg_pool_id": "<string>",
"initial_amount": "<string>",
"notes": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>",
"udf5": "<string>"
},
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"shipping_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
callback_url: '<string>',
cname: '<string>',
email: '<string>',
phone: '<string>',
plan_id: '<string>',
mer_reference_id: '<string>',
hash: '<string>',
pg: '<string>',
pg_pool_id: '<string>',
initial_amount: '<string>',
notes: {
udf1: '<string>',
udf2: '<string>',
udf3: '<string>',
udf4: '<string>',
udf5: '<string>'
},
billing_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
zipcode: 123,
country: '<string>',
phone: '<string>',
firstname: '<string>',
lastname: '<string>'
},
shipping_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
zipcode: 123,
country: '<string>',
phone: '<string>',
firstname: '<string>',
lastname: '<string>'
}
})
};
fetch('https://api.paytring.com/api/v1/subscription/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paytring.com/api/v1/subscription/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'callback_url' => '<string>',
'cname' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'plan_id' => '<string>',
'mer_reference_id' => '<string>',
'hash' => '<string>',
'pg' => '<string>',
'pg_pool_id' => '<string>',
'initial_amount' => '<string>',
'notes' => [
'udf1' => '<string>',
'udf2' => '<string>',
'udf3' => '<string>',
'udf4' => '<string>',
'udf5' => '<string>'
],
'billing_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipcode' => 123,
'country' => '<string>',
'phone' => '<string>',
'firstname' => '<string>',
'lastname' => '<string>'
],
'shipping_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipcode' => 123,
'country' => '<string>',
'phone' => '<string>',
'firstname' => '<string>',
'lastname' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paytring.com/api/v1/subscription/create"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"cname\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"mer_reference_id\": \"<string>\",\n \"hash\": \"<string>\",\n \"pg\": \"<string>\",\n \"pg_pool_id\": \"<string>\",\n \"initial_amount\": \"<string>\",\n \"notes\": {\n \"udf1\": \"<string>\",\n \"udf2\": \"<string>\",\n \"udf3\": \"<string>\",\n \"udf4\": \"<string>\",\n \"udf5\": \"<string>\"\n },\n \"billing_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n },\n \"shipping_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paytring.com/api/v1/subscription/create")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"cname\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"mer_reference_id\": \"<string>\",\n \"hash\": \"<string>\",\n \"pg\": \"<string>\",\n \"pg_pool_id\": \"<string>\",\n \"initial_amount\": \"<string>\",\n \"notes\": {\n \"udf1\": \"<string>\",\n \"udf2\": \"<string>\",\n \"udf3\": \"<string>\",\n \"udf4\": \"<string>\",\n \"udf5\": \"<string>\"\n },\n \"billing_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n },\n \"shipping_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paytring.com/api/v1/subscription/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"cname\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"mer_reference_id\": \"<string>\",\n \"hash\": \"<string>\",\n \"pg\": \"<string>\",\n \"pg_pool_id\": \"<string>\",\n \"initial_amount\": \"<string>\",\n \"notes\": {\n \"udf1\": \"<string>\",\n \"udf2\": \"<string>\",\n \"udf3\": \"<string>\",\n \"udf4\": \"<string>\",\n \"udf5\": \"<string>\"\n },\n \"billing_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n },\n \"shipping_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body"{}""{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}"Subscription Management
Create Subscription
POST
/
api
/
v1
/
subscription
/
create
Create Subscriptions
curl --request POST \
--url https://api.paytring.com/api/v1/subscription/create \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"callback_url": "<string>",
"cname": "<string>",
"email": "<string>",
"phone": "<string>",
"plan_id": "<string>",
"mer_reference_id": "<string>",
"hash": "<string>",
"pg": "<string>",
"pg_pool_id": "<string>",
"initial_amount": "<string>",
"notes": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>",
"udf5": "<string>"
},
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"shipping_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
}
}
'import requests
url = "https://api.paytring.com/api/v1/subscription/create"
payload = {
"key": "<string>",
"callback_url": "<string>",
"cname": "<string>",
"email": "<string>",
"phone": "<string>",
"plan_id": "<string>",
"mer_reference_id": "<string>",
"hash": "<string>",
"pg": "<string>",
"pg_pool_id": "<string>",
"initial_amount": "<string>",
"notes": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>",
"udf5": "<string>"
},
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"shipping_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": 123,
"country": "<string>",
"phone": "<string>",
"firstname": "<string>",
"lastname": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
callback_url: '<string>',
cname: '<string>',
email: '<string>',
phone: '<string>',
plan_id: '<string>',
mer_reference_id: '<string>',
hash: '<string>',
pg: '<string>',
pg_pool_id: '<string>',
initial_amount: '<string>',
notes: {
udf1: '<string>',
udf2: '<string>',
udf3: '<string>',
udf4: '<string>',
udf5: '<string>'
},
billing_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
zipcode: 123,
country: '<string>',
phone: '<string>',
firstname: '<string>',
lastname: '<string>'
},
shipping_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
zipcode: 123,
country: '<string>',
phone: '<string>',
firstname: '<string>',
lastname: '<string>'
}
})
};
fetch('https://api.paytring.com/api/v1/subscription/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paytring.com/api/v1/subscription/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'callback_url' => '<string>',
'cname' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'plan_id' => '<string>',
'mer_reference_id' => '<string>',
'hash' => '<string>',
'pg' => '<string>',
'pg_pool_id' => '<string>',
'initial_amount' => '<string>',
'notes' => [
'udf1' => '<string>',
'udf2' => '<string>',
'udf3' => '<string>',
'udf4' => '<string>',
'udf5' => '<string>'
],
'billing_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipcode' => 123,
'country' => '<string>',
'phone' => '<string>',
'firstname' => '<string>',
'lastname' => '<string>'
],
'shipping_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipcode' => 123,
'country' => '<string>',
'phone' => '<string>',
'firstname' => '<string>',
'lastname' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paytring.com/api/v1/subscription/create"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"cname\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"mer_reference_id\": \"<string>\",\n \"hash\": \"<string>\",\n \"pg\": \"<string>\",\n \"pg_pool_id\": \"<string>\",\n \"initial_amount\": \"<string>\",\n \"notes\": {\n \"udf1\": \"<string>\",\n \"udf2\": \"<string>\",\n \"udf3\": \"<string>\",\n \"udf4\": \"<string>\",\n \"udf5\": \"<string>\"\n },\n \"billing_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n },\n \"shipping_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paytring.com/api/v1/subscription/create")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"cname\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"mer_reference_id\": \"<string>\",\n \"hash\": \"<string>\",\n \"pg\": \"<string>\",\n \"pg_pool_id\": \"<string>\",\n \"initial_amount\": \"<string>\",\n \"notes\": {\n \"udf1\": \"<string>\",\n \"udf2\": \"<string>\",\n \"udf3\": \"<string>\",\n \"udf4\": \"<string>\",\n \"udf5\": \"<string>\"\n },\n \"billing_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n },\n \"shipping_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paytring.com/api/v1/subscription/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"cname\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"mer_reference_id\": \"<string>\",\n \"hash\": \"<string>\",\n \"pg\": \"<string>\",\n \"pg_pool_id\": \"<string>\",\n \"initial_amount\": \"<string>\",\n \"notes\": {\n \"udf1\": \"<string>\",\n \"udf2\": \"<string>\",\n \"udf3\": \"<string>\",\n \"udf4\": \"<string>\",\n \"udf5\": \"<string>\"\n },\n \"billing_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n },\n \"shipping_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": 123,\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body"{}""{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}"This API is used to create a new subscription for a customer.
Request Body
{
"customer_id": "string", // ID of the customer
"plan_id": "string", // ID of the subscription plan
"start_date": "string", // Start date of the subscription
"hash": "string" // Calculated hash for request validation
}
Responses
200 OK
{
"status": true,
"subscription_id": "string",
"message": "Subscription created successfully"
}
400 Bad Request
{
"status": false,
"error": {
"message": "Invalid request",
"code": 400
}
}
Body
application/json
Merchant key, available in dashboard profile section
to be calculated by key sort of all non-object key values of this request
code for payment gateway, which you want to use
pool is from which you want to choose pg
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
200
The response is of type object.
⌘I