Contents
On this page

List Orders - Plugixa Stream

GET /plugixa-stream/v1/admin/orders

Every order, newest first: the Orders screen.

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/orders?status=paid

Query parameters

Field Type Required Description
status string No pending, paid, failed, refunded or expired.
page integer No Page to return, from 1.
per_page integer No Rows, clamped to 1 to 100. Defaults to 24.

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": "41",
      "user_id": "7",
      "gateway": "stripe",
      "gateway_ref": "cs_test_a1B2c3D4",
      "payment_ref": "pi_3Q1x2y3z",
      "product": "pack",
      "product_id": "p300",
      "amount": "1499",
      "currency": "USD",
      "coins": "300",
      "bonus_coins": "30",
      "coupon": "",
      "discount": "0",
      "trial_days": "0",
      "status": "paid",
      "created_at": "2026-11-16 19:02:11",
      "paid_at": "2026-11-16 19:03:40",
      "user": "Maya Lindqvist"
    }
  ]
}
Field Type Meaning
data[].id string The order’s id
data[].user_id string The buyer
data[].gateway string stripe or paypal
data[].gateway_ref string The checkout the gateway opened (a Stripe session, a PayPal order or subscription)
data[].payment_ref string The payment the gateway took
data[].product string pack or vip
data[].product_id string The pack or plan id
data[].amount string Charged, in minor units (1499 is 14.99); 0 for a free trial start
data[].currency string Three letters
data[].coins string Coins the pack credits. Also bonus_coins
data[].coupon string The promo code used, or empty. discount is what it took off, in minor units
data[].trial_days string Free days a VIP plan started with
data[].status string pending, paid, failed, refunded or expired
data[].created_at string UTC, Y-m-d H:i:s. Also paid_at, null until paid
data[].user string The buyer’s display name, or # and their id

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

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/orders?status=paid" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/orders?status=paid');
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/orders?status=paid', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share