Conduyt Billing API

openapi: 3.2.0
info:
  title: Conduyt Billing API
  version: 1.0.0
  description: 'The Conduyt CRM API provides programmatic access to your CRM data including

    contacts, companies, deals, pipelines, tasks, notes, automations, invoices,

    email sequences, and more.


    ## Authentication


    All authenticated endpoints require a Bearer token (API key) in the

    `Authorization` header:


    ```

    Authorization: Bearer cdy_

    ```


    API keys are generated in **Settings > API Keys** within the Conduyt

    dashboard. Keys use the `cdy_` prefix and are hashed with bcrypt on

    creation — the full key is shown exactly once at creation time.


    Session cookie authentication (`conduyt_session`) is also supported for

    browser-based clients but is not recommended for integrations.


    ## Rate Limiting


    API keys enforce a per-key rate limit. New keys default to 100 requests per

    minute and can be configured at creation time or with PATCH `/api-keys/{id}`.

    Some public and provider-facing endpoints also enforce stricter per-IP or

    per-account limits. When exceeded, the API returns `429 Too Many Requests`

    with a `Retry-After` header indicating seconds until the next allowed

    request.


    | Endpoint Group | Limit |

    |---------------------|---------------------|

    | API keys | Default 100 / min per key |

    | Login/reset | 5 / min per IP |

    | Registration | 3 / hour per IP |

    | Contact/Deal create | 30 / min per IP |

    | Inbound messages | 120 / min per account/IP |


    ## Pagination


    List endpoints support cursor-based pagination via query parameters:


    - `page` — Page number (default: 1)

    - `per_page` — Items per page (default: 50, max: 200)

    - `limit` — Accepted as an alias of `per_page` on `GET /contacts`; if both are

    sent they must carry the same value.


    A page size above the maximum, a non-integer, a value below 1, or a

    pagination key repeated with different values is rejected with `400`

    (the message names the parameter and the rule); nothing is silently

    clamped or ignored.


    Responses include a `meta` object: `{ page, per_page, total }`.


    An operation that documents its own pagination rules follows those instead.

    `GET /sms-providers/options` pages with an opaque `cursor` and a `limit`

    that is capped at 50 rather than rejected; its responses carry

    `meta: { nextCursor, truncated }`.


    ## Response Format


    All successful responses wrap data in a `data` envelope:

    ```json

    { "data": { ... } }

    ```


    Error responses use:

    ```json

    { "error": "Human-readable error message" }

    ```


    ## Multi-Tenancy


    Conduyt is multi-tenant. All data is scoped to the authenticated user''s

    current account. API keys are bound to a specific account at creation time.


    ## Webhook Events


    Outbound webhooks fire on events including:

    `contact.created`, `contact.updated`, `contact.deleted`,

    `deal.created`, `deal.updated`, `deal.won`, `deal.lost`,

    `task.created`, `task.completed`, `note.created`,

    `appointment.created`, `appointment.updated`,

    `form.submitted`, `invoice.paid`


    Payloads are signed with HMAC-SHA256 using the webhook''s secret. Retry

    schedule: 1m, 5m, 30m, 2h, 12h, 72h (7 total attempts including the initial delivery).'
  contact:
    name: Conduyt Support
    url: https://conduyt.app
    email: support@conduyt.app
  license:
    name: Proprietary
    url: https://conduyt.app/terms
servers:
- url: https://conduyt.app/api/v1
  description: Production
security:
- BearerAuth: []
tags:
- name: Billing
  description: Stripe billing, checkout, and subscription status
