Cast AI PLG Trial API

openapi: 3.2.0
info:
  title: Organization Management PLG Trial API
  version: 0.0.1
  description: PLGTrialAPI provides endpoints for managing product-led growth (PLG) trials per organization.
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: PLGTrialAPI
  description: PLGTrialAPI provides endpoints for managing product-led growth (PLG) trials per organization.
paths:
  /organization-management/v1/organizations/{organizationId}/trials:
    get:
      tags:
      - PLGTrialAPI
      summary: Get PLG trial information for an organization
      description: GetOrganizationTrial retrieves the PLG trial information for the organization.
      operationId: PLGTrialAPI_GetOrganizationTrial
      parameters:
      - name: organizationId
        in: path
        description: organization_id is the UUID of the organization to retrieve trial info for.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationTrialResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /organization-management/v1/organizations/{organizationId}/trials/sales-contacted:
    post:
      tags:
      - PLGTrialAPI
      summary: Mark that sales has been contacted for the PLG trial
      description: 'MarkSalesContactedOrganizationTrial marks that sales was contacted for the organization trial,

        which prolongs the trial period.'
      operationId: PLGTrialAPI_MarkSalesContactedOrganizationTrial
      parameters:
      - name: organizationId
        in: path
        description: organization_id is the UUID of the organization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkSalesContactedOrganizationTrialResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /organization-management/v1/organizations/{organizationId}/trials/start:
    post:
      tags:
      - PLGTrialAPI
      description: Starts the trial for the organization.
      operationId: PLGTrialAPI_StartOrganizationTrial
      parameters:
      - name: organizationId
        in: path
        description: organization_id is the UUID of the organization to retrieve trial info for.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartOrganizationTrialResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
      summary: PLG trial API start organization trial
      x-summary-source: derived
components:
  schemas:
    Status:
      type: object
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
      description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
    GetOrganizationTrialResponse:
      type: object
      properties:
        trialStartTime:
          type: string
          description: trial_start_time is the time when the trial period started.
          format: date-time
        trialEndTime:
          type: string
          description: trial_end_time is the time when the trial period ends.
          format: date-time
        salesContacted:
          type: boolean
          description: sales_contacted indicates whether sales has been contacted; doing so automatically prolongs the trial.
        gracePeriodEndTime:
          type: string
          description: grace_period_end_time is the time when the grace period ends.
          format: date-time
        inGracePeriod:
          type: boolean
          description: in_grace_period indicates whether the trial has expired but the organization is still in the grace period.
        status:
          enum:
          - TRIAL_STATUS_UNSPECIFIED
          - TRIAL_STATUS_PENDING
          - TRIAL_STATUS_ACTIVE
          - TRIAL_STATUS_CONVERTED
          - TRIAL_STATUS_EXPIRED
          type: string
          description: status is the current status of the trial.
          format: enum
      description: GetOrganizationTrialResponse is the response message for GetOrganizationTrial.
    MarkSalesContactedOrganizationTrialResponse:
      type: object
      properties: {}
      description: MarkSalesContactedOrganizationTrialResponse is the response message for MarkSalesContactedOrganizationTrial.
    StartOrganizationTrialResponse:
      type: object
      properties: {}
      description: StartOrganizationTrialResponse is the response message for StartOrganizationTrial.
    GoogleProtobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-provenance:
  method: searched
  source: https://docs.cast.ai/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.cast.ai/reference/enterpriseapi_addusertochildorganization.md
  - https://docs.cast.ai/reference/enterpriseapi_batchcreateenterprisegroups.md
  - https://docs.cast.ai/reference/enterpriseapi_batchcreateenterpriserolebindings.md
  - https://docs.cast.ai/reference/enterpriseapi_batchcreateenterpriseserviceaccounts.md
  - https://docs.cast.ai/reference/enterpriseapi_batchdeleteenterprisegroups.md
  - https://docs.cast.ai/reference/enterpriseapi_batchdeleteenterpriserolebindings.md
  - https://docs.cast.ai/reference/enterpriseapi_batchdeleteenterpriseserviceaccounts.md
  - https://docs.cast.ai/reference/enterpriseapi_batchupdateenterprisegroups.md
  - https://docs.cast.ai/reference/enterpriseapi_batchupdateenterpriserolebindings.md
  - https://docs.cast.ai/reference/enterpriseapi_batchupdateenterpriseserviceaccounts.md
  - https://docs.cast.ai/reference/enterpriseapi_createchildorganization.md
  - https://docs.cast.ai/reference/enterpriseapi_deletechildorganization.md
  - https://docs.cast.ai/reference/enterpriseapi_getenterprisegroup.md
  - https://docs.cast.ai/reference/enterpriseapi_getenterprisemember.md
  - https://docs.cast.ai/reference/enterpriseapi_inviteusers.md
  - https://docs.cast.ai/reference/enterpriseapi_listchildrenorganizations.md
  - https://docs.cast.ai/reference/enterpriseapi_listenterpriseserviceaccounts.md
  - https://docs.cast.ai/reference/enterpriseapi_listgroups.md
  - https://docs.cast.ai/reference/enterpriseapi_listmembers.md
  - https://docs.cast.ai/reference/enterpriseapi_listrolebindings.md
  - https://docs.cast.ai/reference/enterpriseapi_overrideuserrolebindings.md
  - https://docs.cast.ai/reference/identityapi_setfingerprint.md
  - https://docs.cast.ai/reference/pattokenapi_createpat.md
  - https://docs.cast.ai/reference/pattokenapi_deletepat.md
  - https://docs.cast.ai/reference/pattokenapi_getpat.md
  - https://docs.cast.ai/reference/pattokenapi_listpats.md
  - https://docs.cast.ai/reference/pattokenapi_updatepat.md
  - https://docs.cast.ai/reference/plgtrialapi_getorganizationtrial.md
  - https://docs.cast.ai/reference/plgtrialapi_marksalescontactedorganizationtrial.md
  - https://docs.cast.ai/reference/plgtrialapi_startorganizationtrial.md
  - https://docs.cast.ai/reference/scimapi_createscimgroup.md
  - https://docs.cast.ai/reference/scimapi_createscimuser.md
  - https://docs.cast.ai/reference/scimapi_deletescimgroup.md
  - https://docs.cast.ai/reference/scimapi_deletescimuser.md
  - https://docs.cast.ai/reference/scimapi_getscimgroup.md
  - https://docs.cast.ai/reference/scimapi_getscimschema.md
  - https://docs.cast.ai/reference/scimapi_getscimuser.md
  - https://docs.cast.ai/reference/scimapi_getserviceproviderconfig.md
  - https://docs.cast.ai/reference/scimapi_listscimgroups.md
  - https://docs.cast.ai/reference/scimapi_listscimresourcetypes.md
  - https://docs.cast.ai/reference/scimapi_listscimschemas.md
  - https://docs.cast.ai/reference/scimapi_listscimusers.md
  - https://docs.cast.ai/reference/scimapi_replacescimgroup.md
  - https://docs.cast.ai/reference/scimapi_replacescimuser.md
  - https://docs.cast.ai/reference/scimapi_updatescimgroup.md
  - https://docs.cast.ai/reference/scimapi_updatescimuser.md
  - https://docs.cast.ai/reference/secretsapi_batchcreatesecretscanningalert.md
  - https://docs.cast.ai/reference/settingsapi_getsettings-1.md
  - https://docs.cast.ai/reference/settingsapi_updatesettings-1.md
  - https://docs.cast.ai/reference/ssoapi_createssosyncconfig.md
  - https://docs.cast.ai/reference/ssoapi_deletessosyncconfig.md
  - https://docs.cast.ai/reference/ssoapi_getssosyncconfig.md
  - https://docs.cast.ai/reference/ssoapi_updatessosyncconfig.md
  merge:
    pages: 53
    deduped: 323
    conflicts_kept_first: 0