Skip to main content
GET
/
billing
/
org
/
v1
/
trials
/
start-trial-data
Get trial data for a client and product
curl --request GET \
  --url https://api.gcore.com/billing/org/v1/trials/start-trial-data \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "client_id": 123,
  "client": {
    "id": 2,
    "company_name": "<string>"
  },
  "product": {
    "id": 123,
    "name": "<string>",
    "internal_name": "<string>"
  },
  "plan": {
    "id": 123,
    "name": "<string>"
  },
  "days_limit": 123,
  "active_ranges": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "options": [
    {
      "internal_name": "<string>",
      "name": "<string>",
      "description": "<string>",
      "unit": {
        "id": 2,
        "name": "<string>",
        "internal_name": "<string>"
      },
      "value": 1,
      "used_value": 123,
      "remaining_value": 123,
      "is_limit": true,
      "feature": {
        "id": 123,
        "name": "<string>"
      }
    }
  ],
  "remaining_duration": 123,
  "is_trial_skipped": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

​
client_id
integer
required

ID of the client for whom to retrieve trial data.

Required range: -2147483648 <= x <= 2147483647
​
product_id
integer
required

ID of the product for which to retrieve trial data.

Response

200 - application/json
​
id
integer
required
​
client_id
integer
required

ID of the client associated with the trial.

​
client
object
required

Client associated with the trial.

​
product
object
required

Product associated with the trial.

​
plan
object
required

Plan associated with the trial.

​
days_limit
integer
required

The number of days for which the trial is valid.

​
active_ranges
object[]
required

List of active ranges for the trial.

​
created_at
string<date-time>
required

The date and time when the trial was created.

​
options
object[]
required

List of trial options associated with the trial.

​
remaining_duration
integer
required

Remaining duration of the trial period in seconds. This is calculated as the difference between the end date of the trial and the current time. If the trial has not started or has ended, this field will be null.

​
is_trial_skipped
string
required

Indicates if the trial is skipped.

⌘I