Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

// File generated from our OpenAPI spec

[2] Fix | Delete

namespace WPForms\Vendor\Stripe;

[3] Fix | Delete

[4] Fix | Delete

/**

[5] Fix | Delete

* Each customer has a <a href="https://stripe.com/docs/api/customers/object#customer_object-balance">Balance</a> value,

[6] Fix | Delete

* which denotes a debit or credit that's automatically applied to their next invoice upon finalization.

[7] Fix | Delete

* You may modify the value directly by using the <a href="https://stripe.com/docs/api/customers/update">update customer API</a>,

[8] Fix | Delete

* or by creating a Customer Balance Transaction, which increments or decrements the customer's <code>balance</code> by the specified <code>amount</code>.

[9] Fix | Delete

[10] Fix | Delete

* Related guide: <a href="https://stripe.com/docs/billing/customer/balance">Customer balance</a>

[11] Fix | Delete

[12] Fix | Delete

* @property string $id Unique identifier for the object.

[13] Fix | Delete

* @property string $object String representing the object's type. Objects of the same type share the same value.

[14] Fix | Delete

* @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>.

[15] Fix | Delete

* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.

[16] Fix | Delete

* @property null|string|\Stripe\CreditNote $credit_note The ID of the credit note (if any) related to the transaction.

[17] Fix | Delete

* @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>.

[18] Fix | Delete

* @property string|\Stripe\Customer $customer The ID of the customer the transaction belongs to.

[19] Fix | Delete

* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.

[20] Fix | Delete

* @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.

[21] Fix | Delete

* @property null|string|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction.

[22] Fix | Delete

* @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.

[23] Fix | Delete

* @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.

[24] Fix | Delete

* @property string $type Transaction type: <code>adjustment</code>, <code>applied_to_invoice</code>, <code>credit_note</code>, <code>initial</code>, <code>invoice_overpaid</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.

[25] Fix | Delete

[26] Fix | Delete

class CustomerBalanceTransaction extends ApiResource

[27] Fix | Delete

{

[28] Fix | Delete

const OBJECT_NAME = 'customer_balance_transaction';

[29] Fix | Delete

const TYPE_ADJUSTMENT = 'adjustment';

[30] Fix | Delete

const TYPE_APPLIED_TO_INVOICE = 'applied_to_invoice';

[31] Fix | Delete

const TYPE_CREDIT_NOTE = 'credit_note';

[32] Fix | Delete

const TYPE_INITIAL = 'initial';

[33] Fix | Delete

const TYPE_INVOICE_OVERPAID = 'invoice_overpaid';

[34] Fix | Delete

const TYPE_INVOICE_TOO_LARGE = 'invoice_too_large';

[35] Fix | Delete

const TYPE_INVOICE_TOO_SMALL = 'invoice_too_small';

[36] Fix | Delete

const TYPE_UNSPENT_RECEIVER_CREDIT = 'unspent_receiver_credit';

[37] Fix | Delete

const TYPE_ADJUSTEMENT = 'adjustment';

[38] Fix | Delete

/**

[39] Fix | Delete

* @return string the API URL for this balance transaction

[40] Fix | Delete

[41] Fix | Delete

public function instanceUrl()

[42] Fix | Delete

{

[43] Fix | Delete

$id = $this['id'];

[44] Fix | Delete

$customer = $this['customer'];

[45] Fix | Delete

if (!$id) {

[46] Fix | Delete

throw new Exception\UnexpectedValueException("Could not determine which URL to request: class instance has invalid ID: {$id}", null);

[47] Fix | Delete

}

[48] Fix | Delete

$id = Util\Util::utf8($id);

[49] Fix | Delete

$customer = Util\Util::utf8($customer);

[50] Fix | Delete

$base = Customer::classUrl();

[51] Fix | Delete

$customerExtn = \urlencode($customer);

[52] Fix | Delete

$extn = \urlencode($id);

[53] Fix | Delete

return "{$base}/{$customerExtn}/balance_transactions/{$extn}";

[54] Fix | Delete

}

[55] Fix | Delete

/**

[56] Fix | Delete

* @param array|string $_id

[57] Fix | Delete

* @param null|array|string $_opts

[58] Fix | Delete

[59] Fix | Delete

* @throws \Stripe\Exception\BadMethodCallException

[60] Fix | Delete

[61] Fix | Delete

public static function retrieve($_id, $_opts = null)

[62] Fix | Delete

{

[63] Fix | Delete

$msg = 'Customer Balance Transactions cannot be retrieved without a ' . 'customer ID. Retrieve a Customer Balance Transaction using ' . "`Customer::retrieveBalanceTransaction('customer_id', " . "'balance_transaction_id')`.";

[64] Fix | Delete

throw new Exception\BadMethodCallException($msg);

[65] Fix | Delete

}

[66] Fix | Delete

/**

[67] Fix | Delete

* @param string $_id

[68] Fix | Delete

* @param null|array $_params

[69] Fix | Delete

* @param null|array|string $_options

[70] Fix | Delete

[71] Fix | Delete

* @throws \Stripe\Exception\BadMethodCallException

[72] Fix | Delete

[73] Fix | Delete

public static function update($_id, $_params = null, $_options = null)

[74] Fix | Delete

{

[75] Fix | Delete

$msg = 'Customer Balance Transactions cannot be updated without a ' . 'customer ID. Update a Customer Balance Transaction using ' . "`Customer::updateBalanceTransaction('customer_id', " . "'balance_transaction_id', \$updateParams)`.";

[76] Fix | Delete

throw new Exception\BadMethodCallException($msg);

[77] Fix | Delete

}

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete