hide

Prologue

Getting started

Basics

Endpoints

Quit documentation

Returns all subscriptions

Get all subscriptions

Through this endpoint, you can retrieve all your active subscriptions. These are important because each subscription — or plan — has different, often unique proxies. These proxies remain the same for the subscription as long as it is active. Later on, you will need the ID of your subscription to retrieve the proxies associated with it - see get proxies endpoint.

Endpoint

https://api.ghostealth.com/de/v1.0/subscriptions?apikey=YOUR_KEY

Endpoint-Information

- Request-Type
- GET
- Header
- Accept: application/json
- Paginated
- No
- Optional-Limit
- 0
- Optionals
- No optionals

That is the Subscription-Object

Fieldname
Type
Description

- id
- String
- The id-field is a unique identifier of the subscription-object. Necessary for other endpoints.
- pid
- String
- The pid-field is a unique identifier of the subscription-object.
- period
- Object
- The period-field returns timestamps.
- - billingCycle
  - String
  - The billingCycle-field returns the current billing cycle.
- - endsAt
  - number
  - Returns a timestamp.
- - endsAtDate
  - String
  - Returns the timestamp in a readable format.
- - startsOn
  - number
  - Returns a timestamp.
- - startsOnDate
  - String
  - Returns the timestamp in a readable format.
- time
- Object
- The time-field returns timestamps.
- - createdAt
  - String
  - The createdAt-field returns a timestamp when the continent has been stored or updated.

before

Preview of content before

Get countries

Returns a list of countries.

Preview of next content

Get proxies

Endpoint for getting all proxies.

Examples