Add support for new Event Meters

src/Subscription.php

@@ -8,6 +8,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
 use InvalidArgumentException;
 use Laravel\Cashier\Concerns\AllowsCoupons;
 use Laravel\Cashier\Concerns\HandlesPaymentFailures;
@@ -563,9 +564,12 @@ public function reportUsage($quantity = 1, $timestamp = null, $price = null)
      * @return MeterEvent
      * @throws ApiErrorException
      */
-    public function reportMeterUsage(string $meter, int $quantity = 1, ?string $price = null): MeterEvent
+    public function reportEventUsage(string $meter, int $quantity = 1, ?string $price = null): MeterEvent
     {
-        return $this->findItemOrFail($price ?? $this->stripe_price)->reportMeterUsage($meter, $quantity);
+        if (! $price) {
+            $this->guardAgainstMultiplePrices();
+        }
+        return $this->findItemOrFail($price ?? $this->stripe_price)->reportEventUsage($meter, $quantity);
     }
 
     /**
@@ -591,9 +595,9 @@ public function reportUsageFor($price, $quantity = 1, $timestamp = null)
      * @return MeterEvent
      * @throws ApiErrorException
      */
-    public function reportUsageForMeter(string $meter, string $price, int $quantity = 1): MeterEvent
+    public function reportUsageForEvent(string $eventName, string $price, int $quantity = 1): MeterEvent
     {
-        return $this->reportMeterUsage($meter, $quantity, $price);
+        return $this->reportEventUsage($eventName, $quantity, $price);
     }
 
     /**
@@ -612,6 +616,25 @@ public function usageRecords(array $options = [], $price = null)
         return $this->findItemOrFail($price ?? $this->stripe_price)->usageRecords($options);
     }
 
+
+    /**
+     * Get the usage records for a meter using its ID (not name).
+     *
+     * @param string $meterId
+     * @param array $options
+     * @param null $price
+     * @return Collection
+     * @throws ApiErrorException
+     */
+    public function meterUsageRecords(string $meterId, array $options = [], $price = null): Collection
+    {
+        if (! $price) {
+            $this->guardAgainstMultiplePrices();
+        }
+
+        return $this->findItemOrFail($price ?? $this->stripe_price)->eventUsageRecord($meterId, $options);
+    }
+
     /**
      * Get the usage records for a specific price of a metered product.
      *

src/SubscriptionItem.php

@@ -231,7 +231,7 @@ public function reportUsage($quantity = 1, $timestamp = null)
      * @return MeterEvent
      * @throws ApiErrorException
      */
-    public function reportMeterUsage(string $meter, int $quantity = 1): MeterEvent
+    public function reportEventUsage(string $meter, int $quantity = 1): MeterEvent
     {
         return $this->subscription->owner->stripe()->billing->meterEvents->create([
             'event_name' => $meter,
@@ -255,6 +255,47 @@ public function usageRecords($options = [])
         )->data);
     }
 
+    /**
+     * List all the metered prices for the subscription item.
+     * @see https://stripe.com/docs/api/prices/list
+     *
+     * @param array|null $params
+     * @param array|null $opts
+     *
+     * @return Collection
+     * @throws ApiErrorException
+     */
+    public function listMeters(?array $params = [], ?array $opts = []): Collection
+    {
+        return new Collection($this->subscription->owner->stripe()->billing->meters->all($params, $opts)->data);
+    }
+
+    /**
+     * @param string $meterId
+     * @param array|null $params
+     * @param array|null $opts
+     * @return Collection
+     * @throws ApiErrorException
+     */
+    public function eventUsageRecord(string $meterId, ?array $params = [], ?array $opts = []): Collection
+    {
+        $startTime = $params['start_time'] ?? $this->subscription->created_at->timestamp;
+        $endTime = $params['end_time'] ?? time();
+
+        unset($params['start_time'], $params['end_time']);
+
+        $params = [
+            'customer' => $this->subscription->owner->stripeId(),
+            'start_time' => $startTime,
+            'end_time' => $endTime,
+            ...$params
+        ];
+
+        return new Collection($this->subscription->owner->stripe()->billing->meters->allEventSummaries(
+            $meterId, $params, $opts
+        )->data);
+    }
+
     /**
      * Update the underlying Stripe subscription item information for the model.
      *