PHPackages                             squid/patreon - 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. [API Development](/categories/api)
4. /
5. squid/patreon

AbandonedArchivedLibrary[API Development](/categories/api)

squid/patreon
=============

PHP library for interacting with the Patreon API

1.2.0(8y ago)72222[1 issues](https://github.com/1f991/patreon-php/issues)MITPHPPHP &gt;=7.2.0

Since Apr 16Pushed 8y agoCompare

[ Source](https://github.com/1f991/patreon-php)[ Packagist](https://packagist.org/packages/squid/patreon)[ RSS](/packages/squid-patreon/feed)WikiDiscussions master Synced 5d ago

READMEChangelog (3)Dependencies (10)Versions (5)Used By (0)

Patreon PHP
===========

[](#patreon-php)

[![Packagist](https://camo.githubusercontent.com/5ba6e16f42675a557398fb70e9805571dd3c39ad3a289407e409ff8faea9d3a7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73717569642f70617472656f6e2e737667)](https://packagist.org/packages/squid/patreon)[![license](https://camo.githubusercontent.com/756148dcbd3bf8445a65058b13947e141440b96ef14faf80096845fa72aebcc2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f31663939312f70617472656f6e2d7068702e737667)](/LICENSE)[![CircleCI branch](https://camo.githubusercontent.com/ebdc2c9d9abfc36405c03063d7bd0129f733006ee3dcaedfcb63ec372da9cdf5/68747470733a2f2f696d672e736869656c64732e696f2f636972636c6563692f70726f6a6563742f6769746875622f31663939312f70617472656f6e2d7068702f6d61737465722e737667)](https://circleci.com/gh/1f991/patreon-php/tree/master)[![Maintainability](https://camo.githubusercontent.com/f79d8d75e7c1977059b2098cf5e737bfa1f86314a74c9acdf0c5af7057261d1e/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f65316137616530616665646264666263663934622f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/1f991/patreon-php/maintainability)[![Test Coverage](https://camo.githubusercontent.com/5d7f73f9636089260750eddbfba5ebbcd95a4d590b0ffb719642e56581ad4b67/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f65316137616530616665646264666263663934622f746573745f636f766572616765)](https://codeclimate.com/github/1f991/patreon-php/test_coverage)

A PHP library for interacting with the [Patreon Platform](https://www.patreon.com/portal), designed to provide the easiest path for integrating Patreon into your application with a simple interface that abstracts away the underlying Patreon API.

Requirements
============

[](#requirements)

- PHP &gt;=7.2
- [Composer](https://getcomposer.org/)
- An [HTTPlug compatible client](http://docs.php-http.org/en/latest/clients.html)such as [`php-http/guzzle6-adapter`](https://packagist.org/packages/php-http/guzzle6-adapter)

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

[](#installation)

Patreon PHP is available on [Packagist](https://packagist.org/packages/squid/patreon).

```
composer require squid/patreon php-http/guzzle6-adapter
```

You may swap out [`php-http/guzzle6-adapter`](https://packagist.org/packages/php-http/guzzle6-adapter)for your own [HTTPlug Compatible Client](http://docs.php-http.org/en/latest/clients.html), such as the [cURL client](https://packagist.org/packages/php-http/curl-client)or the [React HTTP Adapter](https://packagist.org/packages/php-http/react-adapter).

How To Use
==========

[](#how-to-use)

After you've installed the package you're ready to instantiate a client with your access token and then request data for resources.

```
use Squid\Patreon\Patreon;

$patreon = new Patreon('access_token');
$campaign = $patreon->campaigns()->getMyCampaignWithPledges();

echo "Hello, {$campaign->creator->full_name}! You have {$campaign->patron_count} patrons.\n";

$campaign->pledges->each(function ($pledge) {
    echo "{$pledge->patron->full_name} has been a patron since {$pledge->created_at}.\n";
});
```

Learn More
==========

[](#learn-more)

Documentation is available covering all aspects of the library, from getting started to architecture, or you can get started by looking at some examples of how to achieve the most common integrations.

1. [Getting Started](docs/01-getting-started.md)
2. [Obtaining OAuth Tokens For Patrons](docs/02-oauth.md)
3. [Patreon Integration Examples](docs/03-examples.md)
4. [Method Documentation](docs/04-documentation.md)
5. [Library Architecture](docs/05-architecture.md)

Examples
--------

[](#examples)

A full example project that you can download and use is available at [1f991/patreon-php-example](https://github.com/1f991/patreon-php-example) which includes:

- Display a list of Patrons
- Instantly add/delete/update patrons using Webhooks
- Allow Patrons to log in with OAuth

A demo of the example project can be found live at [patreon.1f991.com](https://patreon.1f991.com)where you can create a pledge and log in to see it in action.

Alternatively, smaller self-contained examples of specific implementations are available in the documentation for this project:

- [Display Patron's pictures](/docs/03-examples.md#display-patrons)
- [Create a list of your Most Valuable Patrons Email Addresses](/docs/03-examples.md#most-valuable-patrons)
- [Delete a User's account when their Pledge is cancelled](/docs/03-examples.md#delete-users-when-pledge-is-cancelled)

Getting Help
============

[](#getting-help)

Please visit the [Patreon Developers forum](https://www.patreondevelopers.com/)with any questions you have about using this library, or the Patreon Plaform. Please report any bugs found in this library by creating a new [issue](https://github.com/1f991/patreon-php/issues). A reproduceable test case should be included where possible, otherwise a description of your problem and steps to reproduce would be very helpful.

Dependencies
============

[](#dependencies)

This library has been made possible by the fantastic open source contributions of others, including...

- [Yang](https://github.com/woohoolabs/yang), a JSON:API Client Library by Woohoo Labs
- [HTTPlug](https://github.com/php-http/httplug), the HTTP client abstraction for PHP
- [Collect](https://github.com/tightenco/collect), a split of [Laravel Collections](https://laravel.com/docs/5.6/collections)

Security Vulnerabilities
========================

[](#security-vulnerabilities)

Please reach out to Samuel Ryan via email () to report any security concerns you may have discovered with this library. Acknowledgement will be provided within 24 hours.

License
=======

[](#license)

Patreon PHP is open-sourced software licensed under the [MIT license](https://choosealicense.com/licenses/mit/).

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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 ~8 days

Total

3

Last Release

2936d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3eae532eeb2274bd112281cd9071a1ea698aeeb7d30abfa92777d6feab856ee8?d=identicon)[shrink](/maintainers/shrink)

---

Top Contributors

[![shrink](https://avatars.githubusercontent.com/u/349689?v=4)](https://github.com/shrink "shrink (87 commits)")

---

Tags

patreonpatreon-apipatreon-clientpatreon-phppatreon-platformphppatreon

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/squid-patreon/health.svg)

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

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[j0k3r/graby

Graby helps you extract article content from web pages

384349.6k2](/packages/j0k3r-graby)[janu-software/facebook-php-sdk

Alternative toolkit for Facebook Graph API

71684.8k2](/packages/janu-software-facebook-php-sdk)[php-heroku-client/php-heroku-client

A PHP client for the Heroku Platform API

24404.8k4](/packages/php-heroku-client-php-heroku-client)[phpro/http-tools

HTTP tools for developing more consistent HTTP implementations.

28137.8k](/packages/phpro-http-tools)[apigee/apigee-client-php

Client library for connecting to the Apigee Edge API.

27558.7k3](/packages/apigee-apigee-client-php)

PHPackages © 2026

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