openapi: 3.1.0
info:
title: Drip BillableMetrics Integrations API
description: "\n# Drip API\n\n**Usage-based billing + execution ledger.**\n\n---\n\n## 60-Second Quickstart (Core SDK)\n\n### 1. Install\n\n```bash\nnpm install @drip-sdk/node\n```\n\n### 2. Set your API key\n\n```bash\n# Secret key - full API access (server-side only, never expose publicly)\nexport DRIP_API_KEY=sk_test_...\n\n# Use a secret key for the customer, billing, runs, pricing-plan, and webhook\n# flows documented in this reference.\n```\n\nOr use a \".env\" file (recommended):\n\n```bash\nnpm install dotenv\n# .env\nDRIP_API_KEY=sk_test_...\n```\n\nLoad your \".env\" at the top of your entry file:\n\n```typescript\nimport 'dotenv/config';\n```\n\n### 3. Create a customer and track usage\n\n```typescript\nimport 'dotenv/config';\nimport { drip } from '@drip-sdk/node';\n\n// Create a customer first\nconst customer = await drip.createCustomer({ externalCustomerId: 'user_123' });\n\n// Internal tracking only (no billing)\nawait drip.trackUsage({ customerId: customer.id, meter: 'api_calls', quantity: 1 });\n```\n\nThe `drip` singleton reads `DRIP_API_KEY` from your environment automatically.\n\n### Alternative: Explicit Configuration\n\n```typescript\nimport 'dotenv/config';\nimport { Drip } from '@drip-sdk/node';\n\n// Auto-reads DRIP_API_KEY from environment\nconst client = new Drip();\n\n// Or pass config explicitly with an Admin/Operator secret key\nconst clientWithSecret = new Drip({ apiKey: 'sk_test_...' });\n```\n\n### Full Example (Node.js)\n\n```typescript\nimport 'dotenv/config';\nimport { drip } from '@drip-sdk/node';\n\nasync function main() {\n // Verify connectivity\n await drip.ping();\n\n // Create a customer (at least one of externalCustomerId or onchainAddress required)\n const customer = await drip.createCustomer({ externalCustomerId: 'user_123' });\n\n // Internal tracking (no billing)\n await drip.trackUsage({\n customerId: customer.id,\n meter: 'llm_tokens',\n quantity: 842,\n metadata: { model: 'gpt-4o-mini' },\n });\n\n // Billable usage\n await drip.charge({\n customerId: customer.id,\n meter: 'api_calls',\n quantity: 1,\n });\n\n // Record an execution lifecycle\n await drip.recordRun({\n customerId: customer.id,\n workflow: 'research-agent',\n events: [\n { eventType: 'llm.call', quantity: 1700, units: 'tokens' },\n { eventType: 'tool.call', quantity: 1 },\n ],\n status: 'COMPLETED',\n });\n\n console.log(`Customer ${customer.id}: usage + run recorded`);\n}\n\nmain();\n```\n\n```python\nfrom drip import drip\n\n# Create a customer first\ncustomer = drip.create_customer(external_customer_id=\"user_123\")\n\n# Internal tracking only (no billing)\ndrip.track_usage(customer_id=customer.id, meter=\"api_calls\", quantity=1)\n```\n\nThe `drip` singleton reads `DRIP_API_KEY` from your environment automatically.\n\n### Alternative: Explicit Configuration (Python)\n\n```python\nfrom drip import Drip\n\n# Auto-reads DRIP_API_KEY from environment\nclient = Drip()\n\n# Or pass config explicitly with an Admin/Operator secret key\nclient_with_secret = Drip(api_key=\"sk_test_...\")\n```\n\n### Full Example (Python)\n\n```python\nfrom drip import drip\n\n# Verify connectivity\ndrip.ping()\n\n# Create a customer (at least one of external_customer_id or onchain_address required)\ncustomer = drip.create_customer(external_customer_id=\"user_123\")\n\n# Internal tracking (no billing)\ndrip.track_usage(\n customer_id=customer.id,\n meter=\"llm_tokens\",\n quantity=842,\n metadata={\"model\": \"gpt-4o-mini\"}\n)\n\n# Billable usage\ndrip.charge(\n customer_id=customer.id,\n meter=\"api_calls\",\n quantity=1\n)\n\n# Record execution lifecycle\ndrip.record_run(\n customer_id=customer.id,\n workflow=\"research-agent\",\n events=[\n {\"event_type\": \"llm.call\", \"quantity\": 1700, \"units\": \"tokens\"},\n {\"event_type\": \"tool.call\", \"quantity\": 1},\n ],\n status=\"COMPLETED\"\n)\n\nprint(f\"Customer {customer.id}: usage + run recorded\")\n```\n\n**Expected result:**\n- No errors\n- Events appear in your Drip dashboard within seconds\n\n**Install:** `npm install @drip-sdk/node` or `pip install drip-sdk`\n\n**Set API key:** `export DRIP_API_KEY=sk_test_...` or use a \".env\" file with `DRIP_API_KEY=sk_test_...` and load it with `import 'dotenv/config'` (for Node.js)\n\n---\n\n## REST API Quick Start\n\n### Step 1: Create a customer\n\n```bash\ncurl -X POST https://api.drippay.dev/v1/customers \\\n -H \"Authorization: Bearer sk_test_YOUR_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"externalCustomerId\": \"user_123\"}'\n```\n\n**You'll get back:**\n```json\n{\n \"id\": \"cmlxxxxxx...\",\n \"externalCustomerId\": \"user_123\",\n \"status\": \"ACTIVE\"\n}\n```\n\n### Step 2: Create pricing\n\nUse the same meter string in your pricing plan and your usage calls:\n\n```bash\ncurl -X POST https://api.drippay.dev/v1/pricing-plans \\\n -H \"Authorization: Bearer sk_test_YOUR_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"API Calls\",\n \"unitType\": \"api_calls\",\n \"unitPriceUsd\": 0.001\n }'\n```\n\n### Step 3: Charge usage\n\n```bash\ncurl -X POST https://api.drippay.dev/v1/usage \\\n -H \"Authorization: Bearer sk_test_YOUR_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"CUSTOMER_ID_FROM_STEP_1\",\n \"usageType\": \"api_calls\",\n \"quantity\": 100,\n \"idempotencyKey\": \"charge_001\"\n }'\n```\n\n---\n\n## SDK Methods\n\n### Node.js (`@drip-sdk/node`)\n\n| Method | Description |\n|--------|-------------|\n| `createCustomer()` | Create a customer |\n| `getCustomer()` | Get customer details |\n| `listCustomers()` | List all customers |\n| `trackUsage()` | Record internal usage without billing |\n| `charge()` | Record usage and charge (requires pricing plan) |\n| `emitEvent()` | Record an execution event |\n| `recordRun()` | Record a complete agent run |\n| `startRun()` | Start a run |\n| `endRun()` | End a run |\n| `getBalance()` | Get customer balance |\n\n### Python (`drip-sdk`)\n\n| Method | Description |\n|--------|-------------|\n| `create_customer()` | Create a customer |\n| `get_customer()` | Get customer details |\n| `list_customers()` | List all customers |\n| `track_usage()` | Record internal usage without billing |\n| `charge()` | Record usage and charge (requires pricing plan) |\n| `emit_event()` | Record an execution event |\n| `record_run()` | Record a complete agent run |\n| `start_run()` | Start a run |\n| `end_run()` | End a run |\n| `get_balance()` | Get customer balance |\n\n---\n\n## Two Modes\n\n| Mode | How | When |\n|------|-----|------|\n| **Tracking only** | `trackUsage()` / `track_usage()` | Pilots, analytics, no billing yet |\n| **Billing** | `charge()` + pricing plan | Ready to charge customers |\n\nBoth modes record usage in the ledger. The difference is whether a charge is created.\n\nUse `POST /v1/usage/internal` when you want tracking only.\n\n---\n\n## Authentication\n\n```\nAuthorization: Bearer sk_test_YOUR_KEY\n```\n\n### Key Types\n\n| Key Prefix | Use For |\n|------------|---------|\n| `sk_test_*` / `sk_live_*` | Server-side API access (secret key) |\n| `pk_test_*` / `pk_live_*` | Public key identifier. The role-protected endpoints in this reference require a secret key |\n\n### API Key Roles\n\nSecret keys (`sk_*`) are assigned a role that controls which endpoints they can access. Roles are hierarchical: higher roles include all permissions of lower roles.\n\n| Role | Level | Permissions |\n|------|-------|-------------|\n| `READONLY` | Lowest | List and read resources (customers, charges, pricing plans, events) |\n| `OPERATOR` | Mid | + Create customers, charge usage, track internal usage, emit events, manage runs |\n| `ADMIN` | Highest | + Create/update/delete pricing plans, manage contracts, manage API keys |\n\nPublic keys (`pk_*`) are always `READONLY`: they cannot create or modify resources.\n\n> **Important:** To create, update, or delete **pricing plans** and **contracts**, you must use a secret key (`sk_*`) with the **ADMIN** role. Using a lower-role key returns `403 Forbidden`.\n\n---\n\n## Idempotency\n\nAlways include `idempotencyKey` in POST requests to prevent duplicates:\n\n```json\n{\n \"customerId\": \"cmlxxxxxx...\",\n \"usageType\": \"api_calls\",\n \"quantity\": 1,\n \"idempotencyKey\": \"req_unique_12345\"\n}\n```\n\nSame key = same result. Safe to retry on network failures.\n\n---\n\n## Error Codes\n\n| Status | Meaning | Fix |\n|--------|---------|-----|\n| **400** | Bad request | Check request body matches schema |\n| **401** | Invalid API key | Verify `Authorization: Bearer sk_...` header |\n| **404** | Not found | Customer/pricing plan doesn't exist. Create customer first. |\n| **409** | Duplicate | Resource with this ID already exists |\n| **422** | Validation error | Check required fields and types |\n\n---\n\n## Important Notes\n\n- **Always create a customer first** for billable onboarding flows. You cannot use made-up customer IDs.\n- **`POST /v1/events`** records execution events (what happened). It does **not** auto-create charges.\n- **`POST /v1/usage`** records usage and creates charges if a matching pricing plan exists.\n- **`POST /v1/usage/internal`** records usage without billing.\n- **Numbers as strings**: Monetary amounts are returned as strings (e.g., `\"0.001000\"`) to preserve precision.\n"
version: 1.0.0
contact:
name: Drip Support
email: support@drippay.dev
x-logo:
url: https://drippay.dev/logo.svg
altText: Drip
servers:
- url: https://api.drippay.dev
description: Production
- url: http://localhost:3001
description: Development
security:
- bearerAuth: []
tags:
- name: Integrations
description: Manage billing, CRM, and marketplace integrations (Stripe, Xero, Salesforce).
paths:
/v1/webhooks/salesforce/{integrationId}:
post:
operationId: salesforceWebhook
summary: Salesforce Change Data Capture webhook (HMAC-signed)
tags:
- Integrations
parameters:
- schema:
type: string
in: path
name: integrationId
required: true
responses:
'200':
description: Default Response
/v1/integrations:
get:
operationId: listIntegrations
summary: List marketplace & CRM integrations
tags:
- Integrations
responses:
'200':
description: Default Response
post:
operationId: createIntegration
summary: Create a marketplace / CRM integration
tags:
- Integrations
description: 'Create a new marketplace or CRM integration.
Supported providers:
- `AWS_MARKETPLACE` - AWS Marketplace Metering Service
- `AZURE_MARKETPLACE` - Azure Marketplace SaaS metering
- `GCP_MARKETPLACE` - GCP Cloud Commerce / Service Control
- `STRIPE` - Stripe Billing Meter Events
- `SALESFORCE` - Salesforce CRM (custom usage object)
- `METRONOME` - Metronome usage ingestion
Secret config fields are encrypted at rest and never returned on read.
> **Requires a secret key (`sk_*`) with the `ADMIN` role.**'
responses:
'200':
description: Default Response
/v1/integrations/{id}:
get:
operationId: getIntegration
summary: Get a marketplace integration
tags:
- Integrations
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
patch:
operationId: updateIntegration
summary: Update an integration (rotate secrets, toggle status)
tags:
- Integrations
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
delete:
operationId: deleteIntegration
summary: Delete an integration
tags:
- Integrations
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
/v1/integrations/{id}/test:
post:
operationId: testIntegration
summary: Test an integration connection
tags:
- Integrations
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
/v1/integrations/{id}/usage:
post:
operationId: submitIntegrationUsage
summary: Submit a metered usage record to the provider
tags:
- Integrations
description: Forwards a single metered usage record to the connected marketplace or CRM. A MarketplaceMeterSubmission row is always written as an audit trail, even if the provider call fails. Idempotency is guaranteed via the `idempotencyKey` field (auto-generated when omitted).
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
/v1/integrations/{id}/submissions:
get:
operationId: listIntegrationSubmissions
summary: List recent meter submissions
tags:
- Integrations
parameters:
- schema:
type: string
enum:
- PENDING
- SUBMITTED
- FAILED
- RETRYING
- REJECTED
in: query
name: status
required: false
- schema:
type: string
in: query
name: limit
required: false
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
/v1/integrations/stripe/test:
post:
operationId: testStripeOnboarding
summary: Validate Stripe credentials (no side effects)
tags:
- Integrations
description: Validates a Stripe secret or restricted key (and optional webhook secret) against Stripe's /v1/account endpoint. Probes tax/billing/invoicing capabilities when scoped keys are provided. Returns account metadata on success. **No database writes.** Requires a secret key with the `ADMIN` role.
responses:
'200':
description: Default Response
/v1/integrations/stripe/connect:
post:
operationId: connectStripeIntegration
summary: Connect a Stripe account via API key
tags:
- Integrations
description: 'Validates Stripe credentials, creates a `MarketplaceIntegration` row (idempotent on Stripe account ID), optionally flips `taxProvider` to `STRIPE_TAX`, and returns the webhook URL the merchant must paste into their Stripe dashboard. Retrying this endpoint with the same Stripe account returns the existing integration with `alreadyExists: true`. Requires `API_PUBLIC_BASE_URL` to be set; webhook URL has no host header fallback. **Requires a secret key with the `ADMIN` role.**'
responses:
'200':
description: Default Response
/v1/integrations/stripe/oauth/init:
post:
operationId: initStripeQuickstartOAuth
summary: Begin Stripe Connect OAuth (Quickstart mode)
tags:
- Integrations
description: Generates a Stripe Connect authorize URL and a signed state token. The frontend redirects the user's browser to `authorizeUrl`; Stripe then redirects back to `/v1/integrations/stripe/oauth/callback` where Drip exchanges the code, creates the integration, and auto-provisions the webhook endpoint. Gated on the `STRIPE_QUICKSTART_ENABLED` feature flag; returns 404 if disabled for the workspace.
responses:
'200':
description: Default Response
/v1/integrations/stripe/oauth/callback:
get:
operationId: stripeQuickstartOAuthCallback
summary: Stripe Connect OAuth redirect handler
tags:
- Integrations
description: Public redirect endpoint Stripe posts the user back to after they authorize the Connect app. Verifies the state HMAC + expiry, exchanges the code for the connected `acct_…` id, creates the integration, auto-provisions the webhook endpoint, and 302-redirects the browser to the dashboard with a `?quickstart=success|error` hint.
responses:
'200':
description: Default Response
/v1/integrations/comms/slack/install:
post:
operationId: commsSlackInstall
summary: Begin Slack OAuth (pre-call MVP)
tags:
- Integrations
responses:
'200':
description: Authorize URL issued
content:
application/json:
schema:
description: Authorize URL issued
type: object
required:
- authorizeUrl
- state
- expiresInSeconds
properties:
authorizeUrl:
type: string
format: uri
state:
type: string
expiresInSeconds:
type: integer
'401':
description: Unauthorized
content:
application/json:
schema:
description: Unauthorized
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'403':
description: Forbidden
content:
application/json:
schema:
description: Forbidden
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'404':
description: Not found
content:
application/json:
schema:
description: Not found
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'422':
description: Validation error
content:
application/json:
schema:
description: Validation error
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'429':
description: Rate limit exceeded
content:
application/json:
schema:
description: Rate limit exceeded
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'500':
description: Internal error
content:
application/json:
schema:
description: Internal error
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'503':
description: OAuth provider not configured
content:
application/json:
schema:
description: OAuth provider not configured
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
/v1/integrations/comms/slack/realtime/stream:
get:
operationId: commsSlackRealtimeStream
summary: Stream managed Slack realtime messages to desktop clients
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms/slack/events/stream:
get:
operationId: commsSlackEventsStream
summary: Stream managed Slack realtime messages to desktop clients
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms/linkedin/realtime/stream:
get:
operationId: commsLinkedInRealtimeStream
summary: Stream managed LinkedIn realtime events to desktop clients
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms/linkedin/events/stream:
get:
operationId: commsLinkedInEventsStream
summary: Stream managed LinkedIn realtime events to desktop clients
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms/linkedin/events:
post:
operationId: commsLinkedInRealtimePublish
summary: Publish local LinkedIn realtime events to desktop clients
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms/slack/callback:
get:
operationId: commsSlackCallback
summary: Slack OAuth redirect handler
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms/gmail/install:
post:
operationId: commsGmailInstall
summary: Begin Gmail OAuth (pre-call MVP)
tags:
- Integrations
responses:
'200':
description: Authorize URL issued
content:
application/json:
schema:
description: Authorize URL issued
type: object
required:
- authorizeUrl
- state
- expiresInSeconds
properties:
authorizeUrl:
type: string
format: uri
state:
type: string
expiresInSeconds:
type: integer
'401':
description: Unauthorized
content:
application/json:
schema:
description: Unauthorized
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'403':
description: Forbidden
content:
application/json:
schema:
description: Forbidden
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'404':
description: Not found
content:
application/json:
schema:
description: Not found
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'422':
description: Validation error
content:
application/json:
schema:
description: Validation error
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'429':
description: Rate limit exceeded
content:
application/json:
schema:
description: Rate limit exceeded
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'500':
description: Internal error
content:
application/json:
schema:
description: Internal error
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
'503':
description: OAuth provider not configured
content:
application/json:
schema:
description: OAuth provider not configured
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
details:
type: array
items:
type: object
properties:
path:
type: string
message:
type: string
description: Validation error details
required:
- error
- code
/v1/integrations/comms/gmail/callback:
get:
operationId: commsGmailCallback
summary: Gmail OAuth redirect handler
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms/calendar/callback:
get:
operationId: commsCalendarCallback
summary: Google Calendar OAuth redirect handler
tags:
- Integrations
responses:
'200':
description: Default Response
/v1/integrations/comms:
get:
operationId: commsList
summary: List comms integrations for the authenticated business
tags:
- Integrations
responses:
'200':
description: Integrations list
content:
application/json:
schema:
description: Integrations list
type: object
required:
- data
# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/openapi/drippay-integrations-api-openapi.yml