# storeengine/2.2.0/includes/api/me-subscriptions.php

StoreEngine — Complete eCommerce Solution with Memberships, Licensing, Affiliates & More, version 2.2.0. 204 lines.

- Page: https://pluginprobe.com/plugins/storeengine/2.2.0/code/includes/api/me-subscriptions.php
- Raw: https://pluginprobe.com/plugins/storeengine/2.2.0/raw/includes/api/me-subscriptions.php
- Modified: 2026-05-26T15:51:46+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/storeengine/2.2.0/code/includes/api/me-subscriptions.php#L10-L20`.

```php
<?php
/**
 * Current-user-scoped subscriptions endpoints for the headless customer dashboard.
 *
 * @package StoreEngine\API
 */

namespace StoreEngine\API;

use StoreEngine\Addons\Subscription\Classes\Subscription;
use StoreEngine\Addons\Subscription\Classes\SubscriptionCollection;
use StoreEngine\Classes\Exceptions\StoreEngineException;
use StoreEngine\Utils\Helper;
use WP_Error;
use WP_REST_Request;
use WP_REST_Response;
use WP_REST_Server;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

class MeSubscriptions extends AbstractRestApiController {

	protected $rest_base = 'me/subscriptions';

	public static function init() {
		if ( ! class_exists( SubscriptionCollection::class ) ) {
			return;
		}

		$self = new self();
		add_action( 'rest_api_init', [ $self, 'register_routes' ] );
		add_filter( 'storeengine/rest/me/menu_items', [ $self, 'add_menu_item' ] );
	}

	public function register_routes() {
		register_rest_route( $this->namespace, '/' . $this->rest_base, [
			'methods'             => WP_REST_Server::READABLE,
			'callback'            => [ $this, 'list_subscriptions' ],
			'permission_callback' => [ $this, 'permission_check' ],
			'args'                => [
				'page'     => [ 'type' => 'integer', 'default' => 1 ],
				'per_page' => [ 'type' => 'integer', 'default' => 10 ],
				'status'   => [ 'type' => 'string' ],
			],
		] );

		register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', [
			'args'                => [ 'id' => [ 'type' => 'integer' ] ],
			'methods'             => WP_REST_Server::READABLE,
			'callback'            => [ $this, 'get_subscription' ],
			'permission_callback' => [ $this, 'permission_check' ],
		] );

		foreach ( [ 'cancel', 'pause', 'resume' ] as $action ) {
			register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)/' . $action, [
				'args'                => [ 'id' => [ 'type' => 'integer' ] ],
				'methods'             => WP_REST_Server::CREATABLE,
				'callback'            => [ $this, $action . '_subscription' ],
				'permission_callback' => [ $this, 'permission_check' ],
			] );
		}
	}

	public function permission_check() {
		if ( ! is_user_logged_in() ) {
			return new WP_Error( 'storeengine_rest_not_logged_in', __( 'You must be logged in.', 'storeengine' ), [ 'status' => 401 ] );
		}

		return true;
	}

	public function add_menu_item( array $items ): array {
		$items[] = [
			'slug'  => 'subscriptions',
			'route' => 'subscriptions',
			'label' => __( 'Subscriptions', 'storeengine' ),
			'icon'  => 'refresh',
			'order' => 15,
		];

		return $items;
	}

	public function list_subscriptions( WP_REST_Request $request ) {
		$user_id  = get_current_user_id();
		$page     = max( 1, (int) $request->get_param( 'page' ) );
		$per_page = min( 100, max( 1, (int) $request->get_param( 'per_page' ) ) );
		$status   = $request->get_param( 'status' );

		$where = [
			'relation' => 'AND',
			[ 'key' => 'type', 'value' => 'subscription' ],
			[ 'key' => 'customer_id', 'value' => $user_id, 'type' => 'NUMERIC' ],
		];

		if ( $status ) {
			$where[] = [ 'key' => 'status', 'value' => $status ];
		}

		$query = new SubscriptionCollection( [
			'per_page' => $per_page,
			'page'     => $page,
			'where'    => $where,
		] );

		$data = [];
		foreach ( $query->get_results() as $sub ) {
			$data[] = $this->format_subscription( $sub );
		}

		return $this->prepare_query_response( $data, $query, $request );
	}

	public function get_subscription( WP_REST_Request $request ) {
		$sub = $this->load_owned( (int) $request->get_param( 'id' ) );
		if ( is_wp_error( $sub ) ) {
			return $sub;
		}

		return rest_ensure_response( $this->format_subscription( $sub, true ) );
	}

	public function cancel_subscription( WP_REST_Request $request ) {
		return $this->change_status( $request, 'pending_cancel', __( 'Cancelled by customer.', 'storeengine' ) );
	}

	public function pause_subscription( WP_REST_Request $request ) {
		return $this->change_status( $request, 'on_hold', __( 'Paused by customer.', 'storeengine' ) );
	}

	public function resume_subscription( WP_REST_Request $request ) {
		return $this->change_status( $request, 'active', __( 'Resumed by customer.', 'storeengine' ) );
	}

	protected function change_status( WP_REST_Request $request, string $new_status, string $note ) {
		$sub = $this->load_owned( (int) $request->get_param( 'id' ) );
		if ( is_wp_error( $sub ) ) {
			return $sub;
		}

		try {
			$sub->update_status( $new_status, $note );
		} catch ( StoreEngineException $e ) {
			return new WP_Error( 'storeengine_rest_status_failed', $e->getMessage(), [ 'status' => 500 ] );
		}

		return rest_ensure_response( $this->format_subscription( $sub, true ) );
	}

	/**
	 * @return Subscription|WP_Error
	 */
	protected function load_owned( int $id ) {
		if ( $id <= 0 ) {
			return new WP_Error( 'storeengine_rest_invalid_id', __( 'Invalid subscription id.', 'storeengine' ), [ 'status' => 400 ] );
		}

		try {
			$sub = new Subscription( $id );
		} catch ( \Throwable $e ) {
			return new WP_Error( 'storeengine_rest_subscription_not_found', __( 'Subscription not found.', 'storeengine' ), [ 'status' => 404 ] );
		}

		if ( ! $sub->get_id() || (int) $sub->get_customer_id() !== get_current_user_id() ) {
			return new WP_Error( 'storeengine_rest_subscription_not_found', __( 'Subscription not found.', 'storeengine' ), [ 'status' => 404 ] );
		}

		return $sub;
	}

	protected function format_subscription( Subscription $sub, bool $detailed = false ): array {
		$data = [
			'id'                => $sub->get_id(),
			'status'            => $sub->get_status(),
			'total'             => (float) $sub->get_total_amount(),
			'currency'          => $sub->get_currency(),
			'billing_period'    => $sub->get_payment_duration_type(),
			'billing_interval'  => (int) $sub->get_payment_duration(),
			'start_date'        => $this->date_as_string( $sub->get_start_date() ),
			'next_payment_date' => $this->date_as_string( $sub->get_next_payment_date() ),
			'last_payment_date' => $this->date_as_string( $sub->get_last_payment_date() ),
			'end_date'          => $this->date_as_string( $sub->get_end_date() ),
			'trial'             => (bool) $sub->get_trial(),
			'trial_end_date'    => $this->date_as_string( $sub->get_trial_end_date() ),
			'payment_method'    => $sub->get_payment_method_to_display(),
			'parent_order_id'   => $sub->get_initial_order_id(),
		];

		if ( $detailed ) {
			$data['related_order_ids'] = $sub->get_related_order_ids( 'any' );
			$data['suspension_count']  = (int) $sub->get_suspension_count();
			$billing                   = $sub->get_address( 'billing' );
			$shipping                  = $sub->get_address( 'shipping' );
			unset( $billing['address_type'], $shipping['address_type'] );
			$data['billing_address']  = $billing;
			$data['shipping_address'] = $shipping;
		}

		return $data;
	}
}

```