Plug&Pay SDK

https://github.com/plug-and-pay/sdk-php
Admin
A PHP SDK designed to simplify and facilitate communication with the Plug&Pay API.
Tokens:28,134
Snippets:173
Trust Score:7.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Trial include example

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Demonstrates retrieving trial information for a subscription by including SubscriptionIncludes::TRIAL. Access trial start and end dates and check if the trial is active.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;

$client  = new Client($token);
$service = new SubscriptionService($client);

$subscriptionId = 1;
$subscription = $service->include(
    SubscriptionIncludes::TRIAL
)->find($subscriptionId);

$trial     = $subscription->trial();

$startDate = $trial->endDate()->startDate;
$endDate   = $trial->endDate()->format;
$isActive  = $trial->isActive();
```

--------------------------------

### Get all products

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Retrieves all products using the ProductService.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;

$client = new Client('your_access_token');
$productService = new ProductService($client);

$products = $productService->get();
```

--------------------------------

### Pricing include example

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Shows how to retrieve pricing details for a subscription by including SubscriptionIncludes::PRICING. Access amount, discounts, quantity, tax, and tax inclusion status through the pricing object.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;

$client  = new Client($token);
$service = new SubscriptionService($client);

$subscriptionId = 1;
$subscription = $service=->include(
    SubscriptionIncludes::PRICING
)->find($subscriptionId);

$pricing       = $subscription->pricing();

$amount        = $pricing->amount();
$amountWithTax = $pricing->amountWithTax();
$discounts     = $pricing->discounts();
$quantity      = $pricing->quantity();
$tax           = $pricing->tax();
$isTaxIncluded = $pricing->isTaxIncluded();
```

--------------------------------

### Product include example

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Demonstrates retrieving product information for a subscription by including SubscriptionIncludes::PRODUCT. Access product attributes such as id, timestamps, description, pricing, stock, and type.

```php
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;

$client  = new Client($token);
$service = new SubscriptionService($client);

$subscriptionId = 1;
$subscription = $service->include(
    SubscriptionIncludes::PRODUCT
)->find($subscriptionId);

$product = $subscription->product();

$id          = $product->id();
$createdAt   = $product->createdAt()->format();
$deletedAt   = $product->deletedAt()->format();
$updatedAt   = $product->updatedAt()->format();
$description = $product->description();
$ledger      = $product->ledger();
$physical    = $product->physical();
$pricing     = $product->pricing();
$publicTitle = $product->publicTitle();
$sku         = $product->sku();
$slug        = $product->slug();
$stock       = $product->stock();
$title       = $product->title();
$type        = $product->type()->value;
$type        = $product->type()->value;
```

--------------------------------

### Get all Memberships Settings with MembershipsSettingService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Memberships

Retrieves all Memberships Setting models using the MembershipsSettingService->get() method. Requires a valid token for the Client constructor.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\MembershipsSettingService;

$client = new Client($token);
$service = new MembershipsSettingService($client);

$membershipsSetting = $service->get();
```

--------------------------------

### Filter Orders with OrderService->get() and OrderFilter

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Use the OrderService->get() method with an OrderFilter to retrieve orders with various filters. This example demonstrates many filter methods including affiliateId, checkoutId, contractType, country, direction, discountCode, email, hasBump, hasTax, invoiceStatus, isDeleted, isFirst, isHidden, isUpsell, limit, mode, page, paymentStatus, productId, productTag, query, sinceInvoiceDate, sincePaidAt, sort, source, untilInvoiceDate, and untilPaidAt.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Filters\OrderFilter;
use PlugAndPay\Sdk\Enum\ContractType;
use PlugAndPay\Sdk\Enum\CountryCode;
use PlugAndPay\Sdk\Enum\Direction;
use PlugAndPay\Sdk\Enum\InvoiceStatus;
use PlugAndPay\Sdk\Enum\OrderMode;
use PlugAndPay\Sdk\Enum\PaymentStatus;
use PlugAndPay\Sdk\Enum\OrderSortType;
use PlugAndPay\Sdk\Enum\OrderSource;

$client  = new Client($token);
$service = new OrderService($client);

$orders = $service->get(
    (new OrderFilter())
        ->affiliateId(1234)
        ->checkoutId(1234)
        ->contractId(1234)
        ->contractType(ContractType::SUBSCRIPTION)
        ->country(CountryCode::from('NL'))
        ->direction(Direction::DESC)
        ->discountCode('discount-code')
        ->email('test@plugandpay.net')
        ->hasBump(true)
        ->hasTax(true)
        ->invoiceStatus(InvoiceStatus::FINAL)
        ->isDeleted(true)
        ->isFirst(true)
        ->isHidden(true)
        ->isUpsell(true)
        ->limit(1)
        ->mode(Mode::LIVE)
        ->page(2)
        ->paymentStatus(PaymentStatus::PAID)
        ->productId(1234)
        ->productTag('color-blue')
        ->query('Lorem Ipsum')
        ->sinceInvoiceDate(new DateTimeImmutable())
        ->sincePaidAt(new DateTimeImmutable())
        ->sort(OrderSortType::PAID_AT)
        ->source(Source::API)
        ->untilInvoiceDate(new DateTimeImmutable())
        ->untilPaidAt(new DateTimeImmutable())
);
```

--------------------------------

### Billing include example

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Demonstrates retrieving billing information for a subscription by including SubscriptionIncludes::BILLING. Access address, contact, schedule, and payment options through the returned subscription object.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;

$client  = new Client($token);
$service = new SubscriptionService($client);

$subscriptionId = 1;
$subscription = $service->include(
    SubscriptionIncludes::BILLING
)->find($subscriptionId);

$address     = $subscription->address();

$city        = $address->city();
$country     = $address->country()->value;
$street      = $address->street();
$houseNumber = $address->houseNumber();
$zipcode     = $address->zipCode();

$contact     = $subscription->contact();

$company     = $contact->company();
$email       = $contact->email();
$firstName   = $contact->firstName();
$lastName    = $contact->lastName();
$telephone   = $contact->telephone();
$vatIdNumber = $contact->vatIdNumber();
$website     = $contact->website();

$schedule      = $subscription->schedule();

$interval      = $schedule->interal()->value;
$last          = $schedule->last();
$lastAt        = $schedule->lastAt()->format;
$latest        = $schedule->latest();
$latestAt      = $schedule->latestAt()->format;
$next          = $schedule->next();
$nextAt        = $schedule->nextAt()->format;
$remaining     = $schedule->remaining();
$terminationAt = $schedule->terminationAt()->format;

$paymentOptions = $subscription->paymentOptions();

$customerId     = $paymentOptions->customerId();
$mandateId      = $paymentOptions->mandateId();
$provider       = $paymentOptions->provider()->value;
$transactionId  = $paymentOptions->transactionId();
$type           = $paymentOptions->type()->value;
$iban           = $paymentOptions->iban();
$name           = $paymentOptions->name();
```

--------------------------------

### Index Products with ProductService->get() and include()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Products

Retrieves all Product models with related pricing and tax rate data. Requires a valid API token and the ProductService client.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;
use PlugAndPay\Sdk\Enum\ProductIncludes;

$client = new Client($token);
$service = new ProductService($client);

$products = $service->include(
    ProductIncludes::PRICING,
    ProductIncludes::TAX_RATES,
)->get();
```

--------------------------------

### Get all rules with RuleService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Rules

Retrieves all Rule models using the RuleService->get() method. Requires a Client instance with a valid token.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\RuleService;

$client = new Client($token);
$service = new RuleService($client);

$rules = $service->get();
```

--------------------------------

### Store subscription

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Creates a new subscription with billing, pricing, and contact details. Requires a Client instance and a product ID. The example sets up tax, pricing, billing schedule, payment options, address, contact, and billing entities before creating the subscription.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Entity\Subscription;
use PlugAndPay\Sdk\Entity\SubscriptionBilling;
use PlugAndPay\Sdk\Entity\Contact;
use PlugAndPay\Sdk\Entity\Address;
use PlugAndPay\Sdk\Entity\SubscriptionPaymentOptions;
use PlugAndPay\Sdk\Entity\SubscriptionBillingSchedule;
use PlugAndPay\Sdk\Entity\SubscriptionPricing;
use PlugAndPay\Sdk\Entity\Tax;
use PlugAndPay\Sdk\Enum\Interval;
use PlugAndPay\Sdk\Enum\CountryCode;
use PlugAndPay\Sdk\Enum\PaymentType;

$client              = new Client('your_access_token');
$subscriptionService = new SubscriptionService($client);

$tax = (new Tax())
    ->setAmount(10.00);

$pricing = (new SubscriptionPricing())
    ->setQuantity(10)
    ->setTax($tax);

$billingSchedule = (new SubscriptionBillingSchedule())
    ->setInterval(Interval::MONTHLY)
    ->setNextAt(new \DateTimeImmutable());

$paymentOptions = (new SubscriptionPaymentOptions())
    ->setType(PaymentType::MANUAL);

$address = (new Address())
    ->setCountry(CountryCode::NL);

$contact = (new Contact())
    ->setFirstName('Last')
    ->setLastName('Last')
    ->setEmail('email@email.com');

$billing = (new SubscriptionBilling())
    ->setContact($contact)
    ->setAddress($address)
    ->setPaymentOptions($paymentOptions)
    ->setSchedule($billingSchedule);

$subscription = (new Subscription())
    ->setBilling($billing)
    ->setPricing($pricing)
    ->setProductId(7);

$subscription   = $subscriptionService->create($subscription);
$subscriptionId = $subscription->id();
```

--------------------------------

### Tags include example

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Shows how to retrieve tags for a subscription by including SubscriptionIncludes::TAGS. Access the tags collection through the subscription's tags() method.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;

$client  = new Client($token);
$service = new SubscriptionService($client);

$subscriptionId = 1;
$subscription = $service->include(
    SubscriptionIncludes::TAGS
)->find($subscriptionId);

$tags = $subscription->tags();
```

--------------------------------

### Get all checkouts with CheckoutService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Checkouts

Retrieves all Checkout models using the CheckoutService->get() method. Requires a Client instance with a valid token.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\CheckoutService;

$client = new Client($token);
$service = new CheckoutService($client);

$checkouts = $service->get();
```

--------------------------------

### Create a checkout with CheckoutService->create()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Checkouts

Creates a new Checkout model using the CheckoutService->create() method. The example sets all available properties on the Checkout object before passing it to the service.

```php
use PlugAndPay\Sdk\Model\Checkout;
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\CheckoutService;

$client = new Client($token);
$service = new CheckoutService($client);

$checkout = (new Checkout())
    ->setIsActive(true)
    ->setIsExpired(false)
    ->setName('Checkout Name')
    ->setPreviewUrl('https://preview-url.com')
    ->setPrimaryColor('#000000')
    ->setProductId(1)
    ->setReturnUrl('https://return-url.com')
    ->setSecondaryColor('#ffffff')
    ->setSlug('checkout-slug')
    ->setUrl('https://url.com');

$service->create($checkout);
```

--------------------------------

### ProductService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Products

Retrieves a list of products with optional includes and filters.

```APIDOC
## ProductService->get()

### Description
Retrieves a collection of Product models. Supports including related model relations via the include() method and applying filters via ProductFilter.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **direction** (Direction enum) - Optional - Sort direction (ASC or DESC).
- **hasLimitedStock** (boolean) - Optional - Filter products with limited stock.
- **isDeleted** (boolean) - Optional - Filter deleted products.
- **limit** (integer) - Optional - Maximum number of products to return.
- **page** (integer) - Optional - Page number for pagination.
- **query** (string) - Optional - Search query.
- **sort** (ProductSortType enum) - Optional - Sort field.
- **tag** (array of strings) - Optional - Filter by tags.
- **type** (ContractType enum) - Optional - Filter by contract type.

### Request Example
```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;
use PlugAndPay\Sdk\Enum\ProductIncludes;

$client = new Client($token);
$service = new ProductService($client);

$products = $service->include(
    ProductIncludes::PRICING,
    ProductIncludes::TAX_RATES,
)->get();
```

### Response
#### Success Response (200)
- **products** (array of Product) - List of Product models.

#### Response Example
```json
{
  "products": []
}
```
```

--------------------------------

### Create a Memberships Setting with MembershipsSettingService->create()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Memberships

Creates a new Memberships Setting model using the MembershipsSettingService->create() method. The example sets driver, isActive, tenantId, and apiToken fields before creation.

```php
use PlugAndPay\Sdk\Model\MembershipsSetting;
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\MembershipsSettingService;

$client = new Client($token);
$service = new MembershipsSettingService($client);

$membershipsSetting = (new MembershipsSetting())
    ->setDriver('huddle')
    ->setIsActive(true)
    ->setTenantId(1)
    ->setApiToken(null);

$membershipsSetting = $service->create($membershipsSetting);
```

--------------------------------

### Get one product

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Fetches a single product by its ID.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;

$client         = new Client('your_access_token');
$productService = new ProductService($client);

$productId = 1;
$product   = $productService->find($productId);
```

--------------------------------

### Store Order with OrderService->create()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Build a complete Order entity with billing, comments, discounts, items, payment, tags, and taxes, then persist it via OrderService->create(). The example sets a test mode, a manual Mollie payment, and a reverse-charge tax exemption; the created order's ID is retrieved afterward.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Enum\OrderIncludes;
use PlugAndPay\Sdk\Entity\Address;
use PlugAndPay\Sdk\Entity\Billing;
use PlugAndPay\Sdk\Entity\Comment;
use PlugAndPay\Sdk\Entity\Contact;
use PlugAndPay\Sdk\Entity\Item;
use PlugAndPay\Sdk\Entity\Order;
use PlugAndPay\Sdk\Entity\Payment;
use PlugAndPay\Sdk\Entity\Tax;
use PlugAndPay\Sdk\Entity\OrderBilling;
use PlugAndPay\Sdk\Entity\Discount;
use PlugAndPay\Sdk\Enum\OrderIncludes;
use PlugAndPay\Sdk\Enum\PaymentStatus;
use PlugAndPay\Sdk\Enum\PaymentProvider;
use PlugAndPay\Sdk\Enum\TaxExempt;
use PlugAndPay\Sdk\Enum\CountryCode;
use PlugAndPay\Sdk\Enum\PaymentType;
use PlugAndPay\Sdk\Enum\Source;
use PlugAndPay\Sdk\Enum\Mode;
use PlugAndPay\Sdk\Enum\PaymentMethod;
use PlugAndPay\Sdk\Enum\DiscountType;
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;

$client = new Client($token);
$service = new OrderService($client);

$tax = (new Tax())->setRateId(1);

