🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The updateOrganizationSubscription() mutation sets the subscription tier for an organization. It accepts a required subscription enum value and an optional trialDays integer, then returns the updated Organization object. Use this mutation to transition an organization between subscription states — for example, from PreTrial to Trial, or from Trial to Paying. The subscription tier controls feature access and usage limits for the organization. This mutation requires root-level administrative access.

Syntax

graphql
updateOrganizationSubscription(
      input: UpdateSubscriptionInputObject!
   ): Organization!

The input argument accepts an UpdateSubscriptionInputObject!, which requires a subscription value and accepts an optional trialDays integer. The mutation returns a non-null Organization! object representing the organization after the update.

The subscription field accepts one of the Organizations__Subscription enum values: Paying (active paid subscription), Trial (time-limited trial period), PreTrial (registered but trial not yet started), PostTrial (trial ended without conversion to paid), or UnlimitedPoC (unlimited proof-of-concept evaluation). The trialDays field applies only when setting the subscription to Trial; it specifies the trial duration in days. Omitting trialDays when transitioning to Trial applies no explicit duration limit.

Input parameters

The subscription field is required. It specifies the new subscription tier and controls the feature access and usage limits applied to the organization. The optional trialDays field sets the duration of a trial period in days; it applies only when transitioning to the Trial subscription tier. Omitting it when setting Trial applies no explicit duration limit on the trial.

Table: UpdateSubscriptionInputObject Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
subscriptionOrganizations__Subscriptionyes Short-Term The type of subscription. See Organizations__Subscription.
trialDaysInt  Short-Term The number of days of the subscription trial, if it is a trial.

Example

Raw
graphql
mutation {
  updateOrganizationSubscription( input:
    {
     subscription: Trial,
     trialDays: 15
    }
  )
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateOrganizationSubscription( input:
    {
     subscription: Trial,
     trialDays: 15
    }
  )
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateOrganizationSubscription( input:
    {
     subscription: Trial,
     trialDays: 15
    }
  )
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateOrganizationSubscription( input: ^
    { ^
     subscription: Trial, ^
     trialDays: 15 ^
    } ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateOrganizationSubscription( input:
    {
     subscription: Trial,
     trialDays: 15
    }
  )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateOrganizationSubscription( input:
    {
     subscription: Trial,
     trialDays: 15
    }
  )
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateOrganizationSubscription( input:
    {
     subscription: Trial,
     trialDays: 15
    }
  )
  { id }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateOrganizationSubscription( input:
    {
     subscription: Trial,
     trialDays: 15
    }
  )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateOrganizationSubscription": {
      "id": "abc123"
    }
  }
}

Returned values

The mutation returns the updated Organization! object. The returned fields include the organization's identifier, name, subscription tier, URLs, and configured limits. To confirm the subscription change took effect, select the details field, which includes the subscription value. The following table lists the available fields:

Table: Organization Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
actionOrganizationAction):Booleanyes Short-Term The action to check if a user is allowed to perform on an organization.
cidString  Short-Term The CID corresponding to the organization.
configsOrganizationConfigsyes Short-Term Organization configurations and settings. See OrganizationDetails.
createdAtLong  Short-Term Date organization was created.
defaultCachePolicyCachePolicy  Short-Term The default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
deletedAtLong  Short-Term Day organization was deleted if it was marked for deletion.
descriptionString  Short-Term The description for the Organization. Can be null.
detailsOrganizationDetailsyes Short-Term Any additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationBooleanyes Short-Term Whether there is group synchronization.
externalPermissionsBooleanyes Short-Term Whether permissions are managed externally.
idStringyes Short-Term The unique id for the Organization.
ingestUrlString  Short-Term The ingest URL for the organization.
limitsLimityes Short-Term Limits assigned to the organization. See Limit.
limitsV2LimitV2yes Short-Term Limits assigned to the organization. See LimitV2.
nameStringyes Short-Term The name for the Organization.
publicUrlString  Short-Term The public URL for the organization.
readonlyDashboardIPFilterString  Short-Term IP filter for readonly dashboard links.
searchDomainsSearchDomainyes Short-Term Search domains within the organization. See SearchDomain.
statsOrganizationStatsyes Short-Term Statistics of the organization. See OrganizationStats.
trialStartedAtLong  Short-Term Date organization's trial started.