Admiral Billing API

The billing API from Admiral — 10 operation(s) for billing.

GitHub OpenAPI

Operations 10

GET /billing/plans Plans #
GET /billing Current #
POST /billing/checkout Checkout #
GET /billing/wallet Wallet #
POST /billing/topup Topup #
POST /billing/portal Customer Portal #
POST /billing/cancel Cancel #
POST /billing/resume Resume #
GET /billing/leave Leave #
POST /billing/leave/offer Take Offer #

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/meetadmiral-com:meetadmiral-com-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

meetadmiral-com-billing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Billing API
  version: 0.1.0
tags:
- name: Billing
paths:
  /billing/plans:
    get:
      tags:
      - Billing
      summary: Plans
      description: 'Public catalogue — the same numbers the marketing page renders.


        Price is a (tier, band) pair, so the catalogue ships the whole grid

        rather than one number per tier. A null price means that tier is not

        sold at that spend, which the page renders as a dash — never as free.'
      operationId: plans_billing_plans_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /billing:
    get:
      tags:
      - Billing
      summary: Current
      operationId: current_billing_get
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/checkout:
    post:
      tags:
      - Billing
      summary: Checkout
      operationId: checkout_billing_checkout_post
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/wallet:
    get:
      tags:
      - Billing
      summary: Wallet
      description: 'The wallet in words: balance, the statement, every service''s price,

        and the packs. Any member may read it; only an owner may top up.'
      operationId: wallet_billing_wallet_get
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/topup:
    post:
      tags:
      - Billing
      summary: Topup
      description: 'One-time checkout for a top-up pack. Bought only on this explicit

        request (CREDIT_POLICY); the signed webhook is what credits the wallet.'
      operationId: topup_billing_topup_post
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TopupBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/portal:
    post:
      tags:
      - Billing
      summary: Customer Portal
      operationId: customer_portal_billing_portal_post
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/cancel:
    post:
      tags:
      - Billing
      summary: Cancel
      description: 'Stop at the end of the paid period, or of the trial. Access is

        untouched until then, and nothing is charged. A trial has no provider

        to tell, so only the flag is set; it is what the page reads to say

        "ends on" instead of offering a plan to pay for.'
      operationId: cancel_billing_cancel_post
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/CancelBody'
              - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/resume:
    post:
      tags:
      - Billing
      summary: Resume
      description: Undo a scheduled cancellation while the period is still running.
      operationId: resume_billing_resume_post
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/leave:
    get:
      tags:
      - Billing
      summary: Leave
      description: 'What leaving would mean for this workspace, and the one offer to lead

        with for each reason the owner might give. The page picks from `lead`

        without asking again, so choosing a reason never waits on a request.'
      operationId: leave_billing_leave_get
      parameters:
      - name: intent
        in: query
        required: false
        schema:
          type: string
          pattern: ^(cancel|delete)$
          default: cancel
          title: Intent
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /billing/leave/offer:
    post:
      tags:
      - Billing
      summary: Take Offer
      description: 'Take the save offer. Each is given once per workspace; staying lifts

        a cancellation the owner had scheduled.'
      operationId: take_offer_billing_leave_offer_post
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfferBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TopupBody:
      properties:
        pack:
          type: string
          pattern: ^(pack_100|pack_300|pack_1000)$
          title: Pack
      type: object
      required:
      - pack
      title: TopupBody
    OfferBody:
      properties:
        offer:
          type: string
          pattern: ^(extend_trial|discount)$
          title: Offer
        intent:
          type: string
          pattern: ^(cancel|delete)$
          title: Intent
          default: cancel
        reason:
          anyOf:
          - type: string
            pattern: ^(too_expensive|no_time|no_results|missing|other_tool|other)$
          - type: 'null'
          title: Reason
      type: object
      required:
      - offer
      title: OfferBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CancelBody:
      properties:
        reason:
          anyOf:
          - type: string
            pattern: ^(too_expensive|no_time|no_results|missing|other_tool|other)$
          - type: 'null'
          title: Reason
      type: object
      title: CancelBody
    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
    CheckoutBody:
      properties:
        tier:
          type: string
          pattern: ^(business|max)$
          title: Tier
        band:
          anyOf:
          - type: string
            pattern: ^(under_3k|3k_10k|10k_50k|over_50k)$
          - type: 'null'
          title: Band
        currency:
          anyOf:
          - type: string
            pattern: ^USD$
          - type: 'null'
          title: Currency
      type: object
      required:
      - tier
      title: CheckoutBody