Subscription

Add Subscription

This API is used to create a unique payment link for a subscription, that can be shared with a customer. Once the user pays the requested amount through the selected payment channel, the partner gets a webhook call for a successful credit and subscription.

At the start, the subscription is in PENDING state, which means the customer can pay to activate the subscription. If the customer fails to make payment before the date derived from pendingExpire then the subscription is moved into PENDING_EXPIRED which is a terminal state after which no payment can be made on the same subscription.

POST

subscription

v1.0

addSubscription

Add Subscription

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "customerId": "67a1b2c3d4e5f67890123456",
  "email": "customer@example.com",
  "clientReferenceId": "CUST-REF-10001",
  "phoneNo": "+91-9876543210",
  "taxIdentity": "ABCDE1234F",
  "gstIdentity": "27ABCDE1234F1Z5",
  "name": "John Doe",
  "quoteCurrCode": "INR",
  "maxQuoteAmount": "15000",
  "returnUrl": "https://example.com/payment/return",
  "referenceId": "SUB-2026-00001",
  "userTaxId": "GST-18-PERCENT",
  "payMethod": [
    "UPI",
    "CC"
  ],
  "redirectionType": "NEW_PAGE",
  "frequency": "MNTH",
  "description": "Monthly Premium Subscription",
  "collectionMechanism": "AUTOPAY",
  "billAtStart": true,
  "pendingExpire": "30",
  "maxUnpaidInvoices": "2",
  "postMaxUnpaidInvoices": "PAUSED",
  "dayUntillDue": "1",
  "billingDateAnchor": "2",
  "maxUnpausedInvoiceDueCount": {
    "count": 2
  },
  "reAttemptConfig": [
    {
      "attemptType": "try_again",
      "attemptCount": 3
    }
  ],
  "shipTo": {
    "name": "John Doe",
    "addressLine1": "123 Main Street",
    "city": "Mumbai",
    "state": "Maharashtra",
    "postalCode": "400001",
    "country": "IN"
  },
  "billTo": {
    "name": "John Doe",
    "addressLine1": "123 Main Street",
    "city": "Mumbai",
    "state": "Maharashtra",
    "postalCode": "400001",
    "country": "IN"
  },
  "sameAsBilling": true,
  "items": [
    {
      "name": "Premium Plan",
      "quantity": 1,
      "unitPrice": 2000
    }
  ],
  "meta": {
    "orderId": "ORDER-10001",
    "source": "website"
  },
  "dropIn": {
    "enabled": true
  }
}
'

import requests

url = "https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription"

payload = {
    "customerId": "67a1b2c3d4e5f67890123456",
    "email": "customer@example.com",
    "clientReferenceId": "CUST-REF-10001",
    "phoneNo": "+91-9876543210",
    "taxIdentity": "ABCDE1234F",
    "gstIdentity": "27ABCDE1234F1Z5",
    "name": "John Doe",
    "quoteCurrCode": "INR",
    "maxQuoteAmount": "15000",
    "returnUrl": "https://example.com/payment/return",
    "referenceId": "SUB-2026-00001",
    "userTaxId": "GST-18-PERCENT",
    "payMethod": ["UPI", "CC"],
    "redirectionType": "NEW_PAGE",
    "frequency": "MNTH",
    "description": "Monthly Premium Subscription",
    "collectionMechanism": "AUTOPAY",
    "billAtStart": True,
    "pendingExpire": "30",
    "maxUnpaidInvoices": "2",
    "postMaxUnpaidInvoices": "PAUSED",
    "dayUntillDue": "1",
    "billingDateAnchor": "2",
    "maxUnpausedInvoiceDueCount": { "count": 2 },
    "reAttemptConfig": [
        {
            "attemptType": "try_again",
            "attemptCount": 3
        }
    ],
    "shipTo": {
        "name": "John Doe",
        "addressLine1": "123 Main Street",
        "city": "Mumbai",
        "state": "Maharashtra",
        "postalCode": "400001",
        "country": "IN"
    },
    "billTo": {
        "name": "John Doe",
        "addressLine1": "123 Main Street",
        "city": "Mumbai",
        "state": "Maharashtra",
        "postalCode": "400001",
        "country": "IN"
    },
    "sameAsBilling": True,
    "items": [
        {
            "name": "Premium Plan",
            "quantity": 1,
            "unitPrice": 2000
        }
    ],
    "meta": {
        "orderId": "ORDER-10001",
        "source": "website"
    },
    "dropIn": { "enabled": True }
}
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: '67a1b2c3d4e5f67890123456',
    email: 'customer@example.com',
    clientReferenceId: 'CUST-REF-10001',
    phoneNo: '+91-9876543210',
    taxIdentity: 'ABCDE1234F',
    gstIdentity: '27ABCDE1234F1Z5',
    name: 'John Doe',
    quoteCurrCode: 'INR',
    maxQuoteAmount: '15000',
    returnUrl: 'https://example.com/payment/return',
    referenceId: 'SUB-2026-00001',
    userTaxId: 'GST-18-PERCENT',
    payMethod: ['UPI', 'CC'],
    redirectionType: 'NEW_PAGE',
    frequency: 'MNTH',
    description: 'Monthly Premium Subscription',
    collectionMechanism: 'AUTOPAY',
    billAtStart: true,
    pendingExpire: '30',
    maxUnpaidInvoices: '2',
    postMaxUnpaidInvoices: 'PAUSED',
    dayUntillDue: '1',
    billingDateAnchor: '2',
    maxUnpausedInvoiceDueCount: {count: 2},
    reAttemptConfig: [{attemptType: 'try_again', attemptCount: 3}],
    shipTo: {
      name: 'John Doe',
      addressLine1: '123 Main Street',
      city: 'Mumbai',
      state: 'Maharashtra',
      postalCode: '400001',
      country: 'IN'
    },
    billTo: {
      name: 'John Doe',
      addressLine1: '123 Main Street',
      city: 'Mumbai',
      state: 'Maharashtra',
      postalCode: '400001',
      country: 'IN'
    },
    sameAsBilling: true,
    items: [{name: 'Premium Plan', quantity: 1, unitPrice: 2000}],
    meta: {orderId: 'ORDER-10001', source: 'website'},
    dropIn: {enabled: true}
  })
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription', 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://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription",
  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([
    'customerId' => '67a1b2c3d4e5f67890123456',
    'email' => 'customer@example.com',
    'clientReferenceId' => 'CUST-REF-10001',
    'phoneNo' => '+91-9876543210',
    'taxIdentity' => 'ABCDE1234F',
    'gstIdentity' => '27ABCDE1234F1Z5',
    'name' => 'John Doe',
    'quoteCurrCode' => 'INR',
    'maxQuoteAmount' => '15000',
    'returnUrl' => 'https://example.com/payment/return',
    'referenceId' => 'SUB-2026-00001',
    'userTaxId' => 'GST-18-PERCENT',
    'payMethod' => [
        'UPI',
        'CC'
    ],
    'redirectionType' => 'NEW_PAGE',
    'frequency' => 'MNTH',
    'description' => 'Monthly Premium Subscription',
    'collectionMechanism' => 'AUTOPAY',
    'billAtStart' => true,
    'pendingExpire' => '30',
    'maxUnpaidInvoices' => '2',
    'postMaxUnpaidInvoices' => 'PAUSED',
    'dayUntillDue' => '1',
    'billingDateAnchor' => '2',
    'maxUnpausedInvoiceDueCount' => [
        'count' => 2
    ],
    'reAttemptConfig' => [
        [
                'attemptType' => 'try_again',
                'attemptCount' => 3
        ]
    ],
    'shipTo' => [
        'name' => 'John Doe',
        'addressLine1' => '123 Main Street',
        'city' => 'Mumbai',
        'state' => 'Maharashtra',
        'postalCode' => '400001',
        'country' => 'IN'
    ],
    'billTo' => [
        'name' => 'John Doe',
        'addressLine1' => '123 Main Street',
        'city' => 'Mumbai',
        'state' => 'Maharashtra',
        'postalCode' => '400001',
        'country' => 'IN'
    ],
    'sameAsBilling' => true,
    'items' => [
        [
                'name' => 'Premium Plan',
                'quantity' => 1,
                'unitPrice' => 2000
        ]
    ],
    'meta' => [
        'orderId' => 'ORDER-10001',
        'source' => 'website'
    ],
    'dropIn' => [
        'enabled' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <api-key>"
  ],
]);

$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://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription"

	payload := strings.NewReader("{\n  \"customerId\": \"67a1b2c3d4e5f67890123456\",\n  \"email\": \"customer@example.com\",\n  \"clientReferenceId\": \"CUST-REF-10001\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"ABCDE1234F\",\n  \"gstIdentity\": \"27ABCDE1234F1Z5\",\n  \"name\": \"John Doe\",\n  \"quoteCurrCode\": \"INR\",\n  \"maxQuoteAmount\": \"15000\",\n  \"returnUrl\": \"https://example.com/payment/return\",\n  \"referenceId\": \"SUB-2026-00001\",\n  \"userTaxId\": \"GST-18-PERCENT\",\n  \"payMethod\": [\n    \"UPI\",\n    \"CC\"\n  ],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"frequency\": \"MNTH\",\n  \"description\": \"Monthly Premium Subscription\",\n  \"collectionMechanism\": \"AUTOPAY\",\n  \"billAtStart\": true,\n  \"pendingExpire\": \"30\",\n  \"maxUnpaidInvoices\": \"2\",\n  \"postMaxUnpaidInvoices\": \"PAUSED\",\n  \"dayUntillDue\": \"1\",\n  \"billingDateAnchor\": \"2\",\n  \"maxUnpausedInvoiceDueCount\": {\n    \"count\": 2\n  },\n  \"reAttemptConfig\": [\n    {\n      \"attemptType\": \"try_again\",\n      \"attemptCount\": 3\n    }\n  ],\n  \"shipTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"billTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"sameAsBilling\": true,\n  \"items\": [\n    {\n      \"name\": \"Premium Plan\",\n      \"quantity\": 1,\n      \"unitPrice\": 2000\n    }\n  ],\n  \"meta\": {\n    \"orderId\": \"ORDER-10001\",\n    \"source\": \"website\"\n  },\n  \"dropIn\": {\n    \"enabled\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<api-key>")
	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://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"67a1b2c3d4e5f67890123456\",\n  \"email\": \"customer@example.com\",\n  \"clientReferenceId\": \"CUST-REF-10001\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"ABCDE1234F\",\n  \"gstIdentity\": \"27ABCDE1234F1Z5\",\n  \"name\": \"John Doe\",\n  \"quoteCurrCode\": \"INR\",\n  \"maxQuoteAmount\": \"15000\",\n  \"returnUrl\": \"https://example.com/payment/return\",\n  \"referenceId\": \"SUB-2026-00001\",\n  \"userTaxId\": \"GST-18-PERCENT\",\n  \"payMethod\": [\n    \"UPI\",\n    \"CC\"\n  ],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"frequency\": \"MNTH\",\n  \"description\": \"Monthly Premium Subscription\",\n  \"collectionMechanism\": \"AUTOPAY\",\n  \"billAtStart\": true,\n  \"pendingExpire\": \"30\",\n  \"maxUnpaidInvoices\": \"2\",\n  \"postMaxUnpaidInvoices\": \"PAUSED\",\n  \"dayUntillDue\": \"1\",\n  \"billingDateAnchor\": \"2\",\n  \"maxUnpausedInvoiceDueCount\": {\n    \"count\": 2\n  },\n  \"reAttemptConfig\": [\n    {\n      \"attemptType\": \"try_again\",\n      \"attemptCount\": 3\n    }\n  ],\n  \"shipTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"billTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"sameAsBilling\": true,\n  \"items\": [\n    {\n      \"name\": \"Premium Plan\",\n      \"quantity\": 1,\n      \"unitPrice\": 2000\n    }\n  ],\n  \"meta\": {\n    \"orderId\": \"ORDER-10001\",\n    \"source\": \"website\"\n  },\n  \"dropIn\": {\n    \"enabled\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"67a1b2c3d4e5f67890123456\",\n  \"email\": \"customer@example.com\",\n  \"clientReferenceId\": \"CUST-REF-10001\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"ABCDE1234F\",\n  \"gstIdentity\": \"27ABCDE1234F1Z5\",\n  \"name\": \"John Doe\",\n  \"quoteCurrCode\": \"INR\",\n  \"maxQuoteAmount\": \"15000\",\n  \"returnUrl\": \"https://example.com/payment/return\",\n  \"referenceId\": \"SUB-2026-00001\",\n  \"userTaxId\": \"GST-18-PERCENT\",\n  \"payMethod\": [\n    \"UPI\",\n    \"CC\"\n  ],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"frequency\": \"MNTH\",\n  \"description\": \"Monthly Premium Subscription\",\n  \"collectionMechanism\": \"AUTOPAY\",\n  \"billAtStart\": true,\n  \"pendingExpire\": \"30\",\n  \"maxUnpaidInvoices\": \"2\",\n  \"postMaxUnpaidInvoices\": \"PAUSED\",\n  \"dayUntillDue\": \"1\",\n  \"billingDateAnchor\": \"2\",\n  \"maxUnpausedInvoiceDueCount\": {\n    \"count\": 2\n  },\n  \"reAttemptConfig\": [\n    {\n      \"attemptType\": \"try_again\",\n      \"attemptCount\": 3\n    }\n  ],\n  \"shipTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"billTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"sameAsBilling\": true,\n  \"items\": [\n    {\n      \"name\": \"Premium Plan\",\n      \"quantity\": 1,\n      \"unitPrice\": 2000\n    }\n  ],\n  \"meta\": {\n    \"orderId\": \"ORDER-10001\",\n    \"source\": \"website\"\n  },\n  \"dropIn\": {\n    \"enabled\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {
    "subscriptionId": "<string>",
    "url": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Merchant API Key

x-signature

string

header

required

Generated request signature

Body

application/json

quoteCurrCode

enum<string>

required

Fiat currency for which request needs to be initiated.

Available options:

USD,

EURO,

INR

maxQuoteAmount

string

required

This is the amount in the same denomination as quoteCurrCode. This is the maximum value for which we can use the mandate for auto debit the amount. This amount will be inclusive of GST/VAT. Please configure it accordingly. Note: UPI has a maximum limit of ₹15,000 per mandate. Cards have a limit of ₹500,000 per mandate.

returnUrl

string

required

This URL is needed to redirect the user after the session is completed.This url will be a redirection with status, subscriptionId, and referenceId values passed in the query parameters.

frequency

enum<string>

required

Frequency of the subscription renewal period.

Available options:

DAIL,

WEEK,

MNTH,

BIMN,

QURT,

MIAN,

YEAR,

ONDM

billTo

object

required

Billing Details of the customer

Show child attributes

items

object[]

required

Items the customer wants to buy.

Show child attributes

customerId

string<MongoId>

If the customer is already created use customerId and then email is optional parameter.

string

Customer's email. Require this to send an invoice. This parameter is mandatory if clientReferenceId is not passed.

clientReferenceId

string

Customer's reference id that the partner can pass to map it to the customer on Transact Bridge panel. If email is not passed in the request body, the customer must enter the email on the product checkout page. This parameter is mandatory if email is not passed.

phoneNo

string

The customer's Indian phone number in the format of +91-XXXXXXXX

Example:

"+91-9876543210"

taxIdentity

string

PAN number of the customer

gstIdentity

string

If the customer is business type then GST can be used so that the business can get input credits.

name

string

Name of the customer

referenceId

string<referenceId>

This is a partner-generated ID to map a subscription. Partners can use this to query the subscriptions as well. This cannot be the same for two subscriptions. Reference ID that was passed by the partner during the generation of the session.

Maximum string length: 128

userTaxId

string

We will create a userTaxId for the partner. This allows us to tax the product correctly. For example: Partners can have two different userTaxId one for 18% GST and the other for 5% GST.

payMethod

enum<string>[]

If payMethod parameter is sent by the partner then on the payment page for the customer only that payment method will be visible to user.

Available options:

UPI,

NB,

CC,

DC

redirectionType

enum<string>

default:SAME_PAGE

Depending on the redirection type value, the user will either be redirected to a new page for payment or to the same window of the product page. Default value is NEW_PAGE.

Available options:

SAME_PAGE,

NEW_PAGE

