Gravitee Subscriptions API

Manage subscriptions between applications and plans

Operations 6

GET /environments/{envId}/apis/{apiId}/subscriptions List Subscriptions for an API #
GET /environments/{envId}/subscriptions List Subscriptions #
POST /environments/{envId}/subscriptions Create a Subscription #
GET /environments/{envId}/subscriptions/{subscriptionId} Get a Subscription #
POST /environments/{envId}/subscriptions/{subscriptionId}/_accept Accept a Subscription #
POST /environments/{envId}/subscriptions/{subscriptionId}/_reject Reject a Subscription #

Documentation

Specifications

SDKs

Schemas & Data

Other Resources

🔗
ChangeLog
https://documentation.gravitee.io/apim/release-information/changelog
🔗
License
https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
🔗
SDKs
https://github.com/gravitee-io/gravitee-clients-sdk
🔗
SDKs
https://github.com/gravitee-io/terraform-provider-apim
🔗
CLI
https://github.com/gravitee-io/graviteeio-cli
🔗
KubernetesOperator
https://github.com/gravitee-io/gravitee-kubernetes-operator
🔗
HelmChart
https://github.com/gravitee-io/helm-charts
🔗
DockerImage
https://hub.docker.com/r/graviteeio/apim-gateway
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_notifications.yaml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/finops/gravitee-finops.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/graphql/gravitee-graphql.md
🔗
Reference
https://documentation.gravitee.io/am/reference/am-api-reference
🔗
ChangeLog
https://documentation.gravitee.io/am/releases-and-changelog/release-notes
🔗
License
https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE
🔗
SDKs
https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java
🔗
HelmChart
https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am
🔗
DockerImage
https://hub.docker.com/r/graviteeio/am-gateway

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/gravitee-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gravitee-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gravitee.io APIM Management Subscriptions API
  description: 'The Gravitee API Management (APIM) Management API is the administrative

    control plane for the Gravitee platform. It exposes endpoints to create

    and deploy APIs (both v2 "Gravitee definition v2" and v4 message-oriented

    APIs), manage plans, applications, subscriptions, API products,

    analytics, logs, users, plugins, UI customization, environments, and

    organization-level installation.


    This consolidated specification is synthesized from the upstream v2

    OpenAPI fragments in `gravitee-apim-rest-api-management-v2-rest`

    (`openapi-apis.yaml`, `openapi-environments.yaml`,

    `openapi-analytics.yaml`, `openapi-api-products.yaml`,

    `openapi-installation.yaml`, `openapi-plugins.yaml`,

    `openapi-users.yaml`, `openapi-logs.yaml`, `openapi-ui.yaml`).'
  contact:
    name: GraviteeSource Team
    url: https://gravitee.io
    email: team-apim@graviteesource.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.0.0
servers:
- url: https://{host}/management/v2
  description: APIM Management API v2 - default base URL
  variables:
    host:
      default: apim.example.com
      description: Hostname of the Gravitee APIM Management API
- url: https://{host}/management/v2/organizations/{orgId}
  description: APIM Management API v2 - per-organization base URL
  variables:
    host:
      default: apim.example.com
    orgId:
      default: DEFAULT
security:
- BasicAuth: []
- CookieAuth: []
- BearerAuth: []
tags:
- name: Subscriptions
  description: Manage subscriptions between applications and plans
paths:
  /environments/{envId}/apis/{apiId}/subscriptions:
    get:
      tags:
      - Subscriptions
      operationId: listApiSubscriptions
      summary: List Subscriptions for an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '200':
          description: Subscriptions page
  /environments/{envId}/subscriptions:
    get:
      tags:
      - Subscriptions
      operationId: listSubscriptions
      summary: List Subscriptions
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Subscriptions page
    post:
      tags:
      - Subscriptions
      operationId: createSubscription
      summary: Create a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '201':
          description: Subscription created
  /environments/{envId}/subscriptions/{subscriptionId}:
    get:
      tags:
      - Subscriptions
      operationId: getSubscription
      summary: Get a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The subscription
  /environments/{envId}/subscriptions/{subscriptionId}/_accept:
    post:
      tags:
      - Subscriptions
      operationId: acceptSubscription
      summary: Accept a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Subscription accepted
  /environments/{envId}/subscriptions/{subscriptionId}/_reject:
    post:
      tags:
      - Subscriptions
      operationId: rejectSubscription
      summary: Reject a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Subscription rejected
components:
  parameters:
    ApiId:
      in: path
      name: apiId
      required: true
      schema:
        type: string
      description: The API identifier
    EnvId:
      in: path
      name: envId
      required: true
      schema:
        type: string
      description: The environment identifier
  schemas:
    Subscription:
      type: object
      properties:
        id:
          type: string
        api:
          type: string
        plan:
          type: string
        application:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - ACCEPTED
          - REJECTED
          - CLOSED
          - PAUSED
          - RESUMED
        createdAt:
          type: string
          format: date-time
        startingAt:
          type: string
          format: date-time
        endingAt:
          type: string
          format: date-time
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    CookieAuth:
      type: apiKey
      in: cookie
      name: Auth-Graviteeio-APIM
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT