Alert.php
7 months ago
AlertTriggered.php
7 months ago
CreditBalanceSummary.php
7 months ago
CreditBalanceTransaction.php
7 months ago
CreditGrant.php
7 months ago
Meter.php
7 months ago
MeterEvent.php
7 months ago
MeterEventAdjustment.php
7 months ago
MeterEventSummary.php
7 months ago
MeterEvent.php
44 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace AmeliaVendor\Stripe\Billing; |
| 6 | |
| 7 | /** |
| 8 | * Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events. |
| 9 | * |
| 10 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 11 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 12 | * @property string $event_name The name of the meter event. Corresponds with the <code>event_name</code> field on a meter. |
| 13 | * @property string $identifier A unique identifier for the event. |
| 14 | * @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. |
| 15 | * @property \AmeliaVendor\Stripe\StripeObject $payload The payload of the event. This contains the fields corresponding to a meter's <code>customer_mapping.event_payload_key</code> (default is <code>stripe_customer_id</code>) and <code>value_settings.event_payload_key</code> (default is <code>value</code>). Read more about the <a href="https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides">payload</a>. |
| 16 | * @property int $timestamp The timestamp passed in when creating the event. Measured in seconds since the Unix epoch. |
| 17 | */ |
| 18 | class MeterEvent extends \AmeliaVendor\Stripe\ApiResource |
| 19 | { |
| 20 | const OBJECT_NAME = 'billing.meter_event'; |
| 21 | |
| 22 | /** |
| 23 | * Creates a billing meter event. |
| 24 | * |
| 25 | * @param null|array{event_name: string, expand?: string[], identifier?: string, payload: array<string, string>, timestamp?: int} $params |
| 26 | * @param null|array|string $options |
| 27 | * |
| 28 | * @return MeterEvent the created resource |
| 29 | * |
| 30 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 31 | */ |
| 32 | public static function create($params = null, $options = null) |
| 33 | { |
| 34 | self::_validateParams($params); |
| 35 | $url = static::classUrl(); |
| 36 | |
| 37 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 38 | $obj = \AmeliaVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 39 | $obj->setLastResponse($response); |
| 40 | |
| 41 | return $obj; |
| 42 | } |
| 43 | } |
| 44 |