Update Subscription

Update Subscription

PATCH https://api.synapsefi.com/v3.1/subscriptions/subscription_id

This endpoint allows you to update a subscription.

Path Parameters

Name	Type	Description
subscription_id	string	Object ID of subscription

Headers

Name	Type	Description
Content-Type	string	This value should be application/json
X-SP-GATEWAY	string	Your Client ID & Secret, separated by a pipe

Request Body

Name	Type	Description
is_active	boolean	Active status

200 Subscription successfully updated.

{
  "_id": "589b6adec83e17002122196c",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/subscriptions/589b6adec83e17002122196c"
    }
  },
  "_v": 2,
  "client_id": "589acd9ecb3cd400fa75ac06",
  "is_active": false,
  "scope": [
    "USERS|POST",
    "USER|PATCH",
    "NODES|POST",
    "NODE|PATCH",
    "TRANS|POST",
    "TRAN|PATCH",
    "SUBNETS|POST",
    "SUBNET|PATCH"
  ],
  "url": "https://requestb.in/zp216zzp"
}

400 Subscription update was unsuccessful.

{
    "error": {
        "code": "unable_to_locate_subscription",
        "en": "Unable to locate subscription object with filter {'_id': ObjectId('60408ec663615152a3a6fc77')}"
    },
    "error_code": "404",
    "http_code": "404",
    "success": false
}Go to 
Subscription Object Details
 to see all the required and optional body parameters allowed when creating a subscription. 

Go to Subscription Object Details to see all the required and optional body parameters allowed when updating a subscription.

Example Request

HTTP

PATCH /v3.1/subscriptions/589b6adec83e17002122196c HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
Content-Type: application/json

{
  "is_active": false
}

Python

subs_id = '589b6adec83e17002122196c'
body = {
  'is_active': false
}

subs = client.update_subscription(subs_id, body)

JavaScript

const subscriptionID = '589b6adec83e17002122196c';
const body = {
  'is_active': false
};

client.updateSubscription(subscriptionID, body);

Ruby

subscription_id = "589b6adec83e17002122196c"
payload = {
  "is_active": false
}

client.update_subscription(subscription_id: subscription_id, body: payload)

PHP

$body= (object) [
     'scope' => $scope_arr,
     'is_active' => false,
     'url' => 'https://requestb.in/zp216zzp'
];
$subscriptionid = '589b6adec83e17002122196c';

$client->update_subscription( $subscriptionid, $body );

Go

subscriptionID := "589b6adec83e17002122196c"
body := `{
  "is_active": false
}`

data, err := client.update_subscription(subscriptionID, body)