$payment = (new Payment)
    ->setCustomerId('customer-id')
    ->setMandateId('mandate-id')
    ->setMethod(PaymentMethod::APPLEPAY)
    ->setPaidAt(new DateTimeImmutable('2022-01-01'))
    ->setProvider(PaymentProvider::MOLLIE)
    ->setStatus(PaymentStatus::PAID)
    ->setTransactionId('mollie-transaction-id')
    ->setType(PaymentType::MANUAL)
    ->setUrl('https://www.payment-url.com');

$discount = (new Discount())
    ->setAmount(10)
    ->setCode('discount-code')
    ->setType(DiscountType::PROMOTION);

$itemOne = (new Item())->setProductId(1);

$itemTwo = (new Item())->setProductId(2);

$contact = (new Contact())
    ->setCompany('Plug&Pay')
    ->setEmail('testing@plugandpay.nl')
    ->setFirstName('test')
    ->setLastName('the tester')
    ->setTaxExempt(TaxExempt::REVERSE)
    ->setTelephone('06-89754785')
    ->setWebsite('https://www.plugandpay.nl');

$address = (new Address())
    ->setCity('Test')
    ->setCountry(CountryCode::NL)
    ->setStreet('teststreet')
    ->setHouseNumber('230-1')
    ->setZipcode('2323DD');

$commentOne = (new Comment())->setValue('Comment One');
$commentTwo = (new Comment())->setValue('Comment Two');

$billing = (new OrderBilling())
    ->setAddress($address)
    ->setContact($contact);

$order = (new Order)
    ->setAmount(100)
    ->setTotal(121)
    ->setBilling($billing)
    ->setComments([
        $commentOne,
        $commentTwo,
    ])
    ->setTotalDiscounts([$discount])
    ->setHidden(false)
    ->setItems([
        $itemOne,
        $itemTwo,
    ])
    ->setMode(Mode::TEST)
    ->setPayment($payment)
    ->setReference('123456789')
    ->setSource(Source::API)
    ->setTags([
        'first',
        'second',
        'third',
        'fourth',
    ])
    ->setTaxes([$tax]);

$order = $service->include(
    OrderIncludes::BILLING,
    OrderIncludes::COMMENTS,
    OrderIncludes::DISCOUNTS,
    OrderIncludes::ITEMS,
    OrderIncludes::PAYMENT,
    OrderIncludes::TAGS,
    OrderIncludes::TAXES,
)->create($order);

$orderId = $order->id();
```

--------------------------------

### Get all orders

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Retrieves all orders using the OrderService.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;

$client       = new Client('your_access_token');
$orderService = new OrderService($client);

$orders = $orderService->get();
```

--------------------------------

### CheckoutService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Checkouts

Retrieves all Checkout models using the CheckoutService.

```APIDOC
## CheckoutService->get()

### Description
Retrieves all Checkout models.

### Method
GET

### Endpoint
/checkouts

### Parameters
None

### Request Example
```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\CheckoutService;

$client = new Client($token);
$service = new CheckoutService($client);

$checkouts = $service->get();
```

### Response
#### Success Response (200)
- **checkouts** (array) - List of Checkout models

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Checkout Name",
    "isActive": true,
    "isExpired": false,
    "previewUrl": "https://preview-url.com",
    "primaryColor": "#000000",
    "productId": 1,
    "returnUrl": "https://return-url.com",
    "secondaryColor": "#ffffff",
    "slug": "checkout-slug",
    "url": "https://url.com"
  }
]
```
```

--------------------------------

### Index Tax Rates with TaxRateService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/TaxRates

Retrieves all TaxRate models filtered by country using the TaxRateService. The filter is set to the Netherlands (CountryCode::NL) and the include() method is chained before get().

```php
use PlugAndPay\Sdk\Enum\TaxRateIncludes;
use PlugAndPay\Sdk\Filters\TaxRateFilter;
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\TaxRateService;

$client  = new Client($token);
$service = new TaxRateService($client);

$filter   = (new TaxRateFilter())->country(CountryCode::NL);
$taxRates = $service->include()->get($filter);
```

--------------------------------

### Get all subscriptions

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Retrieves a list of all subscriptions using the SubscriptionService. Requires a Client instance with an access token.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;

$client              = new Client('your_access_token');
$subscriptionService = new SubscriptionService($client);

$subscriptions = $subscriptionService->get();
```

--------------------------------

### Filter Products with ProductFilter and ProductService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Products

Applies filters to the product list, including direction, stock, deletion status, pagination, search query, sorting, tags, and contract type. Requires a valid token and the ProductFilter service.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;
use PlugAndPay\Sdk\Filters\ProductFilter;
use PlugAndPay\Sdk\Enum\Interval;
use PlugAndPay\Sdk\Enum\CountryCode;
use PlugAndPay\Sdk\Enum\Mode;
use PlugAndPay\Sdk\Enum\SubscriptionStatus;
use PlugAndPay\Sdk\Enum\ContractType;
use PlugAndPay\Sdk\Enum\Direction;
use PlugAndPay\Sdk\Enum\ProductSortType;
use PlugAndPay\Sdk\Enum\ContractType;

