Subscriptions API (Admin)
The admin Subscription controller (api/subscription.php, base subscription) provides a store-wide, read-only view of subscriptions for back-office tooling. It is the admin counterpart to the customer-facing Me → Subscriptions controller (which can also mutate subscriptions the customer owns).
Subscriptions exist only when the Subscription addon is active. On a store without it, these routes are not registered.
Authentication
Admin only — Helper::check_rest_user_cap( 'manage_options' ). See Authentication.
Routes
| Method | Path | Purpose |
|---|---|---|
| GET | /subscription | List subscriptions |
| GET | /subscription/<id> | Get one subscription |
All paths are relative to /wp-json/storeengine/v1. This controller is read-only; there are no create/update/delete routes. To change a subscription's state programmatically, act on the subscription object server-side, or use the customer-scoped cancel/pause/resume routes on Me → Subscriptions.
GET /subscription
GET /wp-json/storeengine/v1/subscription
Lists all subscriptions. Uses the shared analytics-style collection parameters — pagination (page, per_page), plus date-range filtering. Emits X-WP-Total / X-WP-TotalPages.
curl "https://your-store.example/wp-json/storeengine/v1/subscription?per_page=20&page=1" \
-u "admin:APPLICATION_PASSWORD"
GET /subscription/<id>
GET /wp-json/storeengine/v1/subscription/<id>
Returns a single subscription with its billing schedule, status, related orders, and addresses. Accepts the context parameter (view default, edit).
Related
- Me → Subscriptions — customer self-service (list, cancel, pause, resume).
- Subscriptions object — the data model and status lifecycle.