Allow access upcoming invoice from Subscription (#532)

CHANGELOG.md

@@ -17,6 +17,12 @@ Security - in case of vulnerabilities.
 
 _TBD_
 
+## [2.18.0] 2022-04-21
+
+### Added
+
+- [x] Added `Subscription::getUpcomingInvoice()` method
+
 ## [2.17.0] 2022-04-20
 
 ### Added

src/Client.php

@@ -102,7 +102,7 @@ final class Client
      */
     public const CURRENT_VERSION = 'v2.1';
 
-    public const SDK_VERSION = '2.17.0';
+    public const SDK_VERSION = '2.18.0';
 
     private static $services = [
         'authenticationOptions' => Services\AuthenticationOptionsService::class,

src/Entities/Subscription.php

@@ -518,6 +518,18 @@ public function getWebsite()
             : null;
     }
 
+    /**
+     * @return null|Invoice
+     */
+    public function getUpcomingInvoice()
+    {
+        $data = $this->getEmbeddedResource('upcomingInvoice');
+
+        return $data
+            ? new Invoice($data)
+            : null;
+    }
+
     /**
      * @return null|Customer
      */

tests/Entities/Subscriptions/SubscriptionTest.php

@@ -14,6 +14,7 @@
 use DateTimeImmutable;
 use Rebilly\Entities\Address;
 use Rebilly\Entities\Customer;
+use Rebilly\Entities\Invoice;
 use Rebilly\Entities\LeadSource;
 use Rebilly\Entities\PaymentRetryInstructions\ScheduleInstruction;
 use Rebilly\Entities\PaymentRetryInstructions\ScheduleInstructionTypes\DateIntervalType;
@@ -81,6 +82,7 @@ private static function getDefaultData()
                 'website' => ['id' => 'website-1'],
                 'customer' => ['id' => 'customer-1'],
                 'leadSource' => ['id' => 'leadSource-1'],
+                'upcomingInvoice' => ['id' => 'invoice-1'],
             ],
         ];
     }
@@ -187,6 +189,7 @@ public function populatePlanFromArrayReceivedFromServer()
         self::assertInstanceOf(Website::class, $value->getWebsite());
         self::assertInstanceOf(Customer::class, $value->getCustomer());
         self::assertInstanceOf(LeadSource::class, $value->getLeadSource());
+        self::assertInstanceOf(Invoice::class, $value->getUpcomingInvoice());
 
         $invoiceTimeShift = $value->getInvoiceTimeShift();
         self::assertInstanceOf(InvoiceTimeShift::class, $invoiceTimeShift);