paths:
  /billing/checkout:
    post:
      operationId: createCheckoutSession
      summary: Create a Stripe checkout session
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                interval:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                planId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
        required: true
      responses:
        '200':
          description: Checkout session URL
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        action:
                          type: string
                        subscriptionId: {}
                        plan: {}
                        status: {}
                      required:
                      - action
                      - subscriptionId
                      - plan
                      - status
                  required:
                  - data
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        url: {}
                      required:
                      - url
                  required:
                  - data
      parameters: []
  /billing/portal:
    post:
      operationId: createBillingPortal
      summary: Create a Stripe billing portal session
      tags:
      - Billing
      responses:
        '200':
          description: Portal session URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      url: {}
                    required:
                    - url
                required:
                - data
      parameters: []
  /billing/status:
    get:
      operationId: getBillingStatus
      summary: Get subscription status
      tags:
      - Billing
      responses:
        '200':
          description: Billing status details
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      plan: {}
                      planName: {}
                      price: {}
                      interval: {}
                      features: {}
                      limits: {}
                      usage: {}
                      adoption: {}
                      billingStatus: {}
                      billingEmail: {}
                      currentPeriodEnd: {}
                      trialEndsAt: {}
                      trialDaysRemaining: {}
                      trialExpired: {}
                      hasStripeCustomer: {}
                      hasSubscription: {}
                      isComp: {}
                      health: {}
                      invoiceHistory: {}
                    required:
                    - plan
                    - planName
                    - price
                    - interval
                    - features
                    - limits
                    - usage
                    - adoption
                    - billingStatus
                    - billingEmail
                    - currentPeriodEnd
                    - trialEndsAt
                    - trialDaysRemaining
                    - trialExpired
                    - hasStripeCustomer
                    - hasSubscription
                    - isComp
                    - health
                    - invoiceHistory
                required:
                - data
      parameters: []
  /billing/webhook:
    post:
      operationId: webhookStripeBilling
      summary: Stripe billing webhook
      tags:
      - Billing
      security: []
      responses:
        '200':
          description: Stripe billing event processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  received:
                    type: boolean
                  duplicate:
                    type: boolean
                required:
                - received
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: A Stripe event, sent as raw JSON and verified against the Stripe-Signature header over the exact bytes (a re-serialised body fails). Only the fields listed are read.
              required:
              - id
              - type
              - data
              properties:
                id:
                  type: string
                  description: The Stripe event id, used to claim the delivery once
                type:
                  type: string
                  description: The event type; the handler acts on the types it knows and acknowledges the rest
                data:
                  type: object
                  description: 'The event payload: data.object is the Stripe object the type names'
  /billing/addons:
    delete:
      x-generated: true
      operationId: deleteBillingAddons
      summary: Delete billing addons
      tags:
      - Billing
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      canceled: {}
                      entitlements: {}
                    required:
                    - canceled
                    - entitlements
                required:
                - data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subscriptionId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
    get:
      x-generated: true
      operationId: getBillingAddons
      summary: List billing addons
      tags:
      - Billing
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addons: {}
                      entitlements: {}
                      catalog: {}
                      canPurchase: {}
                    required:
                    - addons
                    - entitlements
                    - catalog
                    - canPurchase
                required:
                - data
    post:
      x-generated: true
      operationId: postBillingAddons
      summary: Create / invoke billing addons
      tags:
      - Billing
      parameters:
      - name: Idempotency-Key
        in: header
        required: true
        description: 'One key per purchase attempt (8-64 characters of [A-Za-z0-9_-]). Reuse it only to retry the SAME request after an ambiguous answer; the server completes or replays your own attempt and refuses a different key that meets an add-on someone else already bought (409 addon_already_active with the live quantity: add more with PATCH). Missing or malformed: 400 idempotency_key_required.'
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{8,64}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                addonKey:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                quantity:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      subscription: {}
                      entitlements: {}
                    required:
                    - subscription
                    - entitlements
                required:
                - data
    patch:
      x-generated: true
      operationId: patchBillingAddons
      summary: Update billing addons
      tags:
      - Billing
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: 'Recommended: one key per quantity change (8-64 characters of [A-Za-z0-9_-]), reused only to retry the same request. With the required body field expectedQuantity, a different key from the same base is refused as stale (409 stale_quantity) instead of being reported as done.'
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{8,64}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                expectedQuantity:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                quantity:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                subscriptionId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      subscription: {}
                      entitlements: {}
                    required:
                    - subscription
                    - entitlements
                required:
                - data
  /billing/gate:
    get:
      x-generated: true
      operationId: getBillingGate
      summary: List billing gate
      tags:
      - Billing
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      plan: {}
                      billingStatus: {}
                      effectiveBillingStatus: {}
                      trialEndsAt: {}
                      trialDaysRemaining: {}
                      isComp: {}
                      blocked: {}
                      blockedReason: {}
                      analytics: {}
                    required:
                    - plan
                    - billingStatus
                    - effectiveBillingStatus
                    - trialEndsAt
                    - trialDaysRemaining
                    - isComp
                    - blocked
                    - blockedReason
                    - analytics
                required:
                - data
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'API key authentication. Generate keys in Settings > API Keys.

        Keys use the `cdy_` prefix.


        Example: `Authorization: Bearer cdy_a1b2c3d4e5f6...`

        '
x-mcp:
  transport:
  - stdio
  - http
  orchestration: code
  endpoint_tools: hidden