CustomerBalanceTransaction.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / CustomerBalanceTransaction.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

CustomerBalanceTransaction.php

81 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* Each customer has a <a href="https://stripe.com/docs/api/customers/object#customer_object-balance">Balance</a> value,
8	* which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
9	* You may modify the value directly by using the <a href="https://stripe.com/docs/api/customers/update">update customer API</a>,
10	* or by creating a Customer Balance Transaction, which increments or decrements the customer's <code>balance</code> by the specified <code>amount</code>.
11	*
12	* Related guide: <a href="https://stripe.com/docs/billing/customer/balance">Customer balance</a>
13	*
14	* @property string $id Unique identifier for the object.
15	* @property string $object String representing the object's type. Objects of the same type share the same value.
16	* @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>.
17	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18	* @property null\|string\|\Stripe\CreditNote $credit_note The ID of the credit note (if any) related to the transaction.
19	* @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>.
20	* @property string\|\Stripe\Customer $customer The ID of the customer the transaction belongs to.
21	* @property null\|string $description An arbitrary string attached to the object. Often useful for displaying to users.
22	* @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.
23	* @property null\|string\|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction.
24	* @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.
25	* @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.
26	* @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.
27	*/
28	class CustomerBalanceTransaction extends ApiResource
29	{
30	const OBJECT_NAME = 'customer_balance_transaction';
31	const TYPE_ADJUSTMENT = 'adjustment';
32	const TYPE_APPLIED_TO_INVOICE = 'applied_to_invoice';
33	const TYPE_CREDIT_NOTE = 'credit_note';
34	const TYPE_INITIAL = 'initial';
35	const TYPE_INVOICE_OVERPAID = 'invoice_overpaid';
36	const TYPE_INVOICE_TOO_LARGE = 'invoice_too_large';
37	const TYPE_INVOICE_TOO_SMALL = 'invoice_too_small';
38	const TYPE_UNSPENT_RECEIVER_CREDIT = 'unspent_receiver_credit';
39	const TYPE_ADJUSTEMENT = 'adjustment';
40	/**
41	* @return string the API URL for this balance transaction
42	*/
43	public function instanceUrl()
44	{
45	$id = $this['id'];
46	$customer = $this['customer'];
47	if (!$id) {
48	throw new Exception\UnexpectedValueException("Could not determine which URL to request: class instance has invalid ID: {$id}", null);
49	}
50	$id = Util\Util::utf8($id);
51	$customer = Util\Util::utf8($customer);
52	$base = Customer::classUrl();
53	$customerExtn = \urlencode($customer);
54	$extn = \urlencode($id);
55	return "{$base}/{$customerExtn}/balance_transactions/{$extn}";
56	}
57	/**
58	* @param array\|string $_id
59	* @param null\|array\|string $_opts
60	*
61	* @throws \Stripe\Exception\BadMethodCallException
62	*/
63	public static function retrieve($_id, $_opts = null)
64	{
65	$msg = 'Customer Balance Transactions cannot be retrieved without a ' . 'customer ID. Retrieve a Customer Balance Transaction using ' . "`Customer::retrieveBalanceTransaction('customer_id', " . "'balance_transaction_id')`.";
66	throw new Exception\BadMethodCallException($msg);
67	}
68	/**
69	* @param string $_id
70	* @param null\|array $_params
71	* @param null\|array\|string $_options
72	*
73	* @throws \Stripe\Exception\BadMethodCallException
74	*/
75	public static function update($_id, $_params = null, $_options = null)
76	{
77	$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)`.";
78	throw new Exception\BadMethodCallException($msg);
79	}
80	}
81