Contents
On this page

List Subscriptions - Plugixa Stream

GET /plugixa-stream/v1/admin/subscriptions

The 100 most recently changed VIP subscriptions.

Needs a user with the plugixa_stream_manage_settings capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.

Request

GET https://your-site.example/wp-json/plugixa-stream/v1/admin/subscriptions

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": "12",
      "user_id": "7",
      "plan_id": "vip-month",
      "gateway": "stripe",
      "gateway_ref": "sub_1Q2w3e4r",
      "status": "active",
      "current_period_end": "2026-12-16 19:03:40",
      "cancel_at_period_end": "0",
      "created_at": "2026-11-16 19:03:40",
      "updated_at": "2026-11-16 19:03:41",
      "user": "Maya Lindqvist"
    }
  ]
}
Field Type Meaning
data[].plan_id string The VIP plan
data[].gateway string stripe or paypal. gateway_ref is the gateway’s subscription id
data[].status string As the gateway reports it. active, trialing and past_due count as VIP until current_period_end
data[].current_period_end string|null UTC, Y-m-d H:i:s
data[].cancel_at_period_end string 1 when it will not renew
data[].user string The subscriber’s display name, or # and their id

The rows come as the database stores them: every value, numbers included, is a string.

Errors

Status Code When
401 / 403 plugixa_stream_forbidden The caller lacks the capability.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/subscriptions" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/subscriptions');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/subscriptions', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share