Subscriptions

Get all subscriptions

GEThttps://beta.data.banyan.computer/api/v1/subscriptions

Authorization

ApiIdentitySessionIdentity

Response

200500

List of all subscriptions

Body

application/json

id*string

currently_activenullable boolean

service_key*string

tax_class*string

title*string

features*ApiSubscriptionFeatures (object)

pricing*ApiSubscriptionPricing (object)

Request

JavaScriptCurlPython

const response = await fetch('https://beta.data.banyan.computer/api/v1/subscriptions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200500

[
  {
    "id": "text",
    "currently_active": false,
    "service_key": "text",
    "tax_class": "text",
    "title": "text",
    "features": {
      "archival_available": false,
      "included_hot_replica_count": 0,
      "included_hot_storage": 0,
      "included_bandwidth": 0,
      "archival_hard_limit": 0,
      "hot_storage_hard_limit": 0,
      "bandwidth_hard_limit": 0
    },
    "pricing": {
      "archival": 0,
      "hot_storage": 0,
      "plan_base": 0,
      "bandwidth": 0
    }
  }
]

Get a single subscription by ID

GEThttps://beta.data.banyan.computer/api/v1/subscriptions/{subscription_id}

Authorization

ApiIdentitySessionIdentity

Path parameters

subscription_id*string

Response

200404500

Subscription object

Body

application/json

id*string

currently_activenullable boolean

service_key*string

tax_class*string

title*string

features*ApiSubscriptionFeatures (object)

pricing*ApiSubscriptionPricing (object)

Request

JavaScriptCurlPython

const response = await fetch('https://beta.data.banyan.computer/api/v1/subscriptions/{subscription_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200500

{
  "id": "text",
  "currently_active": false,
  "service_key": "text",
  "tax_class": "text",
  "title": "text",
  "features": {
    "archival_available": false,
    "included_hot_replica_count": 0,
    "included_hot_storage": 0,
    "included_bandwidth": 0,
    "archival_hard_limit": 0,
    "hot_storage_hard_limit": 0,
    "bandwidth_hard_limit": 0
  },
  "pricing": {
    "archival": 0,
    "hot_storage": 0,
    "plan_base": 0,
    "bandwidth": 0
  }
}