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
CreditGrant.php
136 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Billing; |
| 5 | |
| 6 | /** |
| 7 | * A credit grant is an API resource that documents the allocation of some billing credits to a customer. |
| 8 | * |
| 9 | * Related guide: <a href="https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits">Billing credits</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 \Stripe\StripeObject $amount |
| 14 | * @property \Stripe\StripeObject $applicability_config |
| 15 | * @property string $category The category of this credit grant. This is for tracking purposes and isn't displayed to the customer. |
| 16 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 17 | * @property string|\Stripe\Customer $customer ID of the customer receiving the billing credits. |
| 18 | * @property null|int $effective_at The time when the billing credits become effective-when they're eligible for use. |
| 19 | * @property null|int $expires_at The time when the billing credits expire. If not present, the billing credits don't expire. |
| 20 | * @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. |
| 21 | * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| 22 | * @property null|string $name A descriptive name shown in dashboard. |
| 23 | * @property null|int $priority The priority for applying this credit grant. The highest priority is 0 and the lowest is 100. |
| 24 | * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this credit grant belongs to. |
| 25 | * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch. |
| 26 | * @property null|int $voided_at The time when this credit grant was voided. If not present, the credit grant hasn't been voided. |
| 27 | */ |
| 28 | class CreditGrant extends \ProfilePressVendor\Stripe\ApiResource |
| 29 | { |
| 30 | const OBJECT_NAME = 'billing.credit_grant'; |
| 31 | use \ProfilePressVendor\Stripe\ApiOperations\Update; |
| 32 | const CATEGORY_PAID = 'paid'; |
| 33 | const CATEGORY_PROMOTIONAL = 'promotional'; |
| 34 | /** |
| 35 | * Creates a credit grant. |
| 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\CreditGrant 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 credit grants. |
| 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\CreditGrant> 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 credit grant. |
| 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\CreditGrant |
| 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 credit grant. |
| 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\CreditGrant 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\CreditGrant the expired credit grant |
| 112 | */ |
| 113 | public function expire($params = null, $opts = null) |
| 114 | { |
| 115 | $url = $this->instanceUrl() . '/expire'; |
| 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\CreditGrant the voided credit grant |
| 127 | */ |
| 128 | public function voidGrant($params = null, $opts = null) |
| 129 | { |
| 130 | $url = $this->instanceUrl() . '/void'; |
| 131 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 132 | $this->refreshFrom($response, $opts); |
| 133 | return $this; |
| 134 | } |
| 135 | } |
| 136 |