Alert.php
2 months ago
AlertTriggered.php
2 months ago
CreditBalanceSummary.php
2 months ago
CreditBalanceTransaction.php
2 months ago
CreditGrant.php
2 months ago
Meter.php
2 months ago
MeterEvent.php
2 months ago
MeterEventAdjustment.php
2 months ago
MeterEventSummary.php
2 months ago
Meter.php
150 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Billing; |
| 5 | |
| 6 | /** |
| 7 | * Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill. |
| 8 | * |
| 9 | * Related guide: <a href="https://docs.stripe.com/billing/subscriptions/usage-based">Usage based billing</a> |
| 10 | * |
| 11 | * @property string $id Unique identifier for the object. |
| 12 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 13 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 14 | * @property \Stripe\StripeObject $customer_mapping |
| 15 | * @property \Stripe\StripeObject $default_aggregation |
| 16 | * @property string $display_name The meter's name. |
| 17 | * @property string $event_name The name of the meter event to record usage for. Corresponds with the <code>event_name</code> field on meter events. |
| 18 | * @property null|string $event_time_window The time window to pre-aggregate meter events for, if any. |
| 19 | * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. |
| 20 | * @property string $status The meter's status. |
| 21 | * @property \Stripe\StripeObject $status_transitions |
| 22 | * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch. |
| 23 | * @property \Stripe\StripeObject $value_settings |
| 24 | */ |
| 25 | class Meter extends \ProfilePressVendor\Stripe\ApiResource |
| 26 | { |
| 27 | const OBJECT_NAME = 'billing.meter'; |
| 28 | use \ProfilePressVendor\Stripe\ApiOperations\NestedResource; |
| 29 | use \ProfilePressVendor\Stripe\ApiOperations\Update; |
| 30 | const EVENT_TIME_WINDOW_DAY = 'day'; |
| 31 | const EVENT_TIME_WINDOW_HOUR = 'hour'; |
| 32 | const STATUS_ACTIVE = 'active'; |
| 33 | const STATUS_INACTIVE = 'inactive'; |
| 34 | /** |
| 35 | * Creates a billing meter. |
| 36 | * |
| 37 | * @param null|array $params |
| 38 | * @param null|array|string $options |
| 39 | * |
| 40 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 41 | * |
| 42 | * @return \Stripe\Billing\Meter the created resource |
| 43 | */ |
| 44 | public static function create($params = null, $options = null) |
| 45 | { |
| 46 | self::_validateParams($params); |
| 47 | $url = static::classUrl(); |
| 48 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 49 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 50 | $obj->setLastResponse($response); |
| 51 | return $obj; |
| 52 | } |
| 53 | /** |
| 54 | * Retrieve a list of billing meters. |
| 55 | * |
| 56 | * @param null|array $params |
| 57 | * @param null|array|string $opts |
| 58 | * |
| 59 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 60 | * |
| 61 | * @return \Stripe\Collection<\Stripe\Billing\Meter> of ApiResources |
| 62 | */ |
| 63 | public static function all($params = null, $opts = null) |
| 64 | { |
| 65 | $url = static::classUrl(); |
| 66 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 67 | } |
| 68 | /** |
| 69 | * Retrieves a billing meter given an ID. |
| 70 | * |
| 71 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 72 | * @param null|array|string $opts |
| 73 | * |
| 74 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 75 | * |
| 76 | * @return \Stripe\Billing\Meter |
| 77 | */ |
| 78 | public static function retrieve($id, $opts = null) |
| 79 | { |
| 80 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 81 | $instance = new static($id, $opts); |
| 82 | $instance->refresh(); |
| 83 | return $instance; |
| 84 | } |
| 85 | /** |
| 86 | * Updates a billing meter. |
| 87 | * |
| 88 | * @param string $id the ID of the resource to update |
| 89 | * @param null|array $params |
| 90 | * @param null|array|string $opts |
| 91 | * |
| 92 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 93 | * |
| 94 | * @return \Stripe\Billing\Meter the updated resource |
| 95 | */ |
| 96 | public static function update($id, $params = null, $opts = null) |
| 97 | { |
| 98 | self::_validateParams($params); |
| 99 | $url = static::resourceUrl($id); |
| 100 | list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); |
| 101 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 102 | $obj->setLastResponse($response); |
| 103 | return $obj; |
| 104 | } |
| 105 | /** |
| 106 | * @param null|array $params |
| 107 | * @param null|array|string $opts |
| 108 | * |
| 109 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 110 | * |
| 111 | * @return \Stripe\Billing\Meter the deactivated meter |
| 112 | */ |
| 113 | public function deactivate($params = null, $opts = null) |
| 114 | { |
| 115 | $url = $this->instanceUrl() . '/deactivate'; |
| 116 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 117 | $this->refreshFrom($response, $opts); |
| 118 | return $this; |
| 119 | } |
| 120 | /** |
| 121 | * @param null|array $params |
| 122 | * @param null|array|string $opts |
| 123 | * |
| 124 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 125 | * |
| 126 | * @return \Stripe\Billing\Meter the reactivated meter |
| 127 | */ |
| 128 | public function reactivate($params = null, $opts = null) |
| 129 | { |
| 130 | $url = $this->instanceUrl() . '/reactivate'; |
| 131 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 132 | $this->refreshFrom($response, $opts); |
| 133 | return $this; |
| 134 | } |
| 135 | const PATH_EVENT_SUMMARIES = '/event_summaries'; |
| 136 | /** |
| 137 | * @param string $id the ID of the meter on which to retrieve the meter event summaries |
| 138 | * @param null|array $params |
| 139 | * @param null|array|string $opts |
| 140 | * |
| 141 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 142 | * |
| 143 | * @return \Stripe\Collection<\Stripe\Billing\MeterEventSummary> the list of meter event summaries |
| 144 | */ |
| 145 | public static function allEventSummaries($id, $params = null, $opts = null) |
| 146 | { |
| 147 | return self::_allNestedResources($id, static::PATH_EVENT_SUMMARIES, $params, $opts); |
| 148 | } |
| 149 | } |
| 150 |