Optimyzee

Optimyzee App/Billing/Subscription API

App/Billing/Subscription

GitHub OpenAPI

Operations 6

POST /app/billing/subscription/cancel #
POST /app/billing/subscription/charge #
GET /app/billing/subscription #
POST /app/billing/subscription #
POST /app/billing/subscription/session #
POST /app/billing/subscription/skip #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/optimyzee/refs/heads/main/authentication/optimyzee-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimyzee/refs/heads/main/openapi/optimyzee-app-billing-subscription-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/optimyzee/refs/heads/main/conventions/optimyzee-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/optimyzee/refs/heads/main/errors/optimyzee-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/optimyzee/refs/heads/main/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-app-billing-subscription-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.

GitHub Google LinkedIn

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

OpenAPI Specification

optimyzee-app-billing-subscription-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimyzee Application App/Billing/Subscription API
  version: 4.1.0
  x-original-title: API
  description: App/Billing/Subscription
servers:
- url: https://api.optimyzee.com
  description: Production (host serving this document at /docs)
tags:
- name: App/Billing/Subscription
  description: App/Billing/Subscription
paths:
  /app/billing/subscription/cancel:
    post:
      tags:
      - App/Billing/Subscription
      operationId: appBillingSubscriptionCancel
      responses:
        '204':
          description: Successful
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      security:
      - token: []
  /app/billing/subscription/charge:
    post:
      tags:
      - App/Billing/Subscription
      operationId: appBillingSubscriptionCharge
      responses:
        '204':
          description: Successful
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      security:
      - token: []
  /app/billing/subscription:
    get:
      tags:
      - App/Billing/Subscription
      operationId: appBillingSubscriptionQuery
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AppBillingSubscriptionSchema'
                type: object
    post:
      tags:
      - App/Billing/Subscription
      operationId: appBillingSubscriptionSubscribe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - subscriptionId
              - successUrl
              - cancelUrl
              properties:
                subscriptionId:
                  type: integer
                successUrl:
                  type: string
                cancelUrl:
                  type: string
              type: object
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/AppBillingSubscriptionCheckoutSchema'
                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'
      security:
      - token: []
  /app/billing/subscription/session:
    post:
      tags:
      - App/Billing/Subscription
      operationId: appBillingSubscriptionSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - returnUrl
              properties:
                returnUrl:
                  type: string
              type: object
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/AppBillingSubscriptionSessionSchema'
                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'
      security:
      - token: []
  /app/billing/subscription/skip:
    post:
      tags:
      - App/Billing/Subscription
      operationId: appBillingSubscriptionSkip
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - subscriptionId
              properties:
                subscriptionId:
                  type: integer
              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'
      security:
      - token: []
components:
  schemas:
    AppBillingSubscriptionSessionSchema:
      required:
      - uri
      properties:
        uri:
          type: string
      type: object
    ErrorSchema:
      required:
      - errors
      properties:
        error:
          type: string
        message:
          type:
          - string
          - 'null'
      type: object
    AppBillingSubscriptionSchema:
      required:
      - id
      - plan
      - description
      - features
      - featured
      - amount
      - annual
      - trial
      - sales
      properties:
        id:
          type: integer
        plan:
          type: string
          enum:
          - STARTUP
          - BUSINESS
          - PROFESSIONAL
        description:
          type: string
        features:
          type: array
          items:
            type: string
        featured:
          type: boolean
        amount:
          type: number
          format: float
        annual:
          type: boolean
        trial:
          type:
          - integer
          - 'null'
        sales:
          type: boolean
      type: object
    ErrorBagSchema:
      required:
      - errors
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      type: object
    AppBillingSubscriptionCheckoutSchema:
      required:
      - uri
      properties:
        uri:
          type:
          - string
          - 'null'
      type: object
  securitySchemes:
    token:
      type: apiKey
      description: Bearer token authorization
      name: authorization
      in: header