$client  = new Client($token);
$service = new ProductFilter($client);

$subscriptions = $service->get(
    (new ProductFilter())
        ->direction(Direction::ASC)
        ->hasLimitedStock(true)
        ->isDeleted(false)
        ->limit(10)
        ->page(1)
        ->query('Lorem')
        ->sort(ProductSortType::ACTIVE_SUBSCRIPTIONS)
        ->tag(['first'])
        ->type(ContractType::INSTALLMENTS)
);
```

--------------------------------

### Update Subscription with SubscriptionService->update()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Use this snippet to update an existing subscription in the Plug and Pay dashboard. It requires a valid $token and a subscription ID. The example sets mode, tags, status, source, pricing, product, billing address, contact, schedule, payment options, and trial details. Note that the code references an undefined Interval class; ensure it is imported or defined in your project.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Entity\Subscription;
use PlugAndPay\Sdk\Enum\Mode;
use PlugAndPay\Sdk\Enum\SubscriptionStatus;
use PlugAndPay\Sdk\Enum\Source;
use PlugAndPay\Sdk\Enum\CountryCode;
use PlugAndPay\Sdk\Enum\PaymentProvider;
use PlugAndPay\Sdk\Enum\PaymentType;

$client  = new Client($token);
$service = new SubscriptionService($client);

$subscriptionId = 1;
$subscription = $service->update($subscriptionId, function (Subscription $subscription) {
    $subscription->setMode(Mode::LIVE);
    $subscription->setTags([
        'first',
        'second',
        'third'
    ]);
    $subscription->setStatus(SubscriptionStatus::ACTIVE);
    $subscription->setSource(Source::API);

    // Pricing
    $subscription->pricing()
        ->setAmount(100.00)
        ->setQuantity(10)
        ->tax()
            ->setAmount(100)
            ->rate()->setId(10);

    // Product
    $subscription->product()->setId(6);

    // Billing address
    $subscription->billing()->address()
        ->setCity('lorem')
        ->setCountry(CountryCode::BE)
        ->setStreet('testing')
        ->setHouseNumber('230-1')
        ->setZipcode('1212DD');

    // Billing contact
    $subscription->billing()->contact()
        ->setCompany('test')
        ->setEmail('test@test.com')
        ->setFirstName('First')
        ->setLastName('Name')
        ->setTelephone('03464646146')
        ->setWebsite('test.com');

    // Billing schedule
    $subscription->billing()->schedule()
        ->setInterval(Interval::MONTHLY)
        ->setLast(12)
        ->setLastAt(new DateTimeImmutable('2022-01-01'))
        ->setLatest(1)
        ->setLatestAt(new DateTimeImmutable('2022-02-01'))
        ->setNext(1)
        ->setNextAt(new DateTimeImmutable())
        ->setRemaining(54);

    // Billing payment options
    $subscription->billing()->paymentOptions()
        ->setCustomerId('asdasd')
        ->setProvider(PaymentProvider::MOLLIE)
        ->setTransactionId(12345)
        ->setType(PaymentType::MANDATE)
        ->setIban('NL18RABO0123459876')
        ->setName('Test the Tester');

    // Trial
    $subscription->trial()
        ->setEndDate(new DateTimeImmutable('2022-12-01'))
        ->setIsActive(true)
        ->setEndDate(new DateTimeImmutable('2022-01-01'));
});
```

--------------------------------

### Accessing Discounts with OrderIncludes::DISCOUNTS

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Include `OrderIncludes::DISCOUNTS` to access order discounts. The example retrieves the first total discount or a discount from an item, and shows how to access amount, code, and type.

```PHP
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Enum\OrderIncludes;

$client  = new Client($token);
$service = new OrderService($client);

$orderId = 1;
$order = $service->include(
    OrderIncludes::DISCOUNTS
)->find($orderId);

$discount = $order->totalDiscounts()[0];
// Or receive a discount from an item:
$discount = $order->items()[0]->discounts()[0];

$value    = $discount->amount();
$code     = $discount->code();
$type     = $discount->type()->value;
```

--------------------------------

### Filter subscriptions with SubscriptionFilter

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Filters subscriptions using the SubscriptionFilter class. The example shows all available filter methods, including affiliateId, billingScheduleInterval, country, hasOrders, isTrial, limit, mode, page, productId, isFirst, query, sinceCreatedAt, status, tag, type, and untilCreatedAt.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Filters\SubscriptionFilter;
use PlugAndPay\Sdk\Enum\Interval;
use PlugAndPay\Sdk\Enum\CountryCode;
use PlugAndPay\Sdk\Enum\Mode;
use PlugAndPay\Sdk\Enum\SubscriptionStatus;
use PlugAndPay\Sdk\Enum\ContractType;

$client  = new Client($token);
$service = new SubscriptionFilter($client);

