> For the complete documentation index, see [llms.txt](https://docs.soda.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.soda.io/soda-documentation/soda-v3/soda-cloud-api-v1/licensing.md).

# Licensing

Soda Cloud API Licensing Endpoints

## Get licensing plan

> This endpoint returns the licensing plan your organization is on, along with the limits that plan grants.\
> \
> Use it to find out what your organization is entitled to before a tool or pipeline decides what it may do. It reports the limits only, not how much of them is already used: pair it with \`/api/v1/licensing/spuConsumption\` for the SPUs consumed over a period.\
> \
> An organization that is on no plan at all is answered with a 404 \`licensing\_not\_found\` error, so a 200 always carries a plan.\
> \
> \## Authentication\
> \
> User authentication required: \`true\`\
> \
> This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\
> \
> \## Authorization\
> \
> Users must have global role permission MANAGE\_ORGANISATION\_SETTINGS to execute this call.\
> \
> \## Tags\
> \
> \`Licensing\`\
> \
> \## Rate limiting\
> \
> 60 requests/60 seconds

```json
{"openapi":"3.1.0","info":{"title":"Soda Cloud API v3","version":"v1"},"tags":[{"description":"Soda Cloud API Licensing Endpoints","name":"Licensing"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiOrganisationLicensingResponse":{"type":"object","properties":{"plan":{"type":"object","$ref":"#/components/schemas/PublicApiPlanDTO"},"planFeatures":{"type":"object","$ref":"#/components/schemas/PublicApiPlanFeaturesDTO","description":"The limits the plan grants."},"subscription":{"type":"object","$ref":"#/components/schemas/PublicApiSubscriptionDTO"},"trialExpirationTime":{"type":"string","format":"date-time","description":"Only set while the organization is on the trial plan."}}},"PublicApiPlanDTO":{"type":"string","enum":["trial","free","starter","premier","enterprise","teams","enterpriseUserBased","datasetStandard","spus"]},"PublicApiPlanFeaturesDTO":{"type":"object","properties":{"activeChecks":{"type":"integer","format":"int32"},"authorUsers":{"type":"integer","format":"int32"},"concurrentScans":{"type":"integer","format":"int32"},"datasetCount":{"type":"integer","format":"int32"},"prepaidSPUs":{"type":"integer","format":"int64"},"users":{"type":"integer","format":"int32"}},"required":["concurrentScans"]},"PublicApiSubscriptionDTO":{"type":"object","properties":{"endDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date-time"}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/organisation/licensing":{"get":{"description":"This endpoint returns the licensing plan your organization is on, along with the limits that plan grants.\n\nUse it to find out what your organization is entitled to before a tool or pipeline decides what it may do. It reports the limits only, not how much of them is already used: pair it with `/api/v1/licensing/spuConsumption` for the SPUs consumed over a period.\n\nAn organization that is on no plan at all is answered with a 404 `licensing_not_found` error, so a 200 always carries a plan.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Authorization\n\nUsers must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.\n\n## Tags\n\n`Licensing`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"GET/api/v1/organisation/licensing","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiOrganisationLicensingResponse"}}},"description":"Successful response"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get licensing plan","tags":["Licensing"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.soda.io/soda-documentation/soda-v3/soda-cloud-api-v1/licensing.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.