ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
CustomerBalanceTransaction.php
104 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * Each customer has a <a |
| 9 | * href="https://stripe.com/docs/api/customers/object#customer_object-balance"><code>balance</code></a> |
| 10 | * value, which denotes a debit or credit that's automatically applied to their |
| 11 | * next invoice upon finalization. You may modify the value directly by using the |
| 12 | * <a href="https://stripe.com/docs/api/customers/update">update customer API</a>, |
| 13 | * or by creating a Customer Balance Transaction, which increments or decrements |
| 14 | * the customer's <code>balance</code> by the specified <code>amount</code>. |
| 15 | * |
| 16 | * Related guide: <a |
| 17 | * href="https://stripe.com/docs/billing/customer/balance">Customer Balance</a> to |
| 18 | * learn more. |
| 19 | * |
| 20 | * @property string $id Unique identifier for the object. |
| 21 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 22 | * @property int $amount The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's <code>balance</code>. |
| 23 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 24 | * @property null|string|\Stripe\CreditNote $credit_note The ID of the credit note (if any) related to the transaction. |
| 25 | * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>. |
| 26 | * @property string|\Stripe\Customer $customer The ID of the customer the transaction belongs to. |
| 27 | * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 28 | * @property int $ending_balance The customer's <code>balance</code> after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. |
| 29 | * @property null|string|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction. |
| 30 | * @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. |
| 31 | * @property null|\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. |
| 32 | * @property string $type Transaction type: <code>adjustment</code>, <code>applied_to_invoice</code>, <code>credit_note</code>, <code>initial</code>, <code>invoice_too_large</code>, <code>invoice_too_small</code>, <code>unspent_receiver_credit</code>, or <code>unapplied_from_invoice</code>. See the <a href="https://stripe.com/docs/billing/customer/balance#types">Customer Balance page</a> to learn more about transaction types. |
| 33 | */ |
| 34 | class CustomerBalanceTransaction extends ApiResource |
| 35 | { |
| 36 | const OBJECT_NAME = 'customer_balance_transaction'; |
| 37 | |
| 38 | const TYPE_ADJUSTMENT = 'adjustment'; |
| 39 | const TYPE_APPLIED_TO_INVOICE = 'applied_to_invoice'; |
| 40 | const TYPE_CREDIT_NOTE = 'credit_note'; |
| 41 | const TYPE_INITIAL = 'initial'; |
| 42 | const TYPE_INVOICE_TOO_LARGE = 'invoice_too_large'; |
| 43 | const TYPE_INVOICE_TOO_SMALL = 'invoice_too_small'; |
| 44 | const TYPE_UNSPENT_RECEIVER_CREDIT = 'unspent_receiver_credit'; |
| 45 | |
| 46 | const TYPE_ADJUSTEMENT = 'adjustment'; |
| 47 | |
| 48 | /** |
| 49 | * @return string the API URL for this balance transaction |
| 50 | */ |
| 51 | public function instanceUrl() |
| 52 | { |
| 53 | $id = $this['id']; |
| 54 | $customer = $this['customer']; |
| 55 | if (!$id) { |
| 56 | throw new Exception\UnexpectedValueException( |
| 57 | "Could not determine which URL to request: class instance has invalid ID: {$id}", |
| 58 | null |
| 59 | ); |
| 60 | } |
| 61 | $id = Util\Util::utf8($id); |
| 62 | $customer = Util\Util::utf8($customer); |
| 63 | |
| 64 | $base = Customer::classUrl(); |
| 65 | $customerExtn = \urlencode($customer); |
| 66 | $extn = \urlencode($id); |
| 67 | |
| 68 | return "{$base}/{$customerExtn}/balance_transactions/{$extn}"; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * @param array|string $_id |
| 73 | * @param null|array|string $_opts |
| 74 | * |
| 75 | * @throws \Stripe\Exception\BadMethodCallException |
| 76 | */ |
| 77 | public static function retrieve($_id, $_opts = null) |
| 78 | { |
| 79 | $msg = 'Customer Balance Transactions cannot be retrieved without a ' . |
| 80 | 'customer ID. Retrieve a Customer Balance Transaction using ' . |
| 81 | "`Customer::retrieveBalanceTransaction('customer_id', " . |
| 82 | "'balance_transaction_id')`."; |
| 83 | |
| 84 | throw new Exception\BadMethodCallException($msg); |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * @param string $_id |
| 89 | * @param null|array $_params |
| 90 | * @param null|array|string $_options |
| 91 | * |
| 92 | * @throws \Stripe\Exception\BadMethodCallException |
| 93 | */ |
| 94 | public static function update($_id, $_params = null, $_options = null) |
| 95 | { |
| 96 | $msg = 'Customer Balance Transactions cannot be updated without a ' . |
| 97 | 'customer ID. Update a Customer Balance Transaction using ' . |
| 98 | "`Customer::updateBalanceTransaction('customer_id', " . |
| 99 | "'balance_transaction_id', \$updateParams)`."; |
| 100 | |
| 101 | throw new Exception\BadMethodCallException($msg); |
| 102 | } |
| 103 | } |
| 104 |