$subscriptions = $service->get(
    (new SubscriptionFilter)
        ->affiliateId(1234)
        ->billingScheduleInterval(Interval::MONTHLY)
        ->billingScheduleLatestAt(new DateTimeImmutable('2022-01-01'))
        ->billingScheduleNextAt(new DateTimeImmutable('2022-01-01'))
        ->country(CountryCode::NL)
        ->hasOrders(true)
        ->isTrial(true)
        ->limit(10)
        ->mode(Mode::TEST)
        ->page(1)
        ->productId(1)
        ->isFirst(true)
        ->query('Lorem ipsum')
        ->sinceCreatedAt(new DateTimeImmutable('2022-01-01'))
        ->status(SubscriptionStatus::ACTIVE)
        ->tag(['lorem'])
        ->type(ContractType::INSTALLMENTS)
        ->untilCreatedAt(new DateTimeImmutable('2022-01-01'))
);
```

--------------------------------

### Accessing Taxes with OrderIncludes::TAXES

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Include `OrderIncludes::TAXES` to access tax information. The example shows how to retrieve all taxes and tax per item, including amount and rate percentage.

```PHP
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Enum\OrderIncludes;

$client  = new Client($token);
$service = new OrderService($client);

$orderId = 1;
$order = $service->include(
    OrderIncludes::TAXES
)->find($orderId);

// All taxes
$tax = $order->taxes()[0];
$tax->amount()
$tax->rate()->percentage()

// Tax per item
$item              = $order->items()[0];
$itemTaxValue      = $item->tax()->amount();
$itemTaxPercentage = $item->tax()->rate()->percentage();
```

--------------------------------

### RuleService->get()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Rules

Retrieves all Rule models. Returns a collection of Rule objects.

```APIDOC
## RuleService->get()

### Description
Retrieves all Rule models.

### Method
GET

### Endpoint
Not specified

### Parameters
None

### Request Example
```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\RuleService;

$client = new Client($token);
$service = new RuleService($client);

$rules = $service->get();
```

### Response
#### Success Response (200)
- **rules** (array of Rule) - List of Rule models

#### Response Example
Not specified
```

--------------------------------

### Create a rule with RuleService->create()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Rules

Creates a new Rule model using the RuleService->create() method. The example sets action type to 'call_webhook', trigger type to 'order_paid', and includes a webhook URL and product ID condition.

```php
use PlugAndPay\Sdk\Model\Rule;
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\RuleService;

$client = new Client($token);
$service = new RuleService($client);

$rule = (new Rule())
    ->setActionType('call_webhook')
    ->setActionData(['url' => 'https://example.com/webhook'])
    ->setTriggerType('order_paid')
    ->setConditionData(['product_id' => [1]])
    ->setName('Plug&Pay Example Rule')
    ->setDriver('webhook')

$rule = $service->create($rule);
```

--------------------------------

### Get one subscription

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Fetches a single subscription by its ID using the find method. Requires a Client instance and a valid subscription ID.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;

$client              = new Client('your_access_token');
$subscriptionService = new SubscriptionService($client);

$subscriptionId = 1;
$subscription   = $subscriptionService->find($subscriptionId);
```

--------------------------------

### Including Multiple Extra Information with OrderIncludes

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Use the `include` method on `OrderService` with `OrderIncludes` enum values to request additional order data. Only request the information you need. The example fetches an order with billing, comments, discounts, items, payment, tags, and taxes included.

```PHP
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Enum\OrderIncludes;

$client  = new Client($token);
$service = new OrderService($client);

$orderId = 1;
$service->include(
    OrderIncludes::BILLING,
    OrderIncludes::COMMENTS,
    OrderIncludes::DISCOUNTS,
    OrderIncludes::ITEMS,
    OrderIncludes::PAYMENT,
    OrderIncludes::TAGS,
    OrderIncludes::TAXES,
)->find($orderId);
```

--------------------------------

### Retrieve subscriptions with includes using SubscriptionService

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Retrieves all subscription models with related model relations included. Use the SubscriptionService->include() method to specify which relations to load, then call get() to execute the request.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;

$client = new Client($token);
$service = new SubscriptionService($client);

$subscriptions = $service->include(
    SubscriptionIncludes::BILLING,
    SubscriptionIncludes::PRICING,
    SubscriptionIncludes::PRODUCT,
    SubscriptionIncludes::TAGS,
    SubscriptionIncludes::TRIAL,
)->get();
```

--------------------------------

### Accessing Items with OrderIncludes::ITEMS

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Include `OrderIncludes::ITEMS` to access order items. The example shows how to retrieve item properties such as discounts, id, label, productId, quantity, amount, and type.

```PHP
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Enum\OrderIncludes;

$client  = new Client($token);
$service = new OrderService($client);

$orderId = 1;
$order = $service->include(
    OrderIncludes::ITEMS
)->find($orderId);

$item = $order->items()[0];

