'Update organization's subscription'

PUT/v2/organizations/{org_id}/subscriptions/{sub_id}

Last modified: 3 days ago

Update a subscription of an organizations

Request

Path Params

org_id

string

required

Organization ID

sub_id

string

required

Subscription ID

Query Params

attributes

array[string]

optional

Include details

subscription

object

optional

status

enum<string>

optional

Subscription status

Allowed values:

activeinactivecanceled

Example:

active

end_date

string | null

optional

Subscription end date

Example:

2023-12-15T19:19:18.037Z

price

integer

optional

Subscription price

Example:

14.33

trial_enabled

boolean

optional

Trial enabled

Example:

true

trial_duration_days

integer

optional

Trial duration days

Example:

auto_renewal

boolean

optional

Auto-renew subscription

Example:

true

cancellation_reason

string | null

optional

Cancellation reason

Example:

No reason

billing_interval

enum<string>

optional

Subscription interval

Allowed values:

nonemonthlyyearly

Example:

yearly

features

object

optional

{
  "subscription": {
    "status": "active",
    "end_date": "2023-12-15T19:19:18.037Z",
    "price": 14.33,
    "trial_enabled": true,
    "trial_duration_days": 14,
    "auto_renewal": true,
    "cancellation_reason": "No reason",
    "billing_interval": "none",
    "features": {
      "number_of_ips": {
        "limit": 10
      },
      "rescan": {
        "active": true,
        "unlimited": false,
        "num_of_rescans": 10,
        "unit": "day",
        "when_run": "always"
      },
      "internal_vrms": {
        "active": true,
        "unlimited": false,
        "limit": 10
      },
      "internal_penetration": {
        "active": true,
        "unlimited": false,
        "limit": 10
      }
    }
  }
}

Request samples

Responses

OK(200)

Unauthorized(401)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

Updated successfully

object {0}

{}

Last modified: 3 days ago