Skip to main content
PATCH
/
billing
/
org
/
v1
/
trials
/
{id}
Update an existing Trial
curl --request PATCH \
  --url https://api.gcore.com/billing/org/v1/trials/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "days_limit": 1,
  "CDN_TRIAL_TRAFFIC_LIMIT": 1,
  "DDOS_TRIAL_RESOURCE_LIMIT": 1,
  "STORAGE_TRIAL_CAPACITY_LIMIT": 1,
  "STREAMING_TRIAL_LIMIT_ENCODING_VIDEO_MIN": 1,
  "STREAMING_TRIAL_LIMIT_VIDEO_STORAGE_MIN": 1,
  "STREAMING_TRIAL_STREAMS_LIMIT": 1,
  "TRIAL_STREAMING_ACTIVE_RESTREAMS_LIMIT_COUNT": 1,
  "TRIAL_STREAMING_VOD": 1,
  "WAAP_TRIAL_DOMAINS_LIMIT": 1,
  "WAAP_TRIAL_REQUESTS_LIMIT": 1,
  "WAAP_TRIAL_VOLUME_LIMIT": 1
}'
{
  "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

Path Parameters

id
integer
required

Body

days_limit
integer

The number of days for which the trial is valid. If not provided, the trial will not be updated.

Required range: x >= 0
CDN_TRIAL_TRAFFIC_LIMIT
integer

Value for the trial option CDN_TRIAL_TRAFFIC_LIMIT. If not provided, the trial option will not be updated.

Required range: x >= 0
DDOS_TRIAL_RESOURCE_LIMIT
integer

Value for the trial option DDOS_TRIAL_RESOURCE_LIMIT. If not provided, the trial option will not be updated.

Required range: x >= 0
STORAGE_TRIAL_CAPACITY_LIMIT
integer

Value for the trial option STORAGE_TRIAL_CAPACITY_LIMIT. If not provided, the trial option will not be updated.

Required range: x >= 0
STREAMING_TRIAL_LIMIT_ENCODING_VIDEO_MIN
integer

Value for the trial option STREAMING_TRIAL_LIMIT_ENCODING_VIDEO_MIN. If not provided, the trial option will not be updated.

Required range: x >= 0
STREAMING_TRIAL_LIMIT_VIDEO_STORAGE_MIN
integer

Value for the trial option STREAMING_TRIAL_LIMIT_VIDEO_STORAGE_MIN. If not provided, the trial option will not be updated.

Required range: x >= 0
STREAMING_TRIAL_STREAMS_LIMIT
integer

Value for the trial option STREAMING_TRIAL_STREAMS_LIMIT. If not provided, the trial option will not be updated.

Required range: x >= 0
TRIAL_STREAMING_ACTIVE_RESTREAMS_LIMIT_COUNT
integer

Value for the trial option TRIAL_STREAMING_ACTIVE_RESTREAMS_LIMIT_COUNT. If not provided, the trial option will not be updated.

Required range: x >= 0
TRIAL_STREAMING_VOD
integer

Value for the trial option TRIAL_STREAMING_VOD. If not provided, the trial option will not be updated.

Required range: x >= 0
WAAP_TRIAL_DOMAINS_LIMIT
integer

Value for the trial option WAAP_TRIAL_DOMAINS_LIMIT. If not provided, the trial option will not be updated.

Required range: x >= 0
WAAP_TRIAL_REQUESTS_LIMIT
integer

Value for the trial option WAAP_TRIAL_REQUESTS_LIMIT. If not provided, the trial option will not be updated.

Required range: x >= 0
WAAP_TRIAL_VOLUME_LIMIT
integer

Value for the trial option WAAP_TRIAL_VOLUME_LIMIT. If not provided, the trial option will not be updated.

Required range: x >= 0

Response

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