Subscription

Unpause Subscription

This API is used to mark a PAUSED subscription to ACTIVE. This API updates the status of the subscription to ACTIVE. PAUSED, a subscription can be UNPAUSED to reinstate the billing. If the subscription is marked ACTIVE in the same billing cycle in which it was marked PAUSED it would not be considered PAUSED at all and the billing cycle will be considered to be used fully.

Partner cannot unpause a subscription if the subscription was in PAUSED state and the renewal date of the subscription has passed. Partner can create new subscription and the adjustment credits from the previous PAUSED subscription will be used automatically.

To test the pause flow, partner can use unpausedDate parameter in non-production environment. The value of unpausedDate is a future date at which the subscription will be considered to be unpaused. This will help to check the adjustment credits and other payment flow.

POST

subscription

v1.0

unpauseSubscription

Unpause Subscription

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/unpauseSubscription \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "subscriptionId": "<string>",
  "referenceId": "<string>"
}
'

import requests

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

payload = {
    "subscriptionId": "<string>",
    "referenceId": "<string>"
}
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({subscriptionId: '<string>', referenceId: '<string>'})
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/unpauseSubscription', 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/unpauseSubscription",
  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([
    'subscriptionId' => '<string>',
    'referenceId' => '<string>'
  ]),
  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/unpauseSubscription"

	payload := strings.NewReader("{\n  \"subscriptionId\": \"<string>\",\n  \"referenceId\": \"<string>\"\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/unpauseSubscription")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriptionId\": \"<string>\",\n  \"referenceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"subscriptionId\": \"<string>\",\n  \"referenceId\": \"<string>\"\n}"

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

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

Authorizations

x-api-key

string

header

required

Merchant API Key

x-signature

string

header

required

Generated request signature

Body

application/json

Option 1
Option 2

subscriptionId

string<MongoId>

required

Subscription Id of the subscription for which update is needed.

referenceId

string<referenceId>

Subscription referenceId that was passed during the creation of the subscription.

Response

200 - application/json

Unpause subscription.

status

string

The response from the API

sub_status

string

Used for internal purposes only

data

object

Contains the updated subscription details.

Unpause Subscription

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/unpauseSubscription \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "subscriptionId": "<string>",
  "referenceId": "<string>"
}
'

import requests

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

payload = {
    "subscriptionId": "<string>",
    "referenceId": "<string>"
}
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({subscriptionId: '<string>', referenceId: '<string>'})
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/unpauseSubscription', 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/unpauseSubscription",
  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([
    'subscriptionId' => '<string>',
    'referenceId' => '<string>'
  ]),
  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/unpauseSubscription"

	payload := strings.NewReader("{\n  \"subscriptionId\": \"<string>\",\n  \"referenceId\": \"<string>\"\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/unpauseSubscription")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriptionId\": \"<string>\",\n  \"referenceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"subscriptionId\": \"<string>\",\n  \"referenceId\": \"<string>\"\n}"

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

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

API Documentation

Session

Subscription

Mandate

Invoices

Transactions

Settlements

Customers

Products

Distribution

PACB

Others

Unpause Subscription

Authorizations

Body

Response