PHPackages                             partnero/partnero-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. partnero/partnero-php

ActiveLibrary[Utility & Helpers](/categories/utility)

partnero/partnero-php
=====================

Partnero PHP SDK

v1.0.22(2y ago)462.2k↓24.7%1[1 issues](https://github.com/partnero/partnero-php/issues)MITPHPPHP ^8.0

Since Mar 7Pushed 1y agoCompare

[ Source](https://github.com/partnero/partnero-php)[ Packagist](https://packagist.org/packages/partnero/partnero-php)[ Docs](https://partnero.com)[ RSS](/packages/partnero-partnero-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (4)Versions (28)Used By (0)

Partnero PHP SDK

[![MIT licensed](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](/LICENSE)

Table of Contents
=================

[](#table-of-contents)

- [Installation](#installation)
- [Usage](#usage)
    - [Partners API](#partners-for-affiliate-program)
        - [Get a list of partners](#get-a-list-of-partners)
        - [Get partner](#get-partner)
        - [Create partner](#create-partner)
        - [Update partner](#update-partner)
        - [Delete partner](#delete-partner)
    - [Customers API](#customers)
        - [Get a list of customers](#get-a-list-of-customers)
        - [Get customer](#get-customer)
        - [Create customer](#create-customer)
        - [Update customer](#update-customer)
        - [Delete customer](#delete-customer)
    - [Transactions API](#transactions)
        - [Create transaction](#create-transaction)
        - [Delete transaction](#delete-transaction)
        - [Archive transaction](#archive-transaction)
        - [Revoke archived transaction](#revoke-archived-transaction)
    - [Webhooks API](#webhooks)
        - [Get a list of webhooks](#get-a-list-of-webhooks)
        - [Get webhook](#get-webhook)
        - [Create webhook](#create-webhook)
        - [Update webhook](#update-webhook)
        - [Delete webhook](#delete-webhook)
    - [Referrals API](#referrals)
        - [Get a list of referrals](#get-a-list-of-referrals)
        - [Create referring customer](#create-referring-customer)
        - [Create referred customer](#create-referred-customer)
        - [Get referral customer](#get-referral-customer)
        - [Get list of referred customers](#get-referred-customer-list)
        - [Get stats of referral customer](#get-referral-customer-stats)
        - [Search referral customer](#search-referral-customer)
        - [Update referral customer](#update-referral-customer)
        - [Delete referral customer](#delete-referral-customer)
        - [Invite referral customer via email](#invite-referral-customer)
        - [Get referral customer balance](#get-referral-customer-balance)
        - [Credit referral customer balance](#credit-referral-customer-balance)
    - [Partner referral link API](#partner-referral-link)
        - [Get list of a partner referral links](#get-a-list-of-a-partner-referral-links)
        - [Create partner referral link](#create-partner-referral-link)
        - [Get partner referral link](#get-partner-referral-link)
        - [Update partner referral link](#update-partner-referral-link)
        - [Delete partner referral link](#delete-partner-referral-link)
        - [Search partner referral link](#search-partner-referral-link)
    - [Referral program - Customer referral link API](#customer-referral-link)
        - [Get list of a customer referral links](#get-a-list-of-a-customer-referral-links)
        - [Create customer referral link](#create-customer-referral-link)
        - [Get customer referral link](#get-customer-referral-link)
        - [Update customer referral link](#update-customer-referral-link)
        - [Delete customer referral link](#delete-customer-referral-link)
        - [Search customer referral link](#search-customer-referral-link)
    - [Subscribers API](#subscribers)
        - [Get a list of subscribers](#get-a-list-of-subscribers)
        - [Get subscriber](#get-subscriber)
        - [Create subscriber](#create-subscriber)
        - [Update subscriber](#update-subscriber)
        - [Delete subscriber](#delete-subscriber)
- [Support and Feedback](#support-and-feedback)

Installation
============

[](#installation)

Requirements
------------

[](#requirements)

- PHP 8.0
- PSR-7 and PSR-18 based HTTP adapter
- Partnero API key [partnero.com](https://www.partnero.com)

Setup
-----

[](#setup)

This library is built atop of [PSR-7](https://www.php-fig.org/psr/psr-7/) and [PSR-18](https://www.php-fig.org/psr/psr-18/).

```
composer require partnero/partnero-php
```

Usage
=====

[](#usage)

Partners for Affiliate program
------------------------------

[](#partners-for-affiliate-program)

### Get a list of partners

[](#get-a-list-of-partners)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->partners()->list(10);
```

### Get partner

[](#get-partner)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->partners()->find('partner-key');
```

### Create partner

[](#create-partner)

```
use Partnero\Partnero;
use Partnero\Models\Partner;

$partnero = new Partnero('api_key');

$partner = (new Partner())
  ->setEmail('test@mail.com')
  ->setName('Name')
  ->setKey('partner-key');

$partnero->partners()->create($partner);
```

Key is optional.
If key is not set, a random key will be generated for the partner.

### Update partner

[](#update-partner)

```
use Partnero\Partnero;
use Partnero\Models\Partner;

$partnero = new Partnero('api_key');

$partner = (new Partner())
  ->setEmail('john.doe@mail.com')
  ->setName('John')
  ->setKey('john-doe');

$partnero->partners()->update('partner-key', $partner);
```

### Delete partner

[](#delete-partner)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->partners()->delete('john-doe');
```

Customers
---------

[](#customers)

### Get a list of customers

[](#get-a-list-of-customers)

```
use Partnero\Partnero;
use Partnero\Models\Partner;

$partnero = new Partnero('api_key');

$partner = (new Partner())
  ->setKey('partner-key');

$partnero->customers()->list(10, $partner);
```

### Get customer

[](#get-customer)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->customers()->find('customer-key');
```

### Create customer

[](#create-customer)

```
use Partnero\Partnero;
use Partnero\Models\Partner;
use Partnero\Models\Customer;

$partnero = new Partnero('api_key');

$partner = new Partner();
$partner->setKey('partner-key');

$customer = (new Customer())
  ->setKey('customer-key')
  ->setName('Name')
  ->setEmail('customer@mail.com');

$partnero->customers()->create($customer, $partner);
```

### Update customer

[](#update-customer)

```
use Partnero\Partnero;
use Partnero\Models\Customer;

$partnero = new Partnero('api_key');

$customer = (new Customer())
  ->setKey('new-customer-key')
  ->setName('John')
  ->setEmail('customer.john.doe@mail.com');

$partnero->customers()->update('customer-key', $customer);
```

### Delete customer

[](#delete-customer)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->customers()->delete('new-customer-key');
```

Transactions
------------

[](#transactions)

### Create transaction

[](#create-transaction)

```
use Partnero\Partnero;
use Partnero\Models\Customer;
use Partnero\Models\Transaction;

$partnero = new Partnero('api_key');

$customer = (new Customer())
  ->setKey('customer-key');

$transaction = (new Transaction())
  ->setKey('transaction_123')
  ->setAmount(99.99)
  ->setAction('sale');

$partnero->transactions()->create($transaction, $customer);
```

### Archive transaction

[](#archive-transaction)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->transactions()->archive('transaction_123');
```

### Revoke archived transaction

[](#revoke-archived-transaction)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->transactions()->revokeArchived('transaction_123');
```

### Delete transaction

[](#delete-transaction)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->transactions()->delete('transaction_123');
```

Webhooks
--------

[](#webhooks)

### Get a list of webhooks

[](#get-a-list-of-webhooks)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->webhooks()->list(50, 1);
```

### Get webhook

[](#get-webhook)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->webhooks()->find('webhook-key');
```

### Create webhook

[](#create-webhook)

```
use Partnero\Partnero;
use Partnero\Models\Webhook;

$partnero = new Partnero('api_key');

$webhook = (new Webhook())
  ->setName('Demo')
  ->setUrl('https://webhook.site/e68d154a-ad82')
  ->setEvents([
    'partner.created'
  ]);

$partnero->webhooks()->create($webhook);
```

### Update webhook

[](#update-webhook)

```
use Partnero\Partnero;
use Partnero\Models\Webhook;

$partnero = new Partnero('api_key');

$webhook = (new Webhook())->setName('Demo 2');

$partnero->webhooks()->update('webhook-key', $webhook);
```

### Delete webhook

[](#delete-webhook)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->webhooks()->delete('webhook-key');
```

Referrals
---------

[](#referrals)

### Get a list of referrals

[](#get-a-list-of-referrals)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->referrals()->list(50, 1, 'referred')
```

### Create referring customer

[](#create-referring-customer)

```
use Partnero\Partnero;
use Partnero\Models\Partner;

$partnero = new Partnero('api_key');

$customer = (new Partner())
  ->setId('partner-id')
  ->setName('John Doe')
  ->setEmail('john.doe@email.com');

$partnero->referrals()->createReferring($customer);
```

### Create referred customer

[](#create-referred-customer)

```
use Partnero\Partnero;
use Partnero\Models\Partner;

$partnero = new Partnero('api_key');

$customer = (new Partner())
  ->setId('partner-id')
  ->setName('Jean Doe')
  ->setEmail('jean.doe@email.com');

$referringCustomer = (new Partner())
  ->setKey('partner-key');

$partnero->referrals()->createReferred($customer, $referringCustomer)
```

### Get referral customer

[](#get-referral-customer)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->referrals()->find('partner-id');
```

### Get referred customer list

[](#get-referred-customer-list)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->referrals()->listReferred('partner-id');
```

### Get referral customer stats

[](#get-referral-customer-stats)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->referrals()->stats('partner-id');
```

### Search Referral Customer

[](#search-referral-customer)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->referrals()->search(['id' => 'partner-id']);
```

### Update referral customer

[](#update-referral-customer)

```
use Partnero\Partnero;
use Partnero\Models\Partner;

$partnero = new Partnero('api_key');

$newCustomer = (new Partner())
  ->setName('Mark Doe');

$partnero->referrals()->update('partner-id', $newCustomer);
```

### Delete referral customer

[](#delete-referral-customer)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->referrals()->delete('partner-id');
```

### Invite referral customer

[](#invite-referral-customer)

```
use Partnero\Partnero;
use Partnero\Models\Partner;

$partnero = new Partnero('api_key');

$customer = (new Partner())
  ->setEmail('john.doe@email.com');

$partnero->referrals()->invite($customer, [
  'personalization_key_1' => 'personalization_value_1',
  'personalization_key_2' => 'personalization_value_2'
]);
```

### Get referral customer balance

[](#get-referral-customer-balance)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->referrals()->balance('partner-id');
```

### Credit referral customer balance

[](#credit-referral-customer-balance)

```
use Partnero\Partnero;
use Partnero\Models\BalanceCredit;

$partnero = new Partnero('api_key');

$credit = (new BalanceCredit())
            ->setAmount(10)
            ->setAmountUnits('usd')
            ->setIsCurrency(true);

$partnero->referrals()->credit('partner-id', $credit);
```

Partner referral link
---------------------

[](#partner-referral-link)

### Get a list of a partner referral links

[](#get-a-list-of-a-partner-referral-links)

```
use Partnero\Partnero;
use Partnero\Models\ReferralLink;

$partnero = new Partnero('api_key');

$partnero->partnerReferralLinks()->list('partner-key', 'limit');
```

### Get partner referral link

[](#get-partner-referral-link)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->partnerReferralLinks()->get('link-id');
```

### Create partner referral link

[](#create-partner-referral-link)

```
use Partnero\Partnero;
use Partnero\Models\ReferralLink;

$partnero = new Partnero('api_key');

$link = (new ReferralLink())
    ->setKey('referral-link-key');

$partner = (new Partner())
  ->setId('partner-id')
  ->setName('Jean Doe')
  ->setEmail('jean.doe@email.com');

$partnero->partnerReferralLinks()->create($link, $partner);
```

### Update partner referral link

[](#update-partner-referral-link)

```
use Partnero\Partnero;
use Partnero\Models\ReferralLink;

$partnero = new Partnero('api_key');

$link = (new ReferralLink())
    ->setKey('referral-updated-link-key');

$partnero->partnerReferralLinks()->update('link-id', $link);
```

### Delete partner referral link

[](#delete-partner-referral-link)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->partnerReferralLinks()->delete('link-id');
```

### Search partner referral link

[](#search-partner-referral-link)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

// use id or key
$partnero->partnerReferralLinks()->search(['id' => 'link-id']);
```

Customer referral link
----------------------

[](#customer-referral-link)

### Get a list of a customer referral links

[](#get-a-list-of-a-customer-referral-links)

```
use Partnero\Partnero;
use Partnero\Models\ReferralLink;

$partnero = new Partnero('api_key');

$partnero->customerReferralLinks()->list('customer-key', 'limit');
```

### Get customer referral link

[](#get-customer-referral-link)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->customerReferralLinks()->get('link-id');
```

### Create customer referral link

[](#create-customer-referral-link)

```
use Partnero\Partnero;
use Partnero\Models\ReferralLink;

$partnero = new Partnero('api_key');

$link = (new ReferralLink())
    ->setKey('referral-link-key');

$partnero->customerReferralLinks()->create($link, $partner);
```

### Update customer referral link

[](#update-customer-referral-link)

```
use Partnero\Partnero;
use Partnero\Models\ReferralLink;

$partnero = new Partnero('api_key');

$link = (new ReferralLink())
    ->setKey('referral-updated-link-key');

$partnero->customerReferralLinks()->update('link-id', $link);
```

### Delete customer referral link

[](#delete-customer-referral-link)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->customerReferralLinks()->delete('link-id');
```

### Search customer referral link

[](#search-customer-referral-link)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

// use id or key
$partnero->customerReferralLinks()->search(['id' => 'link-id']);

// Optionally, you can pass customer as a second parameter
$partnero->customerReferralLinks()->search(['key' => 'link-key', 'customer' => ['id' => 'customer-id']]);
```

Subscribers
-----------

[](#subscribers)

### Get a list of subscribers

[](#get-a-list-of-subscribers)

```
use Partnero\Partnero;
use Partnero\Models\Subscriber;

$partnero = new Partnero('api_key');

$partnero->subscribers()->list();
```

### Get subscriber

[](#get-subscriber)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->subscribers()->find('subscriber-identifier-or-email');
```

### Create subscriber

[](#create-subscriber)

```
use Partnero\Partnero;
use Partnero\Models\Subscriber;

$partnero = new Partnero('api_key');

$subscriber = (new Subscriber())
    ->setName('Referral subscriber')
    ->setEmail('referral@subscriber.com')
    ->setApproved(true)
    ->setStatus('active')
    ->setTos(true)
    ->setMarketingConsent(true);;

$singleSubscriber = $partnero->subscribers()->create($subscriber);

// If you want to create a referred subscriber
$referredSubscriber = (new Subscriber())
    ->setName('Referred Subscriber')
    ->setEmail('referred@subscriber.com')
    ->setApproved(true)
    ->setStatus('active')
    ->setTos(true)
    ->setMarketingConsent(true);

$partnero->subscribers()->create($referredSubscriber, $singleSubscriber);
```

> ***NOTE:*** To create a referred subscriber, pass the parent subscriber as the second argument. If you’re using a response like the one in the example above, make sure to extract the necessary data from the response (e.g., $singleSubscriber\['body'\]\['data'\]).
>
> Alternatively, instead of passing the entire model as a second argument, you can pass the parent subscriber’s identifier or email as an array, for example: `$partnero->subscribers()->create($referredSubscriber, ['email' => 'referral@subscriber.com']).`

### Update subscriber

[](#update-subscriber)

```
use Partnero\Partnero;
use Partnero\Models\Subscriber;

$partnero = new Partnero('api_key');

$subscriber = (new Subscriber())
  ->setIdentifier('new-subscriber-esp-identifier')
  ->setName('John Surname')
  ->setEmail('subscriber.john.doe@mail.com')
  ->setApproved(true)
  ->setStatus('active')
  ->setTos(false)
  ->setMarketingConsent(false);

$partnero->subscribers()->update('subscriber-identifier-or-email', $subscriber);
```

### Delete subscriber

[](#delete-subscriber)

```
use Partnero\Partnero;

$partnero = new Partnero('api_key');

$partnero->subscribers()->delete('subscriber-identifier-or-email');
```

Support and Feedback
====================

[](#support-and-feedback)

In case you find any bugs, submit an issue directly here in GitHub.

If you have any troubles using our API or SDK feel free to contact our support by email

The official documentation is at

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance28

Infrequent updates — may be unmaintained

Popularity35

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 57.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~34 days

Recently: every ~51 days

Total

23

Last Release

768d ago

PHP version history (2 changes)v1.0.0PHP ^7.4|^8.0

v1.0.8PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/bc6332cd162af06330d3b6bee7a26346ee19db47f73b6c0cb53a9545b69ba7ea?d=identicon)[partnero](/maintainers/partnero)

---

Top Contributors

[![BrijeshTRC](https://avatars.githubusercontent.com/u/112624702?v=4)](https://github.com/BrijeshTRC "BrijeshTRC (8 commits)")[![Dach0](https://avatars.githubusercontent.com/u/40193265?v=4)](https://github.com/Dach0 "Dach0 (2 commits)")[![mindaugasmailer](https://avatars.githubusercontent.com/u/64002562?v=4)](https://github.com/mindaugasmailer "mindaugasmailer (2 commits)")[![ashraful19](https://avatars.githubusercontent.com/u/25670420?v=4)](https://github.com/ashraful19 "ashraful19 (1 commits)")[![OvidijusSobut](https://avatars.githubusercontent.com/u/123360845?v=4)](https://github.com/OvidijusSobut "OvidijusSobut (1 commits)")

---

Tags

affiliateaffiliate-marketingpartnerspartnershipsreferralreferral-platformreferralsPartnero

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/partnero-partnero-php/health.svg)

```
[![Health](https://phpackages.com/badges/partnero-partnero-php/health.svg)](https://phpackages.com/packages/partnero-partnero-php)
```

###  Alternatives

[wallabag/wallabag

open source self hostable read-it-later web application

12.6k2.2k](/packages/wallabag-wallabag)[razorpay/ifsc

Razorpay IFSC Codes Library

382201.9k](/packages/razorpay-ifsc)[recca0120/laravel-erd

Laravel ERD automatically generates Entity-Relationship Diagrams from your Laravel models and displays them using Vuerd.

36072.0k](/packages/recca0120-laravel-erd)[anthropic-ai/sdk

Anthropic PHP SDK

129134.7k5](/packages/anthropic-ai-sdk)[phpro/http-tools

HTTP tools for developing more consistent HTTP implementations.

28137.8k](/packages/phpro-http-tools)[olifanton/ton

PHP library for The Open Network blockchain

8849.8k2](/packages/olifanton-ton)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)