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
CreditBalanceSummary.php
37 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace AmeliaVendor\Stripe\Billing; |
| 6 | |
| 7 | /** |
| 8 | * Indicates the billing credit balance for billing credits granted to a customer. |
| 9 | * |
| 10 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 11 | * @property ((object{available_balance: (object{monetary: null|(object{currency: string, value: int}&\AmeliaVendor\Stripe\StripeObject), type: string}&\AmeliaVendor\Stripe\StripeObject), ledger_balance: (object{monetary: null|(object{currency: string, value: int}&\AmeliaVendor\Stripe\StripeObject), type: string}&\AmeliaVendor\Stripe\StripeObject)}&\AmeliaVendor\Stripe\StripeObject))[] $balances The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry. |
| 12 | * @property string|\AmeliaVendor\Stripe\Customer $customer The customer the balance is for. |
| 13 | * @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. |
| 14 | */ |
| 15 | class CreditBalanceSummary extends \AmeliaVendor\Stripe\SingletonApiResource |
| 16 | { |
| 17 | const OBJECT_NAME = 'billing.credit_balance_summary'; |
| 18 | |
| 19 | /** |
| 20 | * Retrieves the credit balance summary for a customer. |
| 21 | * |
| 22 | * @param null|array|string $opts |
| 23 | * |
| 24 | * @return CreditBalanceSummary |
| 25 | * |
| 26 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 27 | */ |
| 28 | public static function retrieve($opts = null) |
| 29 | { |
| 30 | $opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts); |
| 31 | $instance = new static(null, $opts); |
| 32 | $instance->refresh(); |
| 33 | |
| 34 | return $instance; |
| 35 | } |
| 36 | } |
| 37 |