| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* A customer's <code>Cash balance</code> represents real funds. Customers can add |
| 9 |
* funds to their cash balance by sending a bank transfer. These funds can be used |
| 10 |
* for payment and can eventually be paid out to your bank account. |
| 11 |
* |
| 12 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 13 |
* @property null|\Stripe\StripeObject $available A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. |
| 14 |
* @property string $customer The ID of the customer whose cash balance this object represents. |
| 15 |
* @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. |
| 16 |
* @property \Stripe\StripeObject $settings |
| 17 |
*/ |
| 18 |
class CashBalance extends ApiResource |
| 19 |
{ |
| 20 |
const OBJECT_NAME = 'cash_balance'; |
| 21 |
|
| 22 |
/** |
| 23 |
* @return string the API URL for this balance transaction |
| 24 |
*/ |
| 25 |
public function instanceUrl() |
| 26 |
{ |
| 27 |
$customer = $this['customer']; |
| 28 |
$customer = Util\Util::utf8($customer); |
| 29 |
|
| 30 |
$base = Customer::classUrl(); |
| 31 |
$customerExtn = \urlencode($customer); |
| 32 |
|
| 33 |
return "{$base}/{$customerExtn}/cash_balance"; |
| 34 |
} |
| 35 |
|
| 36 |
/** |
| 37 |
* @param array|string $_id |
| 38 |
* @param null|array|string $_opts |
| 39 |
* |
| 40 |
* @throws \Stripe\Exception\BadMethodCallException |
| 41 |
*/ |
| 42 |
public static function retrieve($_id, $_opts = null) |
| 43 |
{ |
| 44 |
$msg = 'Customer Cash Balance cannot be retrieved without a ' . |
| 45 |
'customer ID. Retrieve a Customer Cash Balance using ' . |
| 46 |
"`Customer::retrieveCashBalance('customer_id')`."; |
| 47 |
|
| 48 |
throw new Exception\BadMethodCallException($msg); |
| 49 |
} |
| 50 |
|
| 51 |
/** |
| 52 |
* @param string $_id |
| 53 |
* @param null|array $_params |
| 54 |
* @param null|array|string $_options |
| 55 |
* |
| 56 |
* @throws \Stripe\Exception\BadMethodCallException |
| 57 |
*/ |
| 58 |
public static function update($_id, $_params = null, $_options = null) |
| 59 |
{ |
| 60 |
$msg = 'Customer Cash Balance cannot be updated without a ' . |
| 61 |
'customer ID. Retrieve a Customer Cash Balance using ' . |
| 62 |
"`Customer::updateCashBalance('customer_id')`."; |
| 63 |
|
| 64 |
throw new Exception\BadMethodCallException($msg); |
| 65 |
} |
| 66 |
} |
| 67 |
|
