ContractorRoster Billing API

Authenticated billing endpoints (top-up, usage).

GitHub OpenAPI

Operations 2

POST /api/v1/topup Create a Stripe Checkout Session to credit the partner balance #
GET /api/v1/usage Partner balance, pricing, and recent transactions #

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/contractorroster-com:contractorroster-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. See our Privacy Policy and Terms.

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

OpenAPI Specification

contractorroster-com-billing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Contractorroster Com Billing API
  version: 1.0.0
  contact:
    name: ContractorRoster Partnerships
    email: hello@contractorroster.com
    url: https://contractorroster.com/partnerships
  license:
    name: Per-record (prepaid balance)
    url: https://contractorroster.com/partnerships
  description: 'Operations tagged Billing across 2 of this provider''s published API definitions: contractorroster-com-openapi.yaml, contractorroster-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://contractorroster.com
  description: Production
tags:
- name: Billing
  description: Authenticated billing endpoints (top-up, usage).
paths:
  /api/v1/topup:
    post:
      tags:
      - Billing
      summary: Create a Stripe Checkout Session to credit the partner balance
      description: 'Minimum $50, maximum $10,000 per session. The returned `checkout_url`

        is a Stripe-hosted page — redirect the partner there. Balance is

        credited via webhook after successful payment.'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - amount_cents
              properties:
                amount_cents:
                  type: integer
                  minimum: 5000
                  maximum: 1000000
                  example: 5000
      responses:
        '200':
          description: Checkout session created
          content:
            application/json:
              schema:
                type: object
                properties:
                  checkout_url:
                    type: string
                  amount_cents:
                    type: integer
        '400':
          description: Invalid amount
        '401':
          description: Missing or invalid API key
      operationId: postApiV1Topup
      x-operation-id-source: derived
    servers:
    - url: https://contractorroster.com
      description: Production
  /api/v1/usage:
    get:
      tags:
      - Billing
      summary: Partner balance, pricing, and recent transactions
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Balance + recent transactions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '401':
          description: Missing or invalid API key
      operationId: getApiV1Usage
      x-operation-id-source: derived
    servers:
    - url: https://contractorroster.com
      description: Production
components:
  schemas:
    UsageResponse:
      type: object
      properties:
        partner:
          type: object
          properties:
            id:
              type: string
            email:
              type: string
            display_name:
              type:
              - string
              - 'null'
            status:
              type: string
              enum:
              - active
              - suspended
              - closed
            price_per_record_cents:
              type: integer
            balance_cents:
              type: integer
        transactions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              kind:
                type: string
                enum:
                - topup
                - api_call
                - refund
                - adjustment
              amount_cents:
                type: integer
              balance_after_cents:
                type: integer
              state:
                type:
                - string
                - 'null'
              trade:
                type:
                - string
                - 'null'
              geo_type:
                type:
                - string
                - 'null'
              geo_value:
                type:
                - string
                - 'null'
              records_delivered:
                type:
                - integer
                - 'null'
              stripe_session_id:
                type:
                - string
                - 'null'
              created_at:
                type: string
                format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cr_live_...
x-refined-from:
- contractorroster-com-openapi.yaml
- contractorroster-com-openapi.yml
x-pricing:
  api:
    standard_price_per_record_cents: 10
    crm_partner_price_per_record_cents: 7
    min_topup_cents: 5000
    max_topup_cents: 1000000
    contact: hello@contractorroster.com