description

string

To set the subscription view

collectionMechanism

enum<string>

Only AUTOPAY is allowed right now.

Available options:

AUTOPAY

billAtStart

boolean

default:true

If this is true, then the subscription is prepaid based subscription and allows to deduction of money before providing the product to the end customer and generating the invoice at the start of the subscription period. If this is false then it is a postpaid subscription which creates an invoice at the end of the subscription period.

couponDetails

object

To pass the coupon object and apply different coupons on the subscription.

Show child attributes

pendingExpire

string

Number of minutes after which the status of the subscription if PENDING (Customer did not pay) it becomes PENDING_EXPIRED which is a terminal state and now customers cannot pay on the same subscription.

maxUnpaidInvoices

string

default:0

Max unpaid invoices allowed for the subscription. For example, if maxUnpaidInvoices is set to 2 then after 2 unpaid invoices the subscription status will be converted from ACTIVE to the status based on postMaxUnpaidInvoices.

postMaxUnpaidInvoices

enum<string>

default:PAUSED

Subscription status after maxUnpaidInvoices threshold is crossed by the customer. Default Value: PAUSED

Available options:

PENDING,

PENDING_EXPIRED,

PAUSED,

EXPIRED,

CANCELLED

dayUntillDue

string

default:1

Period of time from the issue date after which DUE invoice is converted into OVERDUE status

billingDateAnchor

string

It allows the partner to configure the billing cycle from a fixed date. If not passed then the subscription period will start from the day the customer pays for it. For Example: if the frequency is MNTH (monthly) and billingDateAnchor is set to 2, this means that the invoice will be created on every 2nd day of each month.

trialSettings

object

Configuration of the trial mechanism

Show child attributes

maxUnpausedInvoiceDueCount

object

Maximum number of unpaid invoices count allowed after that the subscription is PAUSED by the system. For example, if a subscription has been paused due to 3 non payment of invoices and this parameter is set to be 2 then once the customer pays 1 invoice the subscription will be re activated.

reAttemptConfig

object[]

To configure how the reattempt for failed invoices be processed.

Show child attributes

shipTo

object

Shipping Details of the Customer

Show child attributes

sameAsBilling

boolean

To make the shipping address the same as the billing address. If sameAsBilling parameter value is set as true then shipTo is not mandatory, and the invoice will have the same shipping and billing address.

Response

200 - application/json

Payment session created successfully.

status

string

The response from the API

sub_status

string

Used for internal purposes only

data

object

Contains the subscription ID and URL

Show child attributes

Add Subscription

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "customerId": "67a1b2c3d4e5f67890123456",
  "email": "customer@example.com",
  "clientReferenceId": "CUST-REF-10001",
  "phoneNo": "+91-9876543210",
  "taxIdentity": "ABCDE1234F",
  "gstIdentity": "27ABCDE1234F1Z5",
  "name": "John Doe",
  "quoteCurrCode": "INR",
  "maxQuoteAmount": "15000",
  "returnUrl": "https://example.com/payment/return",
  "referenceId": "SUB-2026-00001",
  "userTaxId": "GST-18-PERCENT",
  "payMethod": [
    "UPI",
    "CC"
  ],
  "redirectionType": "NEW_PAGE",
  "frequency": "MNTH",
  "description": "Monthly Premium Subscription",
  "collectionMechanism": "AUTOPAY",
  "billAtStart": true,
  "pendingExpire": "30",
  "maxUnpaidInvoices": "2",
  "postMaxUnpaidInvoices": "PAUSED",
  "dayUntillDue": "1",
  "billingDateAnchor": "2",
  "maxUnpausedInvoiceDueCount": {
    "count": 2
  },
  "reAttemptConfig": [
    {
      "attemptType": "try_again",
      "attemptCount": 3
    }
  ],
  "shipTo": {
    "name": "John Doe",
    "addressLine1": "123 Main Street",
    "city": "Mumbai",
    "state": "Maharashtra",
    "postalCode": "400001",
    "country": "IN"
  },
  "billTo": {
    "name": "John Doe",
    "addressLine1": "123 Main Street",
    "city": "Mumbai",
    "state": "Maharashtra",
    "postalCode": "400001",
    "country": "IN"
  },
  "sameAsBilling": true,
  "items": [
    {
      "name": "Premium Plan",
      "quantity": 1,
      "unitPrice": 2000
    }
  ],
  "meta": {
    "orderId": "ORDER-10001",
    "source": "website"
  },
  "dropIn": {
    "enabled": true
  }
}
'

import requests

url = "https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription"

payload = {
    "customerId": "67a1b2c3d4e5f67890123456",
    "email": "customer@example.com",
    "clientReferenceId": "CUST-REF-10001",
    "phoneNo": "+91-9876543210",
    "taxIdentity": "ABCDE1234F",
    "gstIdentity": "27ABCDE1234F1Z5",
    "name": "John Doe",
    "quoteCurrCode": "INR",
    "maxQuoteAmount": "15000",
    "returnUrl": "https://example.com/payment/return",
    "referenceId": "SUB-2026-00001",
    "userTaxId": "GST-18-PERCENT",
    "payMethod": ["UPI", "CC"],
    "redirectionType": "NEW_PAGE",
    "frequency": "MNTH",
    "description": "Monthly Premium Subscription",
    "collectionMechanism": "AUTOPAY",
    "billAtStart": True,
    "pendingExpire": "30",
    "maxUnpaidInvoices": "2",
    "postMaxUnpaidInvoices": "PAUSED",
    "dayUntillDue": "1",
    "billingDateAnchor": "2",
    "maxUnpausedInvoiceDueCount": { "count": 2 },
    "reAttemptConfig": [
        {
            "attemptType": "try_again",
            "attemptCount": 3
        }
    ],
    "shipTo": {
        "name": "John Doe",
        "addressLine1": "123 Main Street",
        "city": "Mumbai",
        "state": "Maharashtra",
        "postalCode": "400001",
        "country": "IN"
    },
    "billTo": {
        "name": "John Doe",
        "addressLine1": "123 Main Street",
        "city": "Mumbai",
        "state": "Maharashtra",
        "postalCode": "400001",
        "country": "IN"
    },
    "sameAsBilling": True,
    "items": [
        {
            "name": "Premium Plan",
            "quantity": 1,
            "unitPrice": 2000
        }
    ],
    "meta": {
        "orderId": "ORDER-10001",
        "source": "website"
    },
    "dropIn": { "enabled": True }
}
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: '67a1b2c3d4e5f67890123456',
    email: 'customer@example.com',
    clientReferenceId: 'CUST-REF-10001',
    phoneNo: '+91-9876543210',
    taxIdentity: 'ABCDE1234F',
    gstIdentity: '27ABCDE1234F1Z5',
    name: 'John Doe',
    quoteCurrCode: 'INR',
    maxQuoteAmount: '15000',
    returnUrl: 'https://example.com/payment/return',
    referenceId: 'SUB-2026-00001',
    userTaxId: 'GST-18-PERCENT',
    payMethod: ['UPI', 'CC'],
    redirectionType: 'NEW_PAGE',
    frequency: 'MNTH',
    description: 'Monthly Premium Subscription',
    collectionMechanism: 'AUTOPAY',
    billAtStart: true,
    pendingExpire: '30',
    maxUnpaidInvoices: '2',
    postMaxUnpaidInvoices: 'PAUSED',
    dayUntillDue: '1',
    billingDateAnchor: '2',
    maxUnpausedInvoiceDueCount: {count: 2},
    reAttemptConfig: [{attemptType: 'try_again', attemptCount: 3}],
    shipTo: {
      name: 'John Doe',
      addressLine1: '123 Main Street',
      city: 'Mumbai',
      state: 'Maharashtra',
      postalCode: '400001',
      country: 'IN'
    },
    billTo: {
      name: 'John Doe',
      addressLine1: '123 Main Street',
      city: 'Mumbai',
      state: 'Maharashtra',
      postalCode: '400001',
      country: 'IN'
    },
    sameAsBilling: true,
    items: [{name: 'Premium Plan', quantity: 1, unitPrice: 2000}],
    meta: {orderId: 'ORDER-10001', source: 'website'},
    dropIn: {enabled: true}
  })
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription', 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://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription",
  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([
    'customerId' => '67a1b2c3d4e5f67890123456',
    'email' => 'customer@example.com',
    'clientReferenceId' => 'CUST-REF-10001',
    'phoneNo' => '+91-9876543210',
    'taxIdentity' => 'ABCDE1234F',
    'gstIdentity' => '27ABCDE1234F1Z5',
    'name' => 'John Doe',
    'quoteCurrCode' => 'INR',
    'maxQuoteAmount' => '15000',
    'returnUrl' => 'https://example.com/payment/return',
    'referenceId' => 'SUB-2026-00001',
    'userTaxId' => 'GST-18-PERCENT',
    'payMethod' => [
        'UPI',
        'CC'
    ],
    'redirectionType' => 'NEW_PAGE',
    'frequency' => 'MNTH',
    'description' => 'Monthly Premium Subscription',
    'collectionMechanism' => 'AUTOPAY',
    'billAtStart' => true,
    'pendingExpire' => '30',
    'maxUnpaidInvoices' => '2',
    'postMaxUnpaidInvoices' => 'PAUSED',
    'dayUntillDue' => '1',
    'billingDateAnchor' => '2',
    'maxUnpausedInvoiceDueCount' => [
        'count' => 2
    ],
    'reAttemptConfig' => [
        [
                'attemptType' => 'try_again',
                'attemptCount' => 3
        ]
    ],
    'shipTo' => [
        'name' => 'John Doe',
        'addressLine1' => '123 Main Street',
        'city' => 'Mumbai',
        'state' => 'Maharashtra',
        'postalCode' => '400001',
        'country' => 'IN'
    ],
    'billTo' => [
        'name' => 'John Doe',
        'addressLine1' => '123 Main Street',
        'city' => 'Mumbai',
        'state' => 'Maharashtra',
        'postalCode' => '400001',
        'country' => 'IN'
    ],
    'sameAsBilling' => true,
    'items' => [
        [
                'name' => 'Premium Plan',
                'quantity' => 1,
                'unitPrice' => 2000
        ]
    ],
    'meta' => [
        'orderId' => 'ORDER-10001',
        'source' => 'website'
    ],
    'dropIn' => [
        'enabled' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <api-key>"
  ],
]);

$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://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription"

	payload := strings.NewReader("{\n  \"customerId\": \"67a1b2c3d4e5f67890123456\",\n  \"email\": \"customer@example.com\",\n  \"clientReferenceId\": \"CUST-REF-10001\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"ABCDE1234F\",\n  \"gstIdentity\": \"27ABCDE1234F1Z5\",\n  \"name\": \"John Doe\",\n  \"quoteCurrCode\": \"INR\",\n  \"maxQuoteAmount\": \"15000\",\n  \"returnUrl\": \"https://example.com/payment/return\",\n  \"referenceId\": \"SUB-2026-00001\",\n  \"userTaxId\": \"GST-18-PERCENT\",\n  \"payMethod\": [\n    \"UPI\",\n    \"CC\"\n  ],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"frequency\": \"MNTH\",\n  \"description\": \"Monthly Premium Subscription\",\n  \"collectionMechanism\": \"AUTOPAY\",\n  \"billAtStart\": true,\n  \"pendingExpire\": \"30\",\n  \"maxUnpaidInvoices\": \"2\",\n  \"postMaxUnpaidInvoices\": \"PAUSED\",\n  \"dayUntillDue\": \"1\",\n  \"billingDateAnchor\": \"2\",\n  \"maxUnpausedInvoiceDueCount\": {\n    \"count\": 2\n  },\n  \"reAttemptConfig\": [\n    {\n      \"attemptType\": \"try_again\",\n      \"attemptCount\": 3\n    }\n  ],\n  \"shipTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"billTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"sameAsBilling\": true,\n  \"items\": [\n    {\n      \"name\": \"Premium Plan\",\n      \"quantity\": 1,\n      \"unitPrice\": 2000\n    }\n  ],\n  \"meta\": {\n    \"orderId\": \"ORDER-10001\",\n    \"source\": \"website\"\n  },\n  \"dropIn\": {\n    \"enabled\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<api-key>")
	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://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"67a1b2c3d4e5f67890123456\",\n  \"email\": \"customer@example.com\",\n  \"clientReferenceId\": \"CUST-REF-10001\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"ABCDE1234F\",\n  \"gstIdentity\": \"27ABCDE1234F1Z5\",\n  \"name\": \"John Doe\",\n  \"quoteCurrCode\": \"INR\",\n  \"maxQuoteAmount\": \"15000\",\n  \"returnUrl\": \"https://example.com/payment/return\",\n  \"referenceId\": \"SUB-2026-00001\",\n  \"userTaxId\": \"GST-18-PERCENT\",\n  \"payMethod\": [\n    \"UPI\",\n    \"CC\"\n  ],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"frequency\": \"MNTH\",\n  \"description\": \"Monthly Premium Subscription\",\n  \"collectionMechanism\": \"AUTOPAY\",\n  \"billAtStart\": true,\n  \"pendingExpire\": \"30\",\n  \"maxUnpaidInvoices\": \"2\",\n  \"postMaxUnpaidInvoices\": \"PAUSED\",\n  \"dayUntillDue\": \"1\",\n  \"billingDateAnchor\": \"2\",\n  \"maxUnpausedInvoiceDueCount\": {\n    \"count\": 2\n  },\n  \"reAttemptConfig\": [\n    {\n      \"attemptType\": \"try_again\",\n      \"attemptCount\": 3\n    }\n  ],\n  \"shipTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"billTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"sameAsBilling\": true,\n  \"items\": [\n    {\n      \"name\": \"Premium Plan\",\n      \"quantity\": 1,\n      \"unitPrice\": 2000\n    }\n  ],\n  \"meta\": {\n    \"orderId\": \"ORDER-10001\",\n    \"source\": \"website\"\n  },\n  \"dropIn\": {\n    \"enabled\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/subscription/v1.0/addSubscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"67a1b2c3d4e5f67890123456\",\n  \"email\": \"customer@example.com\",\n  \"clientReferenceId\": \"CUST-REF-10001\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"ABCDE1234F\",\n  \"gstIdentity\": \"27ABCDE1234F1Z5\",\n  \"name\": \"John Doe\",\n  \"quoteCurrCode\": \"INR\",\n  \"maxQuoteAmount\": \"15000\",\n  \"returnUrl\": \"https://example.com/payment/return\",\n  \"referenceId\": \"SUB-2026-00001\",\n  \"userTaxId\": \"GST-18-PERCENT\",\n  \"payMethod\": [\n    \"UPI\",\n    \"CC\"\n  ],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"frequency\": \"MNTH\",\n  \"description\": \"Monthly Premium Subscription\",\n  \"collectionMechanism\": \"AUTOPAY\",\n  \"billAtStart\": true,\n  \"pendingExpire\": \"30\",\n  \"maxUnpaidInvoices\": \"2\",\n  \"postMaxUnpaidInvoices\": \"PAUSED\",\n  \"dayUntillDue\": \"1\",\n  \"billingDateAnchor\": \"2\",\n  \"maxUnpausedInvoiceDueCount\": {\n    \"count\": 2\n  },\n  \"reAttemptConfig\": [\n    {\n      \"attemptType\": \"try_again\",\n      \"attemptCount\": 3\n    }\n  ],\n  \"shipTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"billTo\": {\n    \"name\": \"John Doe\",\n    \"addressLine1\": \"123 Main Street\",\n    \"city\": \"Mumbai\",\n    \"state\": \"Maharashtra\",\n    \"postalCode\": \"400001\",\n    \"country\": \"IN\"\n  },\n  \"sameAsBilling\": true,\n  \"items\": [\n    {\n      \"name\": \"Premium Plan\",\n      \"quantity\": 1,\n      \"unitPrice\": 2000\n    }\n  ],\n  \"meta\": {\n    \"orderId\": \"ORDER-10001\",\n    \"source\": \"website\"\n  },\n  \"dropIn\": {\n    \"enabled\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {
    "subscriptionId": "<string>",
    "url": "<string>"
  }
}

API Documentation

Session

Subscription

Mandate

Invoices

Transactions

Settlements

Customers

Products

Distribution

PACB

Others

Add Subscription

Authorizations

Body

Response