openapi: 3.1.0
info:
title: Drip BillableMetrics Invoices 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: Invoices
description: Generate, issue, and manage invoices. Supports usage-based and subscription-based billing periods.
paths:
/v1/invoices/generate:
post:
operationId: generateInvoice
summary: Generate invoice from charges
tags:
- Invoices
description: "\nGenerate an invoice from charges within a billing period.\nAutomatically aggregates charges by usage type into line items.\n\nThe invoice is created in DRAFT status. Use the issue endpoint to finalize it.\n "
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- periodStart
- periodEnd
properties:
customerId:
type: string
description: Customer ID to generate invoice for
periodStart:
type: string
format: date-time
description: Start of billing period (ISO 8601)
periodEnd:
type: string
format: date-time
description: End of billing period (ISO 8601)
dueDate:
type: string
format: date-time
description: Payment due date (ISO 8601)
includeSettledOnly:
type: boolean
default: false
description: Only include settled (confirmed) charges
notes:
type: string
maxLength: 2000
description: Internal notes (not visible to customer)
customerNotes:
type: string
maxLength: 2000
description: Notes visible to customer on invoice
responses:
'201':
description: Invoice generated successfully
content:
application/json:
schema:
description: Invoice generated successfully
type: object
properties:
id:
type: string
invoiceNumber:
type: string
customerId:
type: string
periodStart:
type: string
periodEnd:
type: string
totalUsdc:
type: string
status:
type: string
lineItems:
type: array
items:
type: object
properties:
id:
type: string
description:
type: string
usageType:
type: string
quantity:
type: string
unitPrice:
type: string
amountUsdc:
type: string
createdAt:
type: string
'400':
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
'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
'404':
description: Customer not found
content:
application/json:
schema:
description: Customer 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
/v1/invoices/generate-from-subscription:
post:
operationId: generateInvoiceFromSubscription
summary: Generate invoice from subscription
tags:
- Invoices
description: "\nGenerate an invoice for a subscription billing period.\nSupports prorated amounts for partial periods (mid-cycle starts, cancellations, upgrades/downgrades).\nOptionally includes usage charges from the same period.\n\nThe invoice is created in DRAFT status. Use the issue endpoint to finalize it.\n "
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- subscriptionId
properties:
customerId:
type: string
description: Customer ID
subscriptionId:
type: string
description: Subscription ID
periodStart:
type: string
format: date-time
description: Override period start (ISO 8601)
periodEnd:
type: string
format: date-time
description: Override period end (ISO 8601)
dueDate:
type: string
format: date-time
description: Payment due date (ISO 8601)
notes:
type: string
maxLength: 2000
customerNotes:
type: string
maxLength: 2000
includeUsageCharges:
type: boolean
default: false
description: Bundle usage charges in the same invoice
responses:
'201':
description: Invoice generated
content:
application/json:
schema:
description: Invoice generated
type: object
additionalProperties: true
'400':
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
'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
'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
/v1/invoices:
get:
operationId: listInvoices
summary: List invoices
tags:
- Invoices
description: Retrieve all invoices for your business with optional filtering.
parameters:
- schema:
type: string
in: query
name: customerId
required: false
description: Filter by customer ID
- schema:
type: string
enum:
- DRAFT
- PENDING
- PAID
- PARTIALLY_PAID
- VOIDED
- OVERDUE
in: query
name: status
required: false
description: Filter by status
- schema:
type: string
format: date-time
in: query
name: startDate
required: false
description: Filter by created date (from)
- schema:
type: string
format: date-time
in: query
name: endDate
required: false
description: Filter by created date (to)
- schema:
type: integer
minimum: 1
maximum: 100
default: 100
in: query
name: limit
required: false
- schema:
type: integer
minimum: 0
default: 0
in: query
name: offset
required: false
responses:
'200':
description: List of invoices
content:
application/json:
schema:
description: List of invoices
type: object
properties:
data:
type: array
items:
type: object
additionalProperties: true
total:
type: integer
hasMore:
type: boolean
'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
/v1/invoices/{id}:
get:
operationId: getInvoice
summary: Get invoice
tags:
- Invoices
description: Retrieve a specific invoice by ID.
parameters:
- schema:
type: string
in: path
name: id
required: true
description: Invoice ID
responses:
'200':
description: Invoice details
content:
application/json:
schema:
description: Invoice details
type: object
'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
'404':
description: Invoice not found
content:
application/json:
schema:
description: Invoice 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
patch:
operationId: updateInvoice
summary: Update mutable invoice fields (DRAFT only)
tags:
- Invoices
description: Update NET terms, PO number, payment terms label, internal notes, or customer notes on a DRAFT invoice. Once issued, these fields are frozen.
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
/v1/invoices/{id}/line-items:
post:
operationId: addInvoiceLineItem
summary: Add an ad-hoc line item to a draft invoice
tags:
- Invoices
description: Append a one-off line item (setup fee, services rendered, manual adjustment) to a DRAFT invoice. Only allowed on DRAFT invoices — once issued, line items are immutable; use credit notes for corrections.
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
/v1/invoices/{id}/issue:
post:
operationId: issueInvoice
summary: Issue invoice
tags:
- Invoices
description: Finalize a draft invoice and mark it as pending payment.
parameters:
- schema:
type: string
in: path
name: id
required: true
description: Invoice ID
responses:
'200':
description: Invoice issued
content:
application/json:
schema:
description: Invoice issued
type: object
'400':
description: Invalid status
content:
application/json:
schema:
description: Invalid status
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
'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
'404':
description: Invoice not found
content:
application/json:
schema:
description: Invoice 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
/v1/invoices/{id}/paid:
post:
operationId: markInvoicePaid
summary: Mark invoice as paid
tags:
- Invoices
description: "\nMark an invoice as paid. If amount is not provided, the full remaining balance is marked as paid.\nPartial payments can be recorded by specifying an amount.\n "
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: string
description: Amount paid in USDC (optional, defaults to full balance)
force:
type: boolean
description: Override payment terms enforcement (requires OWNER role)
parameters:
- schema:
type: string
in: path
name: id
required: true
description: Invoice ID
responses:
'200':
description: Invoice marked as paid
content:
application/json:
schema:
description: Invoice marked as paid
type: object
'400':
description: Invalid status or amount
content:
application/json:
schema:
description: Invalid status or amount
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
'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
'404':
description: Invoice not found
content:
application/json:
schema:
description: Invoice not found
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Error code
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/openapi/drippay-invoices-api-openapi.yml