BTCPay Server

BTCPay Server Subscriptions API

Subscription operations

GitHub OpenAPI

Operations 19

GET /api/v1/stores/{storeId}/offerings/{offeringId} Get an offering #
PUT /api/v1/stores/{storeId}/offerings/{offeringId} Update an offering #
GET /api/v1/stores/{storeId}/offerings List offerings for a store #
POST /api/v1/stores/{storeId}/offerings Create an offering #
POST /api/v1/stores/{storeId}/offerings/{offeringId}/plans Create an offering plan #
GET /api/v1/stores/{storeId}/offerings/{offeringId}/plans/{planId} Get an offering plan #
PUT /api/v1/stores/{storeId}/offerings/{offeringId}/plans/{planId} Update an offering plan #
GET /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector} Get a subscriber #
DELETE /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector} Delete a subscriber #
GET /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector}/credits/{currency} Get subscriber credit balance #
POST /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector}/credits/{currency} Update subscriber credit balance #
POST /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector}/suspend Suspend a subscriber #
POST /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector}/unsuspend Unsuspend a subscriber #
PUT /api/v1/stores/{storeId}/offerings/{offeringId}/subscribers/{customerSelector}/dates Update subscriber dates #
GET /api/v1/plan-checkout/{checkoutId} Get a plan checkout #
POST /api/v1/plan-checkout/{checkoutId} Proceed with a plan checkout #
POST /api/v1/plan-checkout Create a plan checkout session #
POST /api/v1/subscriber-portal Create a subscriber portal session #
GET /api/v1/subscriber-portal/{portalSessionId} Get a subscriber portal session #

Documentation

📖
Documentation
https://docs.btcpayserver.org/API/Greenfield/v1/
📖
Authentication
https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml

Specifications

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

SDKs

📦
GitHubRepository
https://github.com/btcpayserver/btcpayserver

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.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/btcpay-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

btcpay-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BTCPay Greenfield Subscriptions API
  version: v1
  description: '# Introduction


    The BTCPay Server Greenfield API is a REST API.'
  contact:
    name: BTCPay Server
    url: https://btcpayserver.org
  license:
    name: MIT
    url: https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE
servers:
- url: https://{btcpay-host}
  description: Your BTCPay Server instance
  variables:
    btcpay-host:
      default: mainnet.demo.btcpayserver.org
      description: The hostname of your BTCPay Server instance
security:
- API_Key: []
  Basic: []
tags:


# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/openapi/btcpay-subscriptions-api-openapi.yml