$discount      = $item->discounts()[0]->amount();
$discountCode  = $item->discounts()[0]->code();
$id            = $item->id();
$label         = $item->label();
$productId     = $item->productId();
$quantity      = $item->quantity();
$amount        = $item->amount();
$amountWithTax = $item->amountWithTax();
$amountWithTax = $item->type()->value;
```

--------------------------------

### Create a product with ProductService->create() and include()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Products

Builds a Product model with stock, tax, shipping, tiered pricing, and subscription type, then creates it via ProductService->include() and create(). Requires a valid $token for the Client constructor.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;
use PlugAndPay\Sdk\Entity\Stock;
use PlugAndPay\Sdk\Entity\TaxRate;
use PlugAndPay\Sdk\Entity\PricingTax;
use PlugAndPay\Sdk\Entity\Shipping;
use PlugAndPay\Sdk\Entity\PriceTier;
use PlugAndPay\Sdk\Entity\PriceRegular;
use PlugAndPay\Sdk\Entity\PriceFirst;
use PlugAndPay\Sdk\Entity\Price;
use PlugAndPay\Sdk\Entity\ProductPricing;
use PlugAndPay\Sdk\Entity\Product;
use PlugAndPay\Sdk\Enum\ProductIncludes;

$client = new Client($token);
$service = new ProductService($client);

$stock = (new Stock())
    ->setEnabled(true)
    ->setHidden(false)
    ->setValue(100);

$taxRate = (new TaxRate())
    ->setId(1);

$pricingTax = (new PricingTax())
    ->setRate($taxRate);

$shipping = (new Shipping())
    ->setAmount(100.00);

$tierOne = (new PriceTier())
    ->setAmount(100.00)
    ->setQuantity(10);

$tierTwo = (new PriceTier())
    ->setAmount(10.00)
    ->setQuantity(100);

$priceRegular = (new PriceRegular())
    ->setAmount(400.00);

$priceFirst = (new PriceFirst())
    ->setAmount(100.00);

$priceOne = (new Price())
    ->setFirst($priceFirst)
    ->setRegular($priceRegular)
    ->setInterval(Interval::QUARTERLY)
    ->setSuggested(true)
    ->setTiers([
        $tierOne,
        $tierTwo,
    ]);

$priceTwo = (new Price())
    ->setFirst($priceFirst)
    ->setRegular($priceRegular)
    ->setInterval(Interval::MONTHLY)
    ->setSuggested(true)
    ->setTiers([
        $tierOne,
        $tierTwo,
    ]);

$productPricing = (new ProductPricing())
    ->setTaxIncluded(true)
    ->setPrices([$priceOne, $priceTwo])
    ->setShipping($shipping)
    ->setTax($pricingTax);

$product = (new Product)
    ->setDescription('lorem ipsum')
    ->setLedger(99998)
    ->setPhysical(true)
    ->setPricing($productPricing)
    ->setPublicTitle('Lorem Ipsum')
    ->setSku('123-sku')
    ->setSlug('lorem-ipsum')
    ->setStock($stock)
    ->setTitle('Lorem Ipsum')
    ->setType(ContractType::SUBSCRIPTION);

$product = $service->include(
    ProductIncludes::PRICING,
    ProductIncludes::TAX_RATES,
)->create($product);
```

--------------------------------

### Include Order Relations with OrderService->include()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Use the OrderService->include() method to extract model relation values. The OrderService->get() method can extract all Order models. This example includes billing, comments, discounts, items, payment, tags, and taxes relations.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Enum\OrderIncludes;

$client = new Client($token);
$service = new OrderService($client);

$orders = $service->include(
    OrderIncludes::BILLING,
    OrderIncludes::COMMENTS,
    OrderIncludes::DISCOUNTS,
    OrderIncludes::ITEMS,
    OrderIncludes::PAYMENT,
    OrderIncludes::TAGS,
    OrderIncludes::TAXES,
)->get();
```

--------------------------------

### Show Product with ProductService->find() and include()

Source: https://github.com/plug-and-pay/sdk-php/wiki/Products

Fetches a single Product model by its ID, including pricing and tax rate relations. Requires a valid token and the ProductService client.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;
use PlugAndPay\Sdk\Enum\ProductIncludes;

$client = new Client($token);
$service = new ProductService($client);

$productId = 1;
$product = $service->include(
    ProductIncludes::PRICING,
    ProductIncludes::TAX_RATES,
)->find($productId);
```

--------------------------------

### Get one order

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Fetches a single order by its ID.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;

$client       = new Client('your_access_token');
$orderService = new OrderService($client);

$orderId = 1;
$orders  = $orderService->find($orderId);
```

--------------------------------

### Create Plug&Pay client

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Creates a Plug&Pay client using an access token. Required before using any service.

```php
use PlugAndPay\Sdk\Service\Client;

$client = new Client('your_access_token');
```

--------------------------------

### Store product

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Creates a new product with a title and physical flag, then retrieves its ID.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;
use PlugAndPay\Sdk\Entity\Product;

$client         = new Client('your_access_token');
$productService = new ProductService($client);

$product = (new Product())
    ->setTitle('Product Title')
    ->setPhysical(false);

$product = $productService->create($product);

$productId = $product->id();
```

