GET: Expired Subscriptions – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/subscriptions/expired

Get your company subscriptions that have expired and then prioritize which companies to resubscribe to.

See subscription modification user permissions.

Parameters

See query parameters for details on the following parameters:

limit (Default: ↻ 100)
offset
q – Company names.
sort

Parameter Values

include_active_subscriptions

[Query] Filter by resubscribed companies.

[Boolean]

true = Include resubscribed companies.
false = Exclude resubscribed companies.

Example Request

curl https://api.bitsighttech.com/ratings/v1/subscriptions/expired -u api_token:

Example Response

{
  "links":{
    "previous":null,
    "next":"https://api.bitsighttech.com/ratings/v1/subscriptions/expired?limit=100&offset=100"
  },
  "count":1,
  "results":[
    {
      "guid":"0cc0089f-ad69-4d54-be09-7546c6c5c0fe",
      "industry":"Legal",
      "logo":"https://api.bitsighttech.com/ratings/v1/companies/0cc0089f-ad69-4d54-be09-7546c6c5c0fe/logo-image",
      "name":"Example Corporation",
      "subscription_type":"Vendor Selection",
      "subscription_type_key":"vendor-selection",
      "type":"CURATED",
      "last_seen_rating":790,
      "date_expired":"2019-02-22",
      "has_current_active_subscription":false,
      "rating_change":"MAJOR"
    }
  ]
 }

Response Attributes

Field		Description
links Object		Navigation for multiple pages of expired subscriptions results. See pagination.
	previous String	Go to the previous page of the expired subscriptions results.
	next String	Go to the next page of the expired subscriptions results.
count Integer		The number of expired subscriptions.
results Object		A list of expired subscriptions.
	guid String [`entity_guid`]	The unique identifier of this company.
	industry String	The industry of this company.
	logo String	The URL where this company’s logo image file is stored.
	name String	The name of this company.
	subscription_type String	The name of the subscription that was used to purchase this organization.
	subscription_type_key String	A slug name for the subscription type.
	type String	The rating types. This can have several comma-separated values.
	last_seen_rating Integer	This company’s security rating when the subscription expired. This value is “null“ if the subscription expired over 1 year ago.
	date_expired String [`YYYY‑MM‑DD`]	The date when the subscription expired.
	has_current_active_subscription Boolean	`true` = You've been resubscribed this company and it's currently active in your portfolio.
	rating_change String	Describes how much the rating positively or negatively changed since this subscription expired. Values: `STABLE` = 0 - 10 points difference. `MINOR` = 20 - 30 points difference. `MAJOR` = 40+ points difference. `null` = The subscription expired over 1 year ago.

June 25, 2020: Linked to pagination overview.

Parameters

Example Request

Example Response

Response Attributes

Related articles