Drippay

Drippay Subscriptions API

Recurring billing and subscription lifecycle management.

GitHub OpenAPI
Business capability
Subscription Lifecycle Management BC-4240

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/subscriptions Create a recurring subscription · Create a subscription #
Ask an LLM
“How do I start charging a customer a recurring monthly fee in USDC?”
“Can a subscription include a free trial and some included usage?”
Tell an agent
Subscribe customer {customerId} to {name} at {priceUsdc} USDC every {interval}.
Create {name} for {customerId}, {priceUsdc} per {interval}, with a {trialDays}-day trial.
GET /v1/subscriptions List subscriptions · List subscriptions #
Ask an LLM
“Which subscriptions does a customer have?”
“Can I list only paused or cancelled subscriptions?”
Tell an agent
List subscriptions for customer {customerId}.
Show {limit} subscriptions with status {status}.
GET /v1/subscriptions/{id} Get a subscription · Get a subscription #
Ask an LLM
“What price and billing period is a subscription on?”
“Can I look up one subscription's details?”
Tell an agent
Show subscription {id}.
Get the details of subscription {id}.
PATCH /v1/subscriptions/{id} Update a subscription · Update a subscription #
Ask an LLM
“When does a subscription price change take effect?”
“Can I change the included usage on an existing subscription?”
Tell an agent
Change subscription {id} to {priceUsdc} USDC from next period.
Set included usage on subscription {id} to {includedUsage}.
POST /v1/subscriptions/{id}/cancel Cancel a subscription · Cancel a subscription #
Ask an LLM
“Does cancelling a subscription stop it immediately or at period end?”
“How do I cancel a customer's subscription right away?”
Tell an agent destructive · confirm first
Cancel subscription {id} at the end of the period.
Cancel subscription {id} immediately ({immediate}).
POST /v1/subscriptions/{id}/pause Pause a subscription · Pause a subscription #
Ask an LLM
“Can I pause a subscription so no charges are made for a while?”
“Is it possible to set a date for a paused subscription to resume?”
Tell an agent
Pause subscription {id}.
Pause subscription {id} until {resumeDate}.
POST /v1/subscriptions/{id}/resume Resume a paused subscription · Resume a subscription #
Ask an LLM
“How do I restart billing on a paused subscription?”
“Does resuming a subscription start a new billing period?”
Tell an agent
Resume subscription {id}.
Unpause subscription {id} now.

Documentation

📖
Documentation
https://docs.usedrip.ai/
📖
APIReference
https://docs.usedrip.ai/api-reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/authentication/drippay-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/openapi/drippay-subscriptions-api-openapi.yml

Other Resources

🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/conventions/drippay-conventions.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/conventions/drippay-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/errors/drippay-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/data-model/drippay-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/asyncapi/drippay-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/conformance/drippay-conformance.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/drippay/refs/heads/main/agentic-access/drippay-agentic-access.yml

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/drippay:drippay-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

drippay-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Drip Subscriptions API
  description: '# Drip API


    **Usage-based billing + execution ledger.**


    ---


    ## 60-Second Quickstart (Core SDK)


    ### 1.'
  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: Subscriptions
  description: Recurring billing and subscription lifecycle management.
paths:
  /v1/subscriptions:
    post:
      operationId: createSubscription
      summary: Create a subscription
      tags:
      - Subscriptions
      description: Create a recurring billing subscription for a customer.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - customerId
              - name
              - interval
              - priceUsdc
              properties:
                customerId:
                  type: string
                  description: Customer ID
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: Subscription name
                description:
                  type: string
                  maxLength: 1000
                  description: Optional description
                interval:
                  type: string
                  enum:
                  - DAILY
                  - WEEKLY
                  - MONTHLY
                  - ANNUAL
                  description: Billing interval
                priceUsdc:
                  type: number
                  exclusiveMinimum: 0
                  description: Price per interval in USDC
                metadata:
                  type: object
                  description: Custom metadata
                trialDays:
                  type: integer
                  minimum: 1
                  maximum: 365
                  description: Trial period in days (1-365)
                includedUsage:
                  type: integer
                  description: Included usage units per period
                overageUnitType:
                  type: string
                  description: Usage type for overage metering
      responses:
        '201':
          description: Subscription created
          content:
            application/json:
              schema:
                description: Subscription created
                type: object
                additionalProperties: true
        '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
        '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
    get:
      operationId: listSubscriptions
      summary: List subscriptions
      tags:
      - Subscriptions
      description: List all subscriptions for your business.
      parameters:
      - schema:
          type: string
        in: query
        name: customerId
        required: false
        description: Filter by customer ID
      - schema:
          type: string
          enum:
          - ACTIVE
          - PAUSED
          - CANCELLED
          - EXPIRED
          - PAST_DUE
          - TRIALING
        in: query
        name: status
        required: false
        description: Filter by status
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 100
        in: query
        name: limit
        required: false
        description: Maximum results
      responses:
        '200':
          description: List of subscriptions
          content:
            application/json:
              schema:
                description: List of subscriptions
                type: object
                additionalProperties: true
        '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/subscriptions/{id}:
    get:
      operationId: getSubscription
      summary: Get a subscription
      tags:
      - Subscriptions
      description: Get details for a specific subscription.
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
        description: Subscription ID
      responses:
        '200':
          description: Subscription details
          content:
            application/json:
              schema:
                description: Subscription details
                type: object
                additionalProperties: true
        '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: Subscription not found
          content:
            application/json:
              schema:
                description: Subscription 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: updateSubscription
      summary: Update a subscription
      tags:
      - Subscriptions
      description: Update a subscription. Price changes take effect at the next billing period.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                priceUsdc:
                  type: number
                metadata:
                  type: object
                includedUsage:
                  type: integer
                overageUnitType:
                  type: string
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
        description: Subscription ID
      responses:
        '200':
          description: Updated subscription
          content:
            application/json:
              schema:
                description: Updated subscription
                type: object
                additionalProperties: true
        '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: Subscription not found
          content:
            application/json:
              schema:
                description: Subscription 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
  /v1/subscriptions/{id}/cancel:
    post:
      operationId: cancelSubscription
      summary: Cancel a subscription
      tags:
      - Subscriptions
      description: Cancel a subscription. By default, cancels at the end of the current billing period.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                immediate:
                  type: boolean
                  default: false
                  description: Cancel immediately instead of at period end
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
        description: Subscription ID
      responses:
        '200':
          description: Subscription cancelled
          content:
            application/json:
              schema:
                description: Subscription cancelled
                type: object
                additionalProperties: true
        '400':
          description: Invalid state
          content:
            application/json:
              schema:
                description: Invalid state
                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: Subscription not found
          content:
            application/json:
              schema:
                description: Subscription 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/subscriptions/{id}/pause:
    post:
      operationId: pauseSubscription
      summary: Pause a subscription
      tags:
      - Subscriptions
      description: Pause an active subscription. No charges will be created while paused.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                resumeDate:
                  type: string
                  format: date-time
                  description: Auto-resume date (optional)
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
        description: Subscription ID
      responses:
        '200':
          description: Subscription paused
          content:
            application/json:
              schema:
                description: Subscription paused
                type: object
                additionalProperties: true
        '400':
          description: Invalid state
          content:
            application/json:
              schema:
                description: Invalid state
                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: Subscription not found
          content:
            application/json:
              schema:
                description: Subscription 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/subscriptions/{id}/resume:
    post:
      operationId: resumeSubscription
      summary: Resume a subscription
      tags:
      - Subscriptions
      description: Resume a paused subscription. Starts a new billing period.
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
        description: Subscription ID
      responses:
        '200':
          description: Subscription resumed
          content:
            application/json:
              schema:
                description: Subscription resumed
                type: object
                additionalProperties: true
        '400':
          description: Invalid state
          content:
            application/json:
              schema:
                description: Invalid state
                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: Subscription not found
          content:
            application/json:
              schema:
                description: Subscription 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
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API key from Drip Dashboard. Format: `sk_live_...` or `sk_test_...`'