--------------------------------

### Include extra product information with ProductService::include

Source: https://github.com/plug-and-pay/sdk-php/wiki/Products

Fetches a product with additional information (pricing, shipping) using the include method. Only request the information you need.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\ProductService;
use PlugAndPay\Sdk\Enum\ProductIncludes;

$client  = new Client($token);
$service = new ProductService($client);

$productId = 1;
$service->include(
    ProductIncludes::PRICING,
    ProductIncludes::SHIPPING,
)->find($productId);
```

--------------------------------

### ProductService::include

Source: https://github.com/plug-and-pay/sdk-php/wiki/Products

Retrieves a product with additional information using the include method.

```APIDOC
## [GET] /products/{id}

### Description
Retrieves a product with additional information using the include method.

### Method
GET

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the product to retrieve.

#### Query Parameters
- **include** (array) - Optional - Additional information to include. Possible values: PRICING, SHIPPING.

### Response
#### Success Response (200)
No response body is documented.

```

--------------------------------

### Update subscription

Source: https://github.com/plug-and-pay/sdk-php/wiki/Quickstart

Updates an existing subscription by ID using a callback that modifies the subscription entity. The example sets the mode to Mode::TEST.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Entity\Subscription;
use PlugAndPay\Sdk\Enum\Mode;

$client              = new Client('your_access_token');
$subscriptionService = new SubscriptionService($client);

$subscriptionId = 1;
$subscriptionService->update(
    $subscriptionId,
    fn(Subscription $subscription) => $subscription->setMode(Mode::TEST)
);
```

--------------------------------

### Show Subscription with includes

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Fetches a subscription by ID using SubscriptionService->include() and ->find(), loading related billing, meta, pricing, product, tags, and trial data. Then retrieves and displays various subscription properties.

```php
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SubscriptionService;
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;

$client = new Client($token);
$service = new SubscriptionService($client);

$subscriptionId = 40;
$subscription = $service->include(
    SubscriptionIncludes::BILLING,
    SubscriptionIncludes::META,
    SubscriptionIncludes::PRICING,
    SubscriptionIncludes::PRODUCT,
    SubscriptionIncludes::TAGS,
    SubscriptionIncludes::TRIAL,
)->find($subscriptionId);

$id          = $subscription->id();
$cancelledAt = $subscription->cancelledAt();
$createdAt   = $subscription->createdAt();
$deletedAt   = $subscription->deletedAt();
$mode        = $subscription->mode()->value;
$pricing     = $subscription->pricing();
$product     = $subscription->product();
$status      = $subscription->status();
$source      = $subscription->source();
$billing     = $subscription->billing();
$tags        = $subscription->tags();
$trial       = $subscription->trial();
```

--------------------------------

### Accessing Comments with OrderIncludes::COMMENTS

Source: https://github.com/plug-and-pay/sdk-php/wiki/Orders

Include `OrderIncludes::COMMENTS` to access order comments. The example retrieves the first comment and its `createdAt`, `id`, `updatedAt`, and `value` properties.

```PHP
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\OrderService;
use PlugAndPay\Sdk\Enum\OrderIncludes;

$client  = new Client($token);
$service = new OrderService($client);

$orderId = 1;
$order = $service->include(
    OrderIncludes::COMMENTS
)->find($orderId);

$comment = $order->comments()[0];

$createdAt = $comment->createdAt();
$id        = $comment->id();
$updatedAt = $comment->updatedAt();
$value     = $comment->value();
```

--------------------------------

### Use Predefined Mock Client for Show with Billing

Source: https://github.com/plug-and-pay/sdk-php/wiki/Mocking

Use OrderShowMockClient to mock a find request and access the billing data. The client is initialized with an ID and then the billing method is called.

```php
use PlugAndPay\Sdk\Tests\Feature\Order\Mock\OrderShowMockClient;
use PlugAndPay\Sdk\Service\OrderService;

$client = (new OrderShowMockClient(['id' => 1]))->billing();
$order  = (new OrderService($client))->find(1);

$billing = $order->billing();
```

--------------------------------

### Include method with SubscriptionIncludes

Source: https://github.com/plug-and-pay/sdk-php/wiki/Subscriptions

Shows how to configure the SubscriptionService to include multiple subscription details in a single request using the include method with SubscriptionIncludes constants. Use this to fetch pricing, billing, meta, product, tags, and trial data together.

```php
use PlugAndPay\Sdk\Enum\SubscriptionIncludes;
use PlugAndPay\Sdk\Service\Client;
use PlugAndPay\Sdk\Service\SusbcriptionService;

$client  = new Client($token);
$service = new SusbcriptionService($client);

$service->include(
    SubscriptionIncludes::PRICING,
    SubscriptionIncludes::BILLING,
    SubscriptionIncludes::META,
    SubscriptionIncludes::PRODUCT,
    SubscriptionIncludes::TAGS,
    SubscriptionIncludes::TRIAL,
);
```
Tokens:
Raw