README

I love the competition that came from innovation. For businesses and creators worldwide, being able to charge for services is one of the most needed requirements in this global world. Sadly, few companies can bring this kind of solution. Lemon Squeeze brings payments, tax & subscriptions for software companies by being your merchant of record, handling the tax compliance burden so you can focus on more revenue and less headache.

This SDK wraps the Lemon Squeeze API to simplify the service integration with the PHP language.

I started this project with personal and professional motivation. So I'm putting all the effort into finishing the to-do list as fast as possible. To start the hype about the package, I'm opening this from day one and pushing every new endpoint as a new feature release. I include the package core + Users endpoint information for the first release.

Installation

This package requires PHP 8.2. To get started, install it using Composer like this:

composer require seisigmasrl/lemonsqueezy-php

This SDK architecture is highly inspired by the DigitalOcean Client package by decoupling from any HTTP messaging client by using PSR-7, PSR-17, PSR-18, and HTTPlug. You can visit HTTPlug for library users to get more information about installing HTTPlug related packages. This package will automatically discover an HTTP client to use from what you have available.

Usage

I'll be creating an official website with the final documentation of the SDK, but in the meantime, here are the details of the current options:

# Initializing the Package
<?php
require_once  'vendor/autoload.php';

// Create a new LemonSqueezy client
$client = new \LemonSqueezy\LemonSqueezy();

// Authenticate the client by providing your API Token which can be
// generated at https://app.lemonsqueezy.com/settings/api
$client->authenticate('yourApiToken');

Here's the list of the current methods provided by this package base on the existed endpoints:

User

<?php
# Initialize the Package from the step before
...
// Get the user information base on the defined in the Lemon Squeeze API Documentation
// https://docs.lemonsqueezy.com/api/users#the-user-object
$user = $client->user();
$userDetails = $user->getUserInformation();

var_dump($userDetails);
// object(LemonSqueezy\Entity\User)#4567 (7) {
//   ["id"]=> id(5) "13546"   // New
//   ["name"]=> string(14) "Marco Polo"
//   ["email"]=> string(19) "marco@polo.com"
//   ["color"]=> string(7) "#7047EB"
//   ["avatar_url"]=> string(72) "https://www.gravatar.com/avatar/cc27e9f9e9a66d0fb6a988a?d=blank"
//   ["has_custom_avatar"]=> bool(false)
//   ["createdAt"]=> string(27) "2023-01-18T13:56:46.000000Z"
//   ["updatedAt"]=> string(27) "2023-01-18T14:00:01.000000Z"
// }

// Get only the ID of the User
// $userId = $user->getUserId(); Deprecated.

Store

<?php
# Initialize the Package from the step before
...
// Get the user information base on the defined in the Lemon Squeeze API Documentation
// https://docs.lemonsqueezy.com/api/stores#the-store-object
$lemonSqueeze = $client->store();
$storeList = $lemonSqueeze->getAllStores();     // List all existing Stores
$store = $lemonSqueeze->getStore(12685);        // Get details of the store with the ID: 12685

Customer

<?php
# Initialize the Package from the step before
...
// Get the user information base on the defined in the Lemon Squeeze API Documentation
// https://docs.lemonsqueezy.com/api/customers#the-customer-object
$lemonSqueeze = $client->customer();
$allCustomers = $lemonSqueeze->getAllCustomers();           // List all existing Customers
$storeCustomers = $lemonSqueeze->getStoreCustomers(12689);  // List all customers from the Store ID: 12689
$customer = $lemonSqueeze->getCustomer(596510);             // Get the details of the Customer with the ID: 596510

Product

<?php
# Initialize the Package from the step before
...
// Get the user information base on the defined in the Lemon Squeeze API Documentation
// https://docs.lemonsqueezy.com/api/products#the-product-object
$lemonSqueeze = $client->product();
$allProducts = $lemonSqueeze->getAllProducts();                      // List all existing Products
$storeCustomers = $lemonSqueeze->getStoreProducts(12689);            // List all Products from the Store ID: 12689
$product = $lemonSqueeze->getProduct(59920);                         // Get the details of the Products with the ID: 59920
$productVariants = $lemonSqueeze->getProductVariants(59920);         // Get all Variants from the Product ID: 59920
$productWithVariants = $lemonSqueeze->getProductWithVariants(59920); // Get a Product with All their Variants

Roadmap / To-Do

General
- Authentication - v.1.0.0
  - Rate Limiting - v.1.0.0
  - Errors (Exceptions) - v.1.0.0
  - Pagination - WIP
- Related Resources
- Filtering
Users - v.1.0.0
- Retrieve Authenticated User Information - v.1.0.0
- Retrieve logged User's Id - v.1.0.0
Stores - v.1.2.0
- List all Stores - v.1.2.0
- Retrieve Store - v.1.2.0
Customers - v.1.2.0
- List all Customers - v.1.2.0
- List all Customers from a Store - v.1.2.0
- Retrieve a Customer - v.1.2.0
Products - v.1.3.0
- List all Products - v.1.3.0
- List all Products from a Store - v.1.3.0
- Retrieve a Product - v.1.3.0
  - List all Variants of a Product - v.1.3.0
  - Retrieve a Product with all their Variants - v.1.3.0
Files
- List all Files
- Retrieve a File
Orders
- List all Orders
- Retrieve an Order
  - List all Order Items
  - Retrieve an Order Item
Subscriptions
- List all Subscriptions
- Retrieve a Subscription
- Update a Subscription
- Cancel a Subscription
  - List all Subscription Invoices
  - Retrieve a Subscription Invoice
Discounts
- Create a Discount
- List all Discounts
- Retrieve a Discount
- Delete a Discount
  - List all Discount Redemptions
  - Retrieve a Discount Redemption
Checkouts
- List all Checkouts
- Retrieve a Checkout
- Create a Checkout
License Keys
- List all License Keys
- Retrieve a License Key
  - List all License Key Instances
  - Retrieve a License Key Instance
Webhooks? TBD
API Documentation (A nice one).

seisigmasrl / lemonsqueezy-php

Maintainers

Details