# mageplaza/module-membership-graphql

> Magento 2 Membership Graphql Extension

`composer require mageplaza/module-membership-graphql`

Canonical URL: https://packagento.com/mageplaza/module-membership-graphql

## At a glance

- **Vendor**: mageplaza (https://packagento.com/mageplaza.md)
- **Latest version**: 1.0.1 — released 2022-11-14
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageplaza/module-membership-graphql and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageplaza/module-membership-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 Membership Graphql Extension

## README

**Magento 2 Membership GraphQL is a part of Mageplaza Membership extension that adds GraphQL features.** Mageplaza Magento 2 Membership GraphQL (PWA) supports getting and pushing data on the website with GraphQL, along with PWA compatibility support.

[Mageplaza Membership for Magento 2](https://www.mageplaza.com/magento-2-membership/) is an effective tool to create customer memberships on the online store that increase customer engagement and loyalty. 

With Mageplaza Membership, the store admin can create different membership levels, such as bronze, silver, and gold. The store admin can assign specific products to each level of membership. Customers will be classified into different membership levels based on the products they buy. The assigned products are not limited to any specific type, so it’s flexible for the store owner to draw customers to a certain product that needs to be promoted. 

When customers are members of a membership group, they will have specific privileges or benefits. The benefits are ruled out by store owners from the admin backend, which can be discount coupons or free shipping codes. The store admin can add as many benefits as they want to encourage customers to purchase more to level up their membership, such as from silver to gold. 

Customers can also upgrade their membership level by paying a fixed price for a higher membership package or applying discounts to save money. To motivate customers to take a longer membership time, the store can offer different price levels corresponding to the membership duration. The rule is the longer membership is, the lower the price customers have to pay. For example, for the Gold membership package, $300 for 3 months, $200 for 6 months, and $100 for 12 months. 

It’s easy to customize the membership cards. You can change the feature images, the background of the cards, and add the noticeable labels to attract customers. 

### 1. How to install
Run the following command in Magento 2 root folder:

```
composer require mageplaza/module-membership-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
```
**Note:** 
Magento 2 Membership GraphQL requires installing [Mageplaza Membership](https://www.mageplaza.com/magento-2-membership/) in your Magento installtion. 

### 2. How to use
Mageplaza's Membership GraphQL supports getting Membership Page information, Upgrade Page, Membership products, membership and transaction information of customers, adding membership products to cart, and getting cart information. 

To start working with Membership GraphQL in Magento, complete the following requirements: 
- Use Magento 2.3.x. Return your site to developer mode.  
- Install [chrome extension](https://chrome.google.com/webstore/detail/chromeiql/fkkiamalmpiidkljmicmjfbieiclmeij?hl=en) (currently does not support other browsers)
- Set **GraphQL endpoint** as `http://<magento2-2-server>/graph` in url box. Click on **Set endpoint**. (e.g., `http://develop.mageplaza.com/graphql/ce232/graph). 
- Refer to the GraphQL requests we support [here](https://documenter.getpostman.com/view/10589000/SzS4RSwd?version=latest).

### 3. Devdocs
- [Magento 2 Membership API & examples](https://documenter.getpostman.com/view/10589000/SzS4RSnr?version=latest)
- [Magento 2 Membership GraphQL & examples](https://documenter.getpostman.com/view/10589000/SzS4RSwd?version=latest)

Click on Run in Postman to add these collections to your workspace quickly.

![Magento 2 blog graphql pwa](https://i.imgur.com/lhsXlUR.gif)

### 4. Contribute to this module 
Feel free to **Fork** and contribute to this module. 

You can create a pull request, so we will merge your changes in the main branch. 

### 5. Get support 
- Feel free to [contact us](https://www.mageplaza.com/contact.html) if you have any question. 
- If you find this post helpful, please give it a **Star** ![star](https://i.imgur.com/S8e0ctO.png)

## Changelog

CHANGELOG: https://www.mageplaza.com/releases/membership/

## Recent Versions

| Version | Released |
|---|---|
| 1.0.1 | 2022-11-14 |
| 1.0.0 | 2020-03-19 |

## Quality

Latest release (1.0.1) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 21 | 21 warnings (ruleset: Magento2) — 20 auto-fixable with phpcbf |
| PHPMD | Warning | 4 | 4 rule violations (UndefinedVariable:3, NPathComplexity:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 61 | 61 | – | – |
| 2.4.8 | – | 61 | 75 | – |
| 2.4.9 | – | – | 75 | 75 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageplaza/module-membership-graphql"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageplaza is a Magento 2 vendor on Packagento. See https://packagento.com/mageplaza.md for their full catalogue.