Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Short.io Organizations API
version: 1.0.0
x-scalar-sdk-installation:
- lang: Node
description: 'Install the official **Short.io Node.js SDK** from npm:'
source: npm install @short.io/client-node
servers:
- url: https://api.short.io
description: API server
security:
- apiKey: []
tags:
- name: Organizations
paths:
/organizations/{organizationId}/planInfo:
get:
summary: Get organization plan and usage
tags:
- Organizations
description: 'Returns the organization''s plan tier and billing period alongside its current usage counters: domain and link counts, paid link count, AI spend in microdollars, stored bytes, remaining Pro/Team trial days, the plan''s folder limit per domain (null when unlimited), and nextLinkLimitRecalculationAt: the date (YYYY-MM-DD) the yearly link limit is next recalculated, one year after the last recalculation, else after the first payment, else after the organization registration.'
parameters:
- schema:
type: string
in: path
name: organizationId
required: true
responses:
'200':
description: Default Response
operationId: listPlaninfo
x-codeSamples:
- lang: JavaScript
label: '@short.io/client-node'
source: "const { data } = await listPlaninfo({\n \"path\": {\n \"organizationId\": \"string\"\n }\n});\n"
components:
securitySchemes:
apiKey:
type: apiKey
name: Authorization
in: header