Merge pull request #12 from anikeen-com/feature/monthly-cap

Document monthly_cap, predecessor_id and expected_monthly_price

src/Id/Resources/AppCheckoutSessions.php

@@ -32,6 +32,8 @@ class AppCheckoutSessions
      *         description?: null|string,
      *         unit: string,
      *         price: float|string,
+     *         monthly_cap?: null|float|string,
+     *         predecessor_id?: null|string,
      *         vat_rate?: float,
      *         payload?: null|array,
      *         ends_at?: null|string

src/Id/Resources/AppSubscription.php

@@ -17,6 +17,9 @@ use JsonSerializable;
  * @property ?string $description
  * @property string $unit
  * @property float $price
+ * @property ?float $monthly_cap net, at most this per calendar month (hour and day units)
+ * @property ?float $expected_monthly_price gross estimate for a month (720 hours, at most the monthly cap)
+ * @property ?string $predecessor_id the subscription this one replaced (a resize); they share the monthly cap
  * @property ?float $vat_rate
  * @property bool $active
  * @property bool $autorenew

src/Id/Resources/AppSubscriptions.php

@@ -44,12 +44,18 @@ class AppSubscriptions
      *     description?: null|string,
      *     unit: string,
      *     price: float|string,
+     *     monthly_cap?: null|float|string,
+     *     predecessor_id?: null|string,
      *     vat_rate?: float,
      *     payload?: null|array,
      *     ends_at?: null|string,
      *     idempotency_key?: null|string
      * } $attributes With an idempotency_key (max. 191 characters), a retried call returns the
      *               subscription created by the first one instead of a duplicate.
+     *               monthly_cap: net, at most this per calendar month (hour and day units only,
+     *               at most 2 decimals, not below price; null = no cap).
+     *               predecessor_id: the subscription this one replaces (a resize; same user and
+     *               app, checked out, not cancelled): both share the monthly cap within a month.
      *
      * @throws ApiException
      */

src/Id/Resources/Subscription.php

@@ -13,6 +13,9 @@ use Throwable;
  * @property string $description
  * @property string $unit
  * @property float $price
+ * @property ?float $monthly_cap net, at most this per calendar month (hour and day units)
+ * @property ?float $expected_monthly_price gross estimate for a month (720 hours, at most the monthly cap)
+ * @property ?string $predecessor_id the subscription this one replaced (a resize); they share the monthly cap
  * @property float $vat_rate
  * @property array $payload
  * @property string $ends_at
@@ -32,6 +35,7 @@ class Subscription extends BaseResource
      *      description: null|string,
      *      unit: string,
      *      price: float,
+     *      monthly_cap?: null|float,
      *      vat_rate: float,
      *      payload: null|array,
      *      ends_at: null|string
@@ -41,6 +45,7 @@ class Subscription extends BaseResource
      *    - description:    The description (optional)
      *    - unit:           The unit (required when set, e.g. "hour", "day", "week", "month", "year")
      *    - price:          The price per unit (required when set)
+     *    - monthly_cap:    Net, at most this per calendar month (hour and day units; optional)
      *    - vat_rate:       The VAT rate (required when set)
      *    - payload:        The payload (optional)
      *    - ends_at:        The end date (optional)

src/Id/Resources/Subscriptions.php

@@ -20,6 +20,8 @@ class Subscriptions extends BaseCollection
      *      description: null|string,
      *      unit: string,
      *      price: float,
+     *      monthly_cap?: null|float,
+     *      predecessor_id?: null|string,
      *      vat_rate: float,
      *      payload: null|array,
      *      ends_at: null|string
@@ -29,6 +31,8 @@ class Subscriptions extends BaseCollection
      *    - description:    The description (optional)
      *    - unit:           The unit (e.g. "hour", "day", "week", "month", "year")
      *    - price:          The price per unit
+     *    - monthly_cap:    Net, at most this per calendar month (hour and day units, max. 2 decimals; optional)
+     *    - predecessor_id: The subscription this one replaces (a resize); both share the monthly cap (optional)
      *    - vat_rate:       The VAT rate (required when set)
      *    - payload:        The payload (optional)
      *    - ends_at:        The end date (optional)