Method: organizations.getSubscription

Get the Subscription resource.

HTTP request

GET https://securitycenter.googleapis.com/v1beta2/{name=organizations/*/subscription}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the subscription to retrieve. Format: organizations/{organization}/subscription

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Resource capturing the state of an organization's subscription.

JSON representation
{
  "name": string,
  "tier": enum (Tier),
  "details": {
    object (Details)
  }
}
Fields
name

string

The resource name of the subscription. Format: organizations/{organization}/subscription

tier

enum (Tier)

The tier of SCC features this organization currently has access to.

details

object (Details)

The details of the most recent active subscription. If there has never been a subscription this will be empty.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Tier

Possible tiers of a subscription.

Enums
TIER_UNSPECIFIED Default value. This value is unused.
STANDARD The standard tier.
PREMIUM The premium tier.

Details

Details of a subscription.

JSON representation
{
  "startTime": string,
  "endTime": string,
  "type": enum (Type)
}
Fields
startTime

string (Timestamp format)

The time the subscription has or will start.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The time the subscription has or will end.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

type

enum (Type)

The type of subscription

Type

Possible types of a subscription.

Enums
TYPE_UNSPECIFIED Default value. This value is unused.
STANDARD The standard subscription.
TRIAL The trial subscription.
ALPHA The alpha subscription.