Optimyzee

Optimyzee Operations/Billing/Subscription API

Operations/Billing/Subscription

GitHub OpenAPI
Business capability
Subscription Lifecycle Management BC-4240

Operations 5

GET /operations/billing/subscription Operations billing subscription query #
POST /operations/billing/subscription Operations billing subscription create #
GET /operations/billing/subscription/{subscriptionId} Operations billing subscription view #
PUT /operations/billing/subscription/{subscriptionId} Operations billing subscription update #
DELETE /operations/billing/subscription/{subscriptionId} Operations billing subscription delete #

Documentation

📖
Authentication
https://artifacts.apis.io/optimyzee/authentication/optimyzee-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/optimyzee/openapi/optimyzee-operations-billing-subscription-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/optimyzee/conventions/optimyzee-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/optimyzee/errors/optimyzee-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/optimyzee/data-model/optimyzee-data-model.yml

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/optimyzee:optimyzee-operations-billing-subscription-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

optimyzee-operations-billing-subscription-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Operations/Billing/Subscription API
  version: 4.1.0
  description: Operations/Billing/Subscription
tags:
- name: Operations/Billing/Subscription
  description: Operations/Billing/Subscription
paths:
  /operations/billing/subscription:
    get:
      tags:
      - Operations/Billing/Subscription
      operationId: operationsBillingSubscriptionQuery
      parameters:
      - name: legacy
        in: query
        schema:
          type:
          - integer
          - 'null'
          enum:
          - 0
          - 1
      - name: perPage
        in: query
        schema:
          type: integer
      - name: cursor
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                required:
                - items
                - perPage
                - next
                - previous
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/OperationsBillingSubscriptionSchema'
                  perPage:
                    type: integer
                  previous:
                    type:
                    - string
                    - 'null'
                  next:
                    type:
                    - string
                    - 'null'
                type: object
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBagSchema'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      summary: Operations billing subscription query
      x-summary-source: derived
    post:
      tags:
      - Operations/Billing/Subscription
      operationId: operationsBillingSubscriptionCreate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - plan
              - description
              - features
              - featured
              - stripePriceId
              - annual
              - amount
              - sales
              - legacy
              properties:
                plan:
                  type: string
                  enum:
                  - STARTUP
                  - BUSINESS
                  - PROFESSIONAL
                description:
                  type: string
                features:
                  type: array
                  items:
                    type: string
                featured:
                  type: boolean
                stripePriceId:
                  type: string
                annual:
                  type: boolean
                amount:
                  type: number
                trial:
                  type:
                  - number
                  - 'null'
                sales:
                  type: boolean
                legacy:
                  type: boolean
              type: object
      responses:
        '201':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBagSchema'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      summary: Operations billing subscription create
      x-summary-source: derived
  /operations/billing/subscription/{subscriptionId}:
    get:
      tags:
      - Operations/Billing/Subscription
      operationId: operationsBillingSubscriptionView
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/OperationsBillingSubscriptionSchema'
                type: object
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      summary: Operations billing subscription view
      x-summary-source: derived
    put:
      tags:
      - Operations/Billing/Subscription
      operationId: operationsBillingSubscriptionUpdate
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - plan
              - description
              - features
              - featured
              - stripePriceId
              - annual
              - amount
              - sales
              - legacy
              properties:
                plan:
                  type: string
                  enum:
                  - STARTUP
                  - BUSINESS
                  - PROFESSIONAL
                description:
                  type: string
                features:
                  type: array
                  items:
                    type: string
                featured:
                  type: boolean
                stripePriceId:
                  type: string
                annual:
                  type: boolean
                amount:
                  type: number
                trial:
                  type:
                  - number
                  - 'null'
                sales:
                  type: boolean
                legacy:
                  type: boolean
              type: object
      responses:
        '204':
          description: Successful
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBagSchema'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      summary: Operations billing subscription update
      x-summary-source: derived
    delete:
      tags:
      - Operations/Billing/Subscription
      operationId: operationsBillingSubscriptionDelete
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Successful
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      summary: Operations billing subscription delete
      x-summary-source: derived
components:
  schemas:
    OperationsBillingSubscriptionSchema:
      required:
      - id
      - plan
      - description
      - features
      - featured
      - stripePriceId
      - amount
      - annual
      - trial
      - sales
      - legacy
      properties:
        id:
          type: integer
        plan:
          type: string
          enum:
          - STARTUP
          - BUSINESS
          - PROFESSIONAL
        description:
          type: string
        features:
          type: array
          items:
            type: string
        featured:
          type: boolean
        stripePriceId:
          type: string
        amount:
          type: number
          format: float
        annual:
          type: boolean
        trial:
          type:
          - integer
          - 'null'
        sales:
          type: boolean
        legacy:
          type: boolean
      type: object
    IdSchema:
      required:
      - id
      properties:
        id:
          type: integer
      type: object
    ErrorSchema:
      required:
      - errors
      properties:
        error:
          type: string
        message:
          type:
          - string
          - 'null'
      type: object
    ErrorBagSchema:
      required:
      - errors
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      type: object
  securitySchemes:
    token:
      type: apiKey
      description: Bearer token authorization
      name: authorization
      in: header