Developers

WPSubscription Developer Hub

Every API spec, auth guide, and agent-readable resource WPSubscription publishes — at stable, predictable URLs.

REST API

One Endpoint, Eight Actions

WPSubscription exposes a single POST endpoint for the whole subscription lifecycle. It runs on your own WordPress site — wpsubscription.co publishes the spec and documentation only.

Endpoint

POST https://{site}/wp-json/wpsubscription/v1/action

Authentication

Site-scoped API key in the JSON request body (api_key), generated in WP Admin → WPSubscription → Settings → API Settings. No OAuth, no dynamic client registration.

Supported actions

cancel_subscription
pause_subscription
resume_subscription
reactivate_subscription
expire_subscription
change_status
trial_end
payment_failed

Machine-Readable

Agent & Integration Resources

Point your client, crawler, or coding agent at any of these. All are served from the apex domain and are safe to fetch unauthenticated.

OpenAPI 3.1

OpenAPI Specification

Full request and response schemas for the subscription API, including typed error codes and scoped permissions.

/.well-known/openapi.jsonMarkdown

Authentication Guide

How API keys are issued and scoped, what each key can and cannot reach, plus error shapes and rate-limit behaviour.

/auth.mdMCP server card

MCP Server Card

Read-only MCP server at /mcp answering pricing, feature, gateway, and API questions. No credentials required.

/.well-known/mcp/server-card.jsonAgent Skills

Agent Skills Index

Discovery index for the wpsubscription-api skill, with a digest so clients can verify what they downloaded.

/.well-known/agent-skills/index.jsonARD catalog

AI Resource Catalog

Agentic Resource Discovery catalog listing every agent-facing resource on this domain in one fetch.

/.well-known/ai-catalog.jsonRFC 9727

API Catalog

RFC 9727 linkset tying the API to its machine description and its human documentation.

/.well-known/api-catalogllms.txt

llms.txt

Curated map of the site for language models — key pages, use cases, developer resources, and notable posts.

/llms.txtMarkdown

Design System

Colour tokens, typography, spacing, and component patterns for building in the WPSubscription visual style.

/design.md

Documentation

Guides, Releases, and Support

Prose documentation for the people behind the integration.

Full Documentation

Setup, configuration, and feature guides for the plugin.

REST API Guide

Worked examples of every subscription action, end to end.

Changelog

Release history for the free and Pro editions, with deprecation notices.

Developer Support

Reach the team when the spec does not answer your question.

Developer FAQ

Where does the WPSubscription API actually run?

On your own WordPress site, at https://your-site.com/wp-json/wpsubscription/v1/action. The wpsubscription.co domain hosts the specification, the auth guide, and the documentation — it never processes subscription requests, so there is no shared endpoint or tenant to authenticate against.

How do I authenticate against the WPSubscription REST API?

Send a site-scoped API key in the api_key field of the JSON request body. The site owner generates it in WP Admin → WPSubscription → Settings → API Settings and can regenerate it at any time. A key is valid only for the site that issued it and only for the subscription lifecycle actions listed in the spec — it grants no access to WordPress users, content, orders, or admin functions.

Does WPSubscription have an MCP server?

Yes. A read-only Streamable HTTP MCP server runs at https://wpsubscription.co/mcp, described by a server card at /.well-known/mcp/server-card.json. It answers product questions — pricing, features, supported gateways, free versus Pro, and an API overview — and needs no credentials. Subscription data itself stays on your WordPress site and is reached through the REST API instead.

Are there rate limits on the API?

The plugin does not throttle requests, but the WordPress host or its WAF or CDN commonly rate-limits wp-json traffic. Treat any 429 as authoritative, honour its Retry-After header, and self-throttle to roughly one request per second per site as a courtesy default.

How is the API versioned?

The version lives in the URL path, under /wp-json/wpsubscription/v1/. Breaking changes ship only under a new version namespace; v1 request and response shapes stay stable, and only additive changes such as new actions or new optional fields land in v1. Deprecations are announced on the changelog before anything is removed.