View Subscription

View Subscription

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

This endpoint allows you to view a specific subscription.

Path Parameters

Name	Type	Description
subscription_id	string	Object ID of subscription.

Headers

Name	Type	Description
X-SP-GATEWAY	string	Your Client ID & Secret, separated by a pipe.

200 Subscription successfully retrieved.

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

400 Could not find a subscription matching this subscription ID.

{}

Example Request

HTTP

GET /v3.1/subscriptions/589b6adec83e17002122196c HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267

Python

subs_id = '589b6adec83e17002122196c'

client.get_subscription(subs_id)

JavaScript

const subscriptionID = '589b6adec83e17002122196c';

client.getSubscription(subscriptionID);

Ruby

subscription_id = "589b6adec83e17002122196c"

client.get_subscription(subscription_id: subscription_id)

PHP

$subscriptionid = '589b6adec83e17002122196c';

$client->get_subscription($subscriptionid);

Go

subscriptionID := "589b6adec83e17002122196c"

data, err := client.GetSubscription(subscriptionID)