OpenShorts Billing API

The Billing API from OpenShorts — 11 operation(s) for billing.

GitHub OpenAPI

Operations 11

GET /api/billing/plans List Plans #
POST /api/billing/checkout Create Checkout #
POST /api/billing/end-trial End Trial #
POST /api/billing/portal Create Portal #
GET /api/billing/invoices List Invoices #
GET /api/billing/retention-offer Retention Offer #
POST /api/billing/retention-offer/accept Accept Retention Offer #
POST /api/billing/pause Pause Subscription #
POST /api/billing/unpause Unpause Subscription #
POST /api/billing/resume Resume Subscription #
POST /api/billing/cancel Cancel Subscription #

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/openshorts-app:openshorts-app-billing-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

openshorts-app-billing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast Billing API
  version: 0.1.0
tags:
- name: Billing
paths:
  /api/billing/plans:
    get:
      summary: List Plans
      operationId: list_plans_api_billing_plans_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Billing
  /api/billing/checkout:
    post:
      summary: Create Checkout
      operationId: create_checkout_api_billing_checkout_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Billing
  /api/billing/end-trial:
    post:
      summary: End Trial
      description: 'End the free trial immediately: charge the card now and unlock full plan

        minutes. Kept for grandfathered trialing subscriptions — removable once

        ``SELECT count(*) FROM subscriptions WHERE status=''trialing''`` reaches 0.

        Used when a trialing user hits the trial minute cap and chooses to

        activate their plan right away. The subscription webhook flips status→active

        (and thus the full ``minutes_per_period`` allowance) once Stripe confirms.'
      operationId: end_trial_api_billing_end_trial_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Billing
  /api/billing/portal:
    post:
      summary: Create Portal
      operationId: create_portal_api_billing_portal_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Billing
  /api/billing/invoices:
    get:
      summary: List Invoices
      description: 'Legal invoices for the signed-in user: ``{"invoices": [{doc_number,

        doc_date, total, currency, status, public_url, pdf_url}]}``. Free users

        (no Stripe customer yet) get an empty list, not an error.'
      operationId: list_invoices_api_billing_invoices_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Billing
  /api/billing/retention-offer:
    get:
      summary: Retention Offer
      operationId: retention_offer_api_billing_retention_offer_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Billing
  /api/billing/retention-offer/accept:
    post:
      summary: Accept Retention Offer
      operationId: accept_retention_offer_api_billing_retention_offer_accept_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Billing
  /api/billing/pause:
    post:
      summary: Pause Subscription
      operationId: pause_subscription_api_billing_pause_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Billing
  /api/billing/unpause:
    post:
      summary: Unpause Subscription
      operationId: unpause_subscription_api_billing_unpause_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Billing
  /api/billing/resume:
    post:
      summary: Resume Subscription
      operationId: resume_subscription_api_billing_resume_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Billing
  /api/billing/cancel:
    post:
      summary: Cancel Subscription
      operationId: cancel_subscription_api_billing_cancel_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Billing
components:
  schemas:
    CheckoutRequest:
      properties:
        price_id:
          type: string
          title: Price Id
        source:
          type: string
          title: Source
          default: ''
      type: object
      required:
      - price_id
      title: CheckoutRequest
    CancelRequest:
      properties:
        reason:
          type: string
          title: Reason
        details:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Details
        rating:
          anyOf:
          - type: integer
            maximum: 5.0
            minimum: 1.0
          - type: 'null'
          title: Rating
        review:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Review
        review_public_ok:
          type: boolean
          title: Review Public Ok
          default: false
      type: object
      required:
      - reason
      title: CancelRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError