standard, express, or custom.
*
* @package Stripe
*/
@@ -44,14 +44,16 @@ class Account extends ApiResource
/**
* Possible string representations of an account's business type.
- * @link https://stripe.com/docs/api/accounts/object#account_object-business_type
+ *
+ * @see https://stripe.com/docs/api/accounts/object#account_object-business_type
*/
const BUSINESS_TYPE_COMPANY = 'company';
const BUSINESS_TYPE_INDIVIDUAL = 'individual';
/**
* Possible string representations of an account's capabilities.
- * @link https://stripe.com/docs/api/accounts/object#account_object-capabilities
+ *
+ * @see https://stripe.com/docs/api/accounts/object#account_object-capabilities
*/
const CAPABILITY_CARD_PAYMENTS = 'card_payments';
const CAPABILITY_LEGACY_PAYMENTS = 'legacy_payments';
@@ -60,7 +62,8 @@ class Account extends ApiResource
/**
* Possible string representations of an account's capability status.
- * @link https://stripe.com/docs/api/accounts/object#account_object-capabilities
+ *
+ * @see https://stripe.com/docs/api/accounts/object#account_object-capabilities
*/
const CAPABILITY_STATUS_ACTIVE = 'active';
const CAPABILITY_STATUS_INACTIVE = 'inactive';
@@ -68,7 +71,8 @@ class Account extends ApiResource
/**
* Possible string representations of an account's type.
- * @link https://stripe.com/docs/api/accounts/object#account_object-type
+ *
+ * @see https://stripe.com/docs/api/accounts/object#account_object-type
*/
const TYPE_CUSTOM = 'custom';
const TYPE_EXPRESS = 'express';
diff --git a/lib/AccountLink.php b/lib/AccountLink.php
index 054ee260d..4ffb61b32 100644
--- a/lib/AccountLink.php
+++ b/lib/AccountLink.php
@@ -5,10 +5,10 @@
/**
* Class AccountLink
*
- * @property string $object
- * @property int $created
- * @property int $expires_at
- * @property string $url
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $expires_at The timestamp at which this account link will expire.
+ * @property string $url The URL for the account link.
*
* @package Stripe
*/
diff --git a/lib/AlipayAccount.php b/lib/AlipayAccount.php
index aa91c1a02..5d6f6702e 100644
--- a/lib/AlipayAccount.php
+++ b/lib/AlipayAccount.php
@@ -8,7 +8,7 @@
* @package Stripe
*
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
- * @link https://stripe.com/docs/sources/alipay
+ * @see https://stripe.com/docs/sources/alipay
*/
class AlipayAccount extends ApiResource
{
@@ -43,7 +43,7 @@ public function instanceUrl()
* @throws \Stripe\Exception\BadMethodCallException
*
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
- * @link https://stripe.com/docs/sources/alipay
+ * @see https://stripe.com/docs/sources/alipay
*/
public static function retrieve($_id, $_opts = null)
{
@@ -61,7 +61,7 @@ public static function retrieve($_id, $_opts = null)
* @throws \Stripe\Exception\BadMethodCallException
*
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
- * @link https://stripe.com/docs/sources/alipay
+ * @see https://stripe.com/docs/sources/alipay
*/
public static function update($_id, $_params = null, $_options = null)
{
diff --git a/lib/ApiOperations/Request.php b/lib/ApiOperations/Request.php
index ba8e018f3..e9f4e7897 100644
--- a/lib/ApiOperations/Request.php
+++ b/lib/ApiOperations/Request.php
@@ -10,7 +10,7 @@
trait Request
{
/**
- * @param array|null|mixed $params The list of parameters to validate
+ * @param array|mixed|null $params The list of parameters to validate
*
* @throws \Stripe\Exception\InvalidArgumentException if $params exists and is not an array
*/
diff --git a/lib/ApiRequestor.php b/lib/ApiRequestor.php
index 11fde302f..89dadc819 100644
--- a/lib/ApiRequestor.php
+++ b/lib/ApiRequestor.php
@@ -46,9 +46,11 @@ public function __construct($apiKey = null, $apiBase = null)
/**
* Creates a telemetry json blob for use in 'X-Stripe-Client-Telemetry' headers
+ *
* @static
*
* @param RequestTelemetry $requestTelemetry
+ *
* @return string
*/
private static function _telemetryJson($requestTelemetry)
@@ -71,9 +73,9 @@ private static function _telemetryJson($requestTelemetry)
/**
* @static
*
- * @param ApiResource|bool|array|mixed $d
+ * @param ApiResource|array|bool|mixed $d
*
- * @return ApiResource|array|string|mixed
+ * @return ApiResource|array|mixed|string
*/
private static function _encodeObjects($d)
{
@@ -102,9 +104,9 @@ private static function _encodeObjects($d)
* @param array|null $params
* @param array|null $headers
*
- * @return array tuple containing (ApiReponse, API key)
- *
* @throws Exception\ApiErrorException
+ *
+ * @return array tuple containing (ApiReponse, API key)
*/
public function request($method, $url, $params = null, $headers = null)
{
@@ -196,7 +198,7 @@ private static function _specificAPIError($rbody, $rcode, $rheaders, $resp, $err
/**
* @static
*
- * @param string|bool $rbody
+ * @param bool|string $rbody
* @param int $rcode
* @param array $rheaders
* @param array $resp
@@ -229,9 +231,9 @@ private static function _specificOAuthError($rbody, $rcode, $rheaders, $resp, $e
/**
* @static
*
- * @param null|array $appInfo
+ * @param array|null $appInfo
*
- * @return null|string
+ * @return string|null
*/
private static function _formatAppInfo($appInfo)
{
@@ -293,10 +295,10 @@ private static function _defaultHeaders($apiKey, $clientInfo = null)
* @param array $params
* @param array $headers
*
- * @return array
- *
* @throws Exception\AuthenticationException
* @throws Exception\ApiConnectionException
+ *
+ * @return array
*/
private function _requestRaw($method, $url, $params, $headers)
{
@@ -382,9 +384,9 @@ private function _requestRaw($method, $url, $params, $headers)
/**
* @param resource $resource
*
- * @return \CURLFile|string
- *
* @throws Exception\InvalidArgumentException
+ *
+ * @return \CURLFile|string
*/
private function _processResourceParam($resource)
{
@@ -410,10 +412,10 @@ private function _processResourceParam($resource)
* @param int $rcode
* @param array $rheaders
*
- * @return array
- *
* @throws Exception\UnexpectedValueException
* @throws Exception\ApiErrorException
+ *
+ * @return array
*/
private function _interpretResponse($rbody, $rcode, $rheaders)
{
diff --git a/lib/ApiResource.php b/lib/ApiResource.php
index 0b76fe648..555b190be 100644
--- a/lib/ApiResource.php
+++ b/lib/ApiResource.php
@@ -28,7 +28,7 @@ public static function getSavedNestedResources()
}
/**
- * @var boolean A flag that can be set a behavior that will cause this
+ * @var bool A flag that can be set a behavior that will cause this
* resource to be encoded and sent up along with an update of its parent
* resource. This is usually not desirable because resources are updated
* individually on their own endpoints, but there are certain cases,
@@ -48,9 +48,9 @@ public function __set($k, $v)
}
/**
- * @return ApiResource The refreshed resource.
- *
* @throws Exception\ApiErrorException
+ *
+ * @return ApiResource The refreshed resource.
*/
public function refresh()
{
@@ -88,6 +88,10 @@ public static function classUrl()
}
/**
+ * @param string|null $id the ID of the resource
+ *
+ * @throws Exception\UnexpectedValueException if $id is null
+ *
* @return string The instance endpoint URL for the given class.
*/
public static function resourceUrl($id)
diff --git a/lib/ApiResponse.php b/lib/ApiResponse.php
index 0f14c41a1..3499e64be 100644
--- a/lib/ApiResponse.php
+++ b/lib/ApiResponse.php
@@ -33,7 +33,7 @@ class ApiResponse
/**
* @param string $body
- * @param integer $code
+ * @param int $code
* @param array|CaseInsensitiveArray|null $headers
* @param array|null $json
*/
diff --git a/lib/ApplePayDomain.php b/lib/ApplePayDomain.php
index 9837f633c..87cfaa246 100644
--- a/lib/ApplePayDomain.php
+++ b/lib/ApplePayDomain.php
@@ -5,11 +5,11 @@
/**
* Class ApplePayDomain
*
- * @property string $id
- * @property string $object
- * @property int $created
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @property string $domain_name
- * @property bool $livemode
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
*
* @package Stripe
*/
diff --git a/lib/ApplicationFee.php b/lib/ApplicationFee.php
index ce24b1560..717ce33fe 100644
--- a/lib/ApplicationFee.php
+++ b/lib/ApplicationFee.php
@@ -5,20 +5,20 @@
/**
* Class ApplicationFee
*
- * @property string $id
- * @property string $object
- * @property string|\Stripe\Account $account
- * @property int $amount
- * @property int $amount_refunded
- * @property string|\Stripe\StripeObject $application
- * @property string|\Stripe\BalanceTransaction|null $balance_transaction
- * @property string|\Stripe\Charge $charge
- * @property int $created
- * @property string $currency
- * @property bool $livemode
- * @property string|\Stripe\Charge|null $originating_transaction
- * @property bool $refunded
- * @property \Stripe\Collection $refunds
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|\Stripe\Account $account ID of the Stripe account this fee was taken from.
+ * @property int $amount Amount earned, in %s.
+ * @property int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)
+ * @property string|\Stripe\StripeObject $application ID of the Connect application that earned the fee.
+ * @property string|\Stripe\BalanceTransaction|null $balance_transaction Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
+ * @property string|\Stripe\Charge $charge ID of the charge that the application fee was taken from.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|\Stripe\Charge|null $originating_transaction ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.
+ * @property bool $refunded Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
+ * @property \Stripe\Collection $refunds A list of refunds that have been applied to the fee.
*
* @package Stripe
*/
diff --git a/lib/Balance.php b/lib/Balance.php
index 05d977f6e..20629e75f 100644
--- a/lib/Balance.php
+++ b/lib/Balance.php
@@ -5,11 +5,11 @@
/**
* Class Balance
*
- * @property string $object
- * @property \Stripe\StripeObject[] $available
- * @property \Stripe\StripeObject[] $connect_reserved
- * @property bool $livemode
- * @property \Stripe\StripeObject[] $pending
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property.
+ * @property \Stripe\StripeObject[] $connect_reserved Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the source_types property.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject[] $pending Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the source_types property.
*
* @package Stripe
*/
diff --git a/lib/BalanceTransaction.php b/lib/BalanceTransaction.php
index 970564d4e..2504f38ad 100644
--- a/lib/BalanceTransaction.php
+++ b/lib/BalanceTransaction.php
@@ -5,21 +5,21 @@
/**
* Class BalanceTransaction
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $available_on
- * @property int $created
- * @property string $currency
- * @property string|null $description
- * @property float|null $exchange_rate
- * @property int $fee
- * @property \Stripe\StripeObject[] $fee_details
- * @property int $net
- * @property string $reporting_category
- * @property string|\Stripe\StripeObject|null $source
- * @property string $status
- * @property string $type
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Gross amount of the transaction, in %s.
+ * @property int $available_on The date the transaction's net funds will become available in the Stripe balance.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property float|null $exchange_rate The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the amount in currency A, times exchange_rate, would be the amount in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's amount would be 1000 and currency would be eur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's amount would be 1234, currency would be usd, and exchange_rate would be 1.234.
+ * @property int $fee Fees (in %s) paid for this transaction.
+ * @property \Stripe\StripeObject[] $fee_details Detailed breakdown of fees (in %s) paid for this transaction.
+ * @property int $net Net amount of the transaction, in %s.
+ * @property string $reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.
+ * @property string|\Stripe\StripeObject|null $source The Stripe object to which this transaction is related.
+ * @property string $status If the transaction's net funds are available in the Stripe balance yet. Either available or pending.
+ * @property string $type Transaction type: adjustment, advance, advance_funding, application_fee, application_fee_refund, charge, connect_collection_transfer, issuing_authorization_hold, issuing_authorization_release, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider reporting_category instead.
*
* @package Stripe
*/
@@ -32,7 +32,8 @@ class BalanceTransaction extends ApiResource
/**
* Possible string representations of the type of balance transaction.
- * @link https://stripe.com/docs/api/balance/balance_transaction#balance_transaction_object-type
+ *
+ * @see https://stripe.com/docs/api/balance/balance_transaction#balance_transaction_object-type
*/
const TYPE_ADJUSTMENT = 'adjustment';
const TYPE_ADVANCE = 'advance';
diff --git a/lib/BankAccount.php b/lib/BankAccount.php
index e6c6c7908..87c391b92 100644
--- a/lib/BankAccount.php
+++ b/lib/BankAccount.php
@@ -5,21 +5,21 @@
/**
* Class BankAccount
*
- * @property string $id
- * @property string $object
- * @property string|\Stripe\Account|null $account
- * @property string|null $account_holder_name
- * @property string|null $account_holder_type
- * @property string|null $bank_name
- * @property string $country
- * @property string $currency
- * @property string|\Stripe\Customer|null $customer
- * @property bool|null $default_for_currency
- * @property string|null $fingerprint
- * @property string $last4
- * @property \Stripe\StripeObject|null $metadata
- * @property string|null $routing_number
- * @property string $status
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|\Stripe\Account|null $account The ID of the account that the bank account is associated with.
+ * @property string|null $account_holder_name The name of the person or business that owns the bank account.
+ * @property string|null $account_holder_type The type of entity that holds the account. This can be either individual or company.
+ * @property string|null $bank_name Name of the bank associated with the routing number (e.g., WELLS FARGO).
+ * @property string $country Two-letter ISO code representing the country the bank account is located in.
+ * @property string $currency Three-letter ISO code for the currency paid out to the bank account.
+ * @property string|\Stripe\Customer|null $customer The ID of the customer that the bank account is associated with.
+ * @property bool|null $default_for_currency Whether this bank account is the default external account for its currency.
+ * @property string|null $fingerprint Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
+ * @property string $last4 The last four digits of the bank account number.
+ * @property \Stripe\StripeObject|null $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $routing_number The routing transit number for the bank account.
+ * @property string $status For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated.
For external accounts, possible values are new and errored. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.
currency that you are collecting as payment.
+ * @property int $amount_received The amount of currency to which bitcoin_amount_received has been converted.
+ * @property int $bitcoin_amount The amount of bitcoin that the customer should send to fill the receiver. The bitcoin_amount is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.
+ * @property int $bitcoin_amount_received The amount of bitcoin that has been sent by the customer to this receiver.
+ * @property string $bitcoin_uri This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO code for the currency to which the bitcoin will be converted.
+ * @property string|null $customer The customer ID of the bitcoin receiver.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property string|null $email The customer's email address, set by the API call that creates the receiver.
+ * @property bool $filled This flag is initially false and updates to true when the customer sends the bitcoin_amount to this receiver.
+ * @property string $inbound_address A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $payment The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.
+ * @property string|null $refund_address The refund address of this bitcoin receiver.
+ * @property \Stripe\Collection $transactions A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.
+ * @property bool $uncaptured_funds This receiver contains uncaptured funds that can be used for a payment or refunded.
+ * @property bool|null $used_for_payment Indicate if this source is used for payment.
*
* @package Stripe
*/
diff --git a/lib/Capability.php b/lib/Capability.php
index 4a420fc36..6e9936a9a 100644
--- a/lib/Capability.php
+++ b/lib/Capability.php
@@ -23,7 +23,8 @@ class Capability extends ApiResource
/**
* Possible string representations of a capability's status.
- * @link https://stripe.com/docs/api/capabilities/object#capability_object-status
+ *
+ * @see https://stripe.com/docs/api/capabilities/object#capability_object-status
*/
const STATUS_ACTIVE = 'active';
const STATUS_INACTIVE = 'inactive';
diff --git a/lib/Card.php b/lib/Card.php
index f8fa82de7..b66563706 100644
--- a/lib/Card.php
+++ b/lib/Card.php
@@ -5,34 +5,34 @@
/**
* Class Card
*
- * @property string $id
- * @property string $object
- * @property string|\Stripe\Account|null $account
- * @property string|null $address_city
- * @property string|null $address_country
- * @property string|null $address_line1
- * @property string|null $address_line1_check
- * @property string|null $address_line2
- * @property string|null $address_state
- * @property string|null $address_zip
- * @property string|null $address_zip_check
- * @property string[]|null $available_payout_methods
- * @property string $brand
- * @property string|null $country
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|\Stripe\Account|null $account The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.
+ * @property string|null $address_city City/District/Suburb/Town/Village.
+ * @property string|null $address_country Billing address country, if provided when creating card.
+ * @property string|null $address_line1 Address line 1 (Street address/PO Box/Company name).
+ * @property string|null $address_line1_check If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.
+ * @property string|null $address_line2 Address line 2 (Apartment/Suite/Unit/Building).
+ * @property string|null $address_state State/County/Province/Region.
+ * @property string|null $address_zip ZIP or postal code.
+ * @property string|null $address_zip_check If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
+ * @property string[]|null $available_payout_methods A set of available payout methods for this card. Will be either ["standard"] or ["standard", "instant"]. Only values from this set should be passed as the method when creating a transfer.
+ * @property string $brand Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
+ * @property string|null $country Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
* @property string|null $currency
- * @property string|\Stripe\Customer|null $customer
- * @property string|null $cvc_check
- * @property bool|null $default_for_currency
- * @property string|null $dynamic_last4
- * @property int $exp_month
- * @property int $exp_year
- * @property string|null $fingerprint
- * @property string $funding
- * @property string $last4
- * @property \Stripe\StripeObject $metadata
- * @property string|null $name
- * @property string|\Stripe\Recipient|null $recipient
- * @property string|null $tokenization_method
+ * @property string|\Stripe\Customer|null $customer The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+ * @property string|null $cvc_check If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.
+ * @property bool|null $default_for_currency Whether this card is the default external account for its currency.
+ * @property string|null $dynamic_last4 (For tokenized numbers only.) The last four digits of the device account number.
+ * @property int $exp_month Two-digit number representing the card's expiration month.
+ * @property int $exp_year Four-digit number representing the card's expiration year.
+ * @property string|null $fingerprint Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
+ * @property string $funding Card funding type. Can be credit, debit, prepaid, or unknown.
+ * @property string $last4 The last four digits of the card.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $name Cardholder name.
+ * @property string|\Stripe\Recipient|null $recipient The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
+ * @property string|null $tokenization_method If the card number is tokenized, this is the method that was used. Can be amex_express_checkout, android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.
*
* @package Stripe
*/
@@ -45,7 +45,8 @@ class Card extends ApiResource
/**
* Possible string representations of the CVC check status.
- * @link https://stripe.com/docs/api/cards/object#card_object-cvc_check
+ *
+ * @see https://stripe.com/docs/api/cards/object#card_object-cvc_check
*/
const CVC_CHECK_FAIL = 'fail';
const CVC_CHECK_PASS = 'pass';
@@ -54,7 +55,8 @@ class Card extends ApiResource
/**
* Possible string representations of the funding of the card.
- * @link https://stripe.com/docs/api/cards/object#card_object-funding
+ *
+ * @see https://stripe.com/docs/api/cards/object#card_object-funding
*/
const FUNDING_CREDIT = 'credit';
const FUNDING_DEBIT = 'debit';
@@ -63,7 +65,8 @@ class Card extends ApiResource
/**
* Possible string representations of the tokenization method when using Apple Pay or Google Pay.
- * @link https://stripe.com/docs/api/cards/object#card_object-tokenization_method
+ *
+ * @see https://stripe.com/docs/api/cards/object#card_object-tokenization_method
*/
const TOKENIZATION_METHOD_APPLE_PAY = 'apple_pay';
const TOKENIZATION_METHOD_GOOGLE_PAY = 'google_pay';
diff --git a/lib/Charge.php b/lib/Charge.php
index c0f256a87..468a3ca1a 100644
--- a/lib/Charge.php
+++ b/lib/Charge.php
@@ -5,51 +5,51 @@
/**
* Class Charge
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $amount_refunded
- * @property string|\Stripe\StripeObject|null $application
- * @property string|\Stripe\ApplicationFee|null $application_fee
- * @property int|null $application_fee_amount
- * @property string|\Stripe\BalanceTransaction|null $balance_transaction
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+ * @property int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).
+ * @property string|\Stripe\StripeObject|null $application ID of the Connect application that created the charge.
+ * @property string|\Stripe\ApplicationFee|null $application_fee The application fee (if any) for the charge. See the Connect documentation for details.
+ * @property int|null $application_fee_amount The amount of the application fee (if any) for the charge. See the Connect documentation for details.
+ * @property string|\Stripe\BalanceTransaction|null $balance_transaction ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
* @property \Stripe\StripeObject $billing_details
- * @property bool $captured
- * @property int $created
- * @property string $currency
- * @property string|\Stripe\Customer|null $customer
- * @property string|null $description
- * @property string|\Stripe\Account|null $destination
- * @property string|\Stripe\Dispute|null $dispute
- * @property bool $disputed
- * @property string|null $failure_code
- * @property string|null $failure_message
- * @property \Stripe\StripeObject|null $fraud_details
- * @property string|\Stripe\Invoice|null $invoice
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string|\Stripe\Account|null $on_behalf_of
- * @property string|\Stripe\Order|null $order
- * @property \Stripe\StripeObject|null $outcome
- * @property bool $paid
- * @property string|null $payment_intent
- * @property string|null $payment_method
- * @property \Stripe\StripeObject|null $payment_method_details
- * @property string|null $receipt_email
- * @property string|null $receipt_number
- * @property string $receipt_url
- * @property bool $refunded
- * @property \Stripe\Collection $refunds
- * @property string|\Stripe\Review|null $review
- * @property \Stripe\StripeObject|null $shipping
- * @property \Stripe\StripeObject|null $source
- * @property string|\Stripe\Transfer|null $source_transfer
- * @property string|null $statement_descriptor
- * @property string|null $statement_descriptor_suffix
- * @property string $status
- * @property string|\Stripe\Transfer $transfer
- * @property \Stripe\StripeObject|null $transfer_data
- * @property string|null $transfer_group
+ * @property bool $captured If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer|null $customer ID of the customer this charge is for if one exists.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property string|\Stripe\Account|null $destination ID of an existing, connected Stripe account to transfer funds to if transfer_data was specified in the charge request.
+ * @property string|\Stripe\Dispute|null $dispute Details about the dispute if the charge has been disputed.
+ * @property bool $disputed Whether the charge has been disputed.
+ * @property string|null $failure_code Error code explaining reason for charge failure if available (see the errors section for a list of codes).
+ * @property string|null $failure_message Message to user further explaining reason for charge failure if available.
+ * @property \Stripe\StripeObject|null $fraud_details Information on fraud assessments for the charge.
+ * @property string|\Stripe\Invoice|null $invoice ID of the invoice this charge is for if one exists.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|\Stripe\Account|null $on_behalf_of The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.
+ * @property string|\Stripe\Order|null $order ID of the order this charge is for if one exists.
+ * @property \Stripe\StripeObject|null $outcome Details about whether the payment was accepted, and why. See understanding declines for details.
+ * @property bool $paid true if the charge succeeded, or was successfully authorized for later capture.
+ * @property string|null $payment_intent ID of the PaymentIntent associated with this charge, if one exists.
+ * @property string|null $payment_method ID of the payment method used in this charge.
+ * @property \Stripe\StripeObject|null $payment_method_details Details about the payment method at the time of the transaction.
+ * @property string|null $receipt_email This is the email address that the receipt for this charge was sent to.
+ * @property string|null $receipt_number This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent.
+ * @property string $receipt_url This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
+ * @property bool $refunded Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
+ * @property \Stripe\Collection $refunds A list of refunds that have been applied to the charge.
+ * @property string|\Stripe\Review|null $review ID of the review associated with this charge if one exists.
+ * @property \Stripe\StripeObject|null $shipping Shipping information for the charge.
+ * @property \Stripe\StripeObject|null $source This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to payment_method or payment_method_details instead.
+ * @property string|\Stripe\Transfer|null $source_transfer The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
+ * @property string|null $statement_descriptor For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
+ * @property string|null $statement_descriptor_suffix Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
+ * @property string $status The status of the payment is either succeeded, pending, or failed.
+ * @property string|\Stripe\Transfer $transfer ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter).
+ * @property \Stripe\StripeObject|null $transfer_data An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
+ * @property string|null $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details.
*
* @package Stripe
*/
@@ -65,7 +65,8 @@ class Charge extends ApiResource
/**
* Possible string representations of decline codes.
* These strings are applicable to the decline_code property of the \Stripe\Exception\CardException exception.
- * @link https://stripe.com/docs/declines/codes
+ *
+ * @see https://stripe.com/docs/declines/codes
*/
const DECLINED_AUTHENTICATION_REQUIRED = 'authentication_required';
const DECLINED_APPROVE_WITH_ID = 'approve_with_id';
@@ -116,7 +117,8 @@ class Charge extends ApiResource
/**
* Possible string representations of the status of the charge.
- * @link https://stripe.com/docs/api/charges/object#charge_object-status
+ *
+ * @see https://stripe.com/docs/api/charges/object#charge_object-status
*/
const STATUS_FAILED = 'failed';
const STATUS_PENDING = 'pending';
diff --git a/lib/Checkout/Session.php b/lib/Checkout/Session.php
index f62248a4c..371ec14a5 100644
--- a/lib/Checkout/Session.php
+++ b/lib/Checkout/Session.php
@@ -5,24 +5,24 @@
/**
* Class Session
*
- * @property string $id
- * @property string $object
- * @property string|null $billing_address_collection
- * @property string $cancel_url
- * @property string|null $client_reference_id
- * @property string|\Stripe\Customer|null $customer
- * @property string|null $customer_email
- * @property \Stripe\StripeObject[]|null $display_items
- * @property bool $livemode
- * @property string|null $locale
- * @property \Stripe\StripeObject|null $metadata
- * @property string|null $mode
- * @property string|\Stripe\PaymentIntent|null $payment_intent
- * @property string[] $payment_method_types
- * @property string|\Stripe\SetupIntent|null $setup_intent
- * @property string|null $submit_type
- * @property string|\Stripe\Subscription|null $subscription
- * @property string $success_url
+ * @property string $id Unique identifier for the object. Used to pass to redirectToCheckout
in Stripe.js.
+ * @property string $object String representing the object's type. Objects of the same type share the same value. + * @property string|null $billing_address_collectionThe value (auto or required) for whether Checkout collected the
customer's billing address.
+ * @property string $cancel_url The URL the customer will be directed to if they decide to cancel payment and return to your website. + * @property string|null $client_reference_idA unique string to reference the Checkout Session. This can be a
customer ID, a cart ID, or similar, and can be used to reconcile the
session with your internal systems.
+ * @property string|\Stripe\Customer|null $customerThe ID of the customer for this session.
For Checkout Sessions in payment or subscription mode, Checkout
will create a new customer object based on information provided
during the session unless an existing customer was provided when
the session was created.
+ * @property string|null $customer_emailIf provided, this value will be used when the Customer object is created.
If not provided, customers will be asked to enter their email address.
Use this parameter to prefill customer data if you already have an email
on file. To access information about the customer once a session is
complete, use the customer field.
true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|null $locale The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.
+ * @property \Stripe\StripeObject|null $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $mode The mode of the Checkout Session, one of payment, setup, or subscription.
+ * @property string|\Stripe\PaymentIntent|null $payment_intent The ID of the PaymentIntent for Checkout Sessions in payment mode.
+ * @property string[] $payment_method_types A list of the types of payment methods (e.g. card) this Checkout
Session is allowed to accept.
+ * @property string|\Stripe\SetupIntent|null $setup_intent The ID of the SetupIntent for Checkout Sessions insetup mode.
+ * @property string|null $submit_type Describes the type of transaction being performed by Checkout in order to customize
relevant text on the page, such as the submit button. submit_type can only be
specified on Checkout Sessions in payment mode, but not Checkout Sessions
in subscription or setup mode.
subscription mode.
+ * @property string $success_url The URL the customer will be directed to after the payment or
subscription creation is successful.
* * @package Stripe\Checkout */ @@ -35,7 +35,8 @@ class Session extends \Stripe\ApiResource /** * Possible string representations of submit type. - * @link https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-submit_type + * + * @see https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-submit_type */ const SUBMIT_TYPE_AUTO = 'auto'; const SUBMIT_TYPE_BOOK = 'book'; diff --git a/lib/Collection.php b/lib/Collection.php index 8f601b280..6e232e008 100644 --- a/lib/Collection.php +++ b/lib/Collection.php @@ -157,6 +157,7 @@ public function autoPagingIterator() * behavior of the API when it attempts to return a page beyond the last. * * @param array|string|null $opts + * * @return Collection */ public static function emptyCollection($opts = null) @@ -167,7 +168,7 @@ public static function emptyCollection($opts = null) /** * Returns true if the page object contains no element. * - * @return boolean + * @return bool */ public function isEmpty() { @@ -182,6 +183,7 @@ public function isEmpty() * * @param array|null $params * @param array|string|null $opts + * * @return Collection */ public function nextPage($params = null, $opts = null) @@ -209,6 +211,7 @@ public function nextPage($params = null, $opts = null) * * @param array|null $params * @param array|string|null $opts + * * @return Collection */ public function previousPage($params = null, $opts = null) diff --git a/lib/CountrySpec.php b/lib/CountrySpec.php index de6745f22..ba6400d6b 100644 --- a/lib/CountrySpec.php +++ b/lib/CountrySpec.php @@ -5,13 +5,13 @@ /** * Class CountrySpec * - * @property string $id - * @property string $object - * @property string $default_currency - * @property \Stripe\StripeObject $supported_bank_account_currencies - * @property string[] $supported_payment_currencies - * @property string[] $supported_payment_methods - * @property string[] $supported_transfer_countries + * @property string $id Unique identifier for the object. Represented as the ISO country code for this country. + * @property string $object String representing the object's type. Objects of the same type share the same value. + * @property string $default_currency The default currency for this country. This applies to both payment methods and bank accounts. + * @property \Stripe\StripeObject $supported_bank_account_currencies Currencies that can be accepted in the specific country (for transfers). + * @property string[] $supported_payment_currencies Currencies that can be accepted in the specified country (for payments). + * @property string[] $supported_payment_methods Payment methods available in the specified country. You may need to enable some payment methods (e.g., ACH) on your account before they appear in this list. Thestripe payment method refers to charging through your platform.
+ * @property string[] $supported_transfer_countries Countries that can accept transfers from the specified country.
* @property \Stripe\StripeObject $verification_fields
*
* @package Stripe
diff --git a/lib/Coupon.php b/lib/Coupon.php
index 53300474b..a02726220 100644
--- a/lib/Coupon.php
+++ b/lib/Coupon.php
@@ -5,21 +5,21 @@
/**
* Class Coupon
*
- * @property string $id
- * @property string $object
- * @property int|null $amount_off
- * @property int $created
- * @property string|null $currency
- * @property string $duration
- * @property int|null $duration_in_months
- * @property bool $livemode
- * @property int|null $max_redemptions
- * @property \Stripe\StripeObject $metadata
- * @property string|null $name
- * @property float|null $percent_off
- * @property int|null $redeem_by
- * @property int $times_redeemed
- * @property bool $valid
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int|null $amount_off Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $currency If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
+ * @property string $duration One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
+ * @property int|null $duration_in_months If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int|null $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $name Name of the coupon displayed to customers on for instance invoices or receipts.
+ * @property float|null $percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.
+ * @property int|null $redeem_by Date after which the coupon can no longer be redeemed.
+ * @property int $times_redeemed Number of times this coupon has been applied to a customer.
+ * @property bool $valid Taking account of the above properties, whether this coupon can still be applied to a customer.
*
* @package Stripe
*/
diff --git a/lib/CreditNote.php b/lib/CreditNote.php
index 930c2457c..5f48275d7 100644
--- a/lib/CreditNote.php
+++ b/lib/CreditNote.php
@@ -5,30 +5,30 @@
/**
* Class CreditNote
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $created
- * @property string $currency
- * @property string|\Stripe\Customer $customer
- * @property string|\Stripe\CustomerBalanceTransaction|null $customer_balance_transaction
- * @property int $discount_amount
- * @property string|\Stripe\Invoice $invoice
- * @property \Stripe\Collection $lines
- * @property bool $livemode
- * @property string|null $memo
- * @property \Stripe\StripeObject $metadata
- * @property string $number
- * @property int|null $out_of_band_amount
- * @property string $pdf
- * @property string|null $reason
- * @property string|\Stripe\Refund|null $refund
- * @property string $status
- * @property int $subtotal
- * @property \Stripe\StripeObject[] $tax_amounts
- * @property int $total
- * @property string $type
- * @property int|null $voided_at
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount The integer amount in %s representing the total amount of the credit note, including tax.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer $customer ID of the customer.
+ * @property string|\Stripe\CustomerBalanceTransaction|null $customer_balance_transaction Customer balance transaction related to this credit note.
+ * @property int $discount_amount The integer amount in %s representing the amount of the discount that was credited.
+ * @property string|\Stripe\Invoice $invoice ID of the invoice.
+ * @property \Stripe\Collection $lines Line items that make up the credit note
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|null $memo Customer-facing text that appears on the credit note PDF.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $number A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
+ * @property int|null $out_of_band_amount Amount that was credited outside of Stripe.
+ * @property string $pdf The link to download the PDF of the credit note.
+ * @property string|null $reason Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
+ * @property string|\Stripe\Refund|null $refund Refund related to this credit note.
+ * @property string $status Status of this credit note, one of issued or void. Learn more about voiding credit notes.
+ * @property int $subtotal The integer amount in %s representing the amount of the credit note, excluding tax and discount.
+ * @property \Stripe\StripeObject[] $tax_amounts The aggregate amounts calculated per tax rate for all line items.
+ * @property int $total The integer amount in %s representing the total amount of the credit note, including tax and discount.
+ * @property string $type Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
+ * @property int|null $voided_at The time that the credit note was voided.
*
* @package Stripe
*/
@@ -44,7 +44,8 @@ class CreditNote extends ApiResource
/**
* Possible string representations of the credit note reason.
- * @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-reason
+ *
+ * @see https://stripe.com/docs/api/credit_notes/object#credit_note_object-reason
*/
const REASON_DUPLICATE = 'duplicate';
const REASON_FRAUDULENT = 'fraudulent';
@@ -53,14 +54,16 @@ class CreditNote extends ApiResource
/**
* Possible string representations of the credit note status.
- * @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
+ *
+ * @see https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
*/
const STATUS_ISSUED = 'issued';
const STATUS_VOID = 'void';
/**
* Possible string representations of the credit note type.
- * @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
+ *
+ * @see https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
*/
const TYPE_POST_PAYMENT = 'post_payment';
const TYPE_PRE_PAYMENT = 'pre_payment';
diff --git a/lib/Customer.php b/lib/Customer.php
index 2114571fc..4a08055c6 100644
--- a/lib/Customer.php
+++ b/lib/Customer.php
@@ -5,29 +5,29 @@
/**
* Class Customer
*
- * @property string $id
- * @property string $object
- * @property \Stripe\StripeObject|null $address
- * @property int $balance
- * @property int $created
- * @property string|null $currency
- * @property string|\Stripe\StripeObject|null $default_source
- * @property bool|null $delinquent
- * @property string|null $description
- * @property \Stripe\Discount|null $discount
- * @property string|null $email
- * @property string|null $invoice_prefix
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property \Stripe\StripeObject|null $address The customer's address.
+ * @property int $balance Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $currency Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
+ * @property string|\Stripe\StripeObject|null $default_source ID of the default payment source for the customer.
If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method field instead.
+ * @property bool|null $delinquent When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge is failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice is not paid by its due date. + * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users. + * @property \Stripe\Discount|null $discount Describes the current discount active on the customer, if there is one. + * @property string|null $email The customer's email address. + * @property string|null $invoice_prefix The prefix for the customer used to generate unique invoice numbers. * @property \Stripe\StripeObject $invoice_settings - * @property bool $livemode - * @property \Stripe\StripeObject $metadata - * @property string|null $name - * @property string|null $phone - * @property string[]|null $preferred_locales - * @property \Stripe\StripeObject|null $shipping - * @property \Stripe\Collection $sources - * @property \Stripe\Collection $subscriptions - * @property string|null $tax_exempt - * @property \Stripe\Collection $tax_ids + * @property bool $livemode Has the valuetrue if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $name The customer's full name or business name.
+ * @property string|null $phone The customer's phone number.
+ * @property string[]|null $preferred_locales The customer's preferred locales (languages), ordered by preference.
+ * @property \Stripe\StripeObject|null $shipping Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
+ * @property \Stripe\Collection $sources The customer's payment sources, if any.
+ * @property \Stripe\Collection $subscriptions The customer's current subscriptions, if any.
+ * @property string|null $tax_exempt Describes the customer's tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text "Reverse charge".
+ * @property \Stripe\Collection $tax_ids The customer's tax IDs.
*
* @package Stripe
*/
@@ -44,7 +44,8 @@ class Customer extends ApiResource
/**
* Possible string representations of the customer's type of tax exemption.
- * @link https://stripe.com/docs/api/customers/object#customer_object-tax_exempt
+ *
+ * @see https://stripe.com/docs/api/customers/object#customer_object-tax_exempt
*/
const TAX_EXEMPT_NONE = 'none';
const TAX_EXEMPT_EXEMPT = 'exempt';
diff --git a/lib/CustomerBalanceTransaction.php b/lib/CustomerBalanceTransaction.php
index ae17bde6d..a0a7b32a5 100644
--- a/lib/CustomerBalanceTransaction.php
+++ b/lib/CustomerBalanceTransaction.php
@@ -27,7 +27,8 @@ class CustomerBalanceTransaction extends ApiResource
/**
* Possible string representations of a balance transaction's type.
- * @link https://stripe.com/docs/api/customers/customer_balance_transaction_object#customer_balance_transaction_object-type
+ *
+ * @see https://stripe.com/docs/api/customers/customer_balance_transaction_object#customer_balance_transaction_object-type
*/
const TYPE_ADJUSTEMENT = 'adjustment';
const TYPE_APPLIED_TO_INVOICE = 'applied_to_invoice';
diff --git a/lib/Dispute.php b/lib/Dispute.php
index 52fb463b3..2b0c19234 100644
--- a/lib/Dispute.php
+++ b/lib/Dispute.php
@@ -5,22 +5,22 @@
/**
* Class Dispute
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property \Stripe\BalanceTransaction[] $balance_transactions
- * @property string|\Stripe\Charge $charge
- * @property int $created
- * @property string $currency
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
+ * @property \Stripe\BalanceTransaction[] $balance_transactions List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
+ * @property string|\Stripe\Charge $charge ID of the charge that was disputed.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
* @property \Stripe\StripeObject $evidence
* @property \Stripe\StripeObject $evidence_details
- * @property bool $is_charge_refundable
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string|null $network_reason_code
- * @property string|\Stripe\PaymentIntent|null $payment_intent
- * @property string $reason
- * @property string $status
+ * @property bool $is_charge_refundable If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $network_reason_code Network-dependent reason code for the dispute.
+ * @property string|\Stripe\PaymentIntent|null $payment_intent ID of the PaymentIntent that was disputed.
+ * @property string $reason Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Read more about dispute reasons.
+ * @property string $status Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.
*
* @package Stripe
*/
@@ -34,7 +34,8 @@ class Dispute extends ApiResource
/**
* Possible string representations of dispute reasons.
- * @link https://stripe.com/docs/api#dispute_object
+ *
+ * @see https://stripe.com/docs/api#dispute_object
*/
const REASON_BANK_CANNOT_PROCESS = 'bank_cannot_process';
const REASON_CHECK_RETURNED = 'check_returned';
@@ -53,7 +54,8 @@ class Dispute extends ApiResource
/**
* Possible string representations of dispute statuses.
- * @link https://stripe.com/docs/api#dispute_object
+ *
+ * @see https://stripe.com/docs/api#dispute_object
*/
const STATUS_CHARGE_REFUNDED = 'charge_refunded';
const STATUS_LOST = 'lost';
diff --git a/lib/EphemeralKey.php b/lib/EphemeralKey.php
index 1b7fd82da..3cd85d7d0 100644
--- a/lib/EphemeralKey.php
+++ b/lib/EphemeralKey.php
@@ -5,12 +5,12 @@
/**
* Class EphemeralKey
*
- * @property string $id
- * @property string $object
- * @property int $created
- * @property int $expires
- * @property bool $livemode
- * @property string $secret
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $expires Time at which the key will expire. Measured in seconds since the Unix epoch.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $secret The key's secret. You can use this value to make authorized requests to the Stripe API.
* @property array $associated_objects
*
* @package Stripe
diff --git a/lib/ErrorObject.php b/lib/ErrorObject.php
index 285a51154..d54eb8349 100644
--- a/lib/ErrorObject.php
+++ b/lib/ErrorObject.php
@@ -38,7 +38,8 @@ class ErrorObject extends StripeObject
{
/**
* Possible string representations of an error's code.
- * @link https://stripe.com/docs/error-codes
+ *
+ * @see https://stripe.com/docs/error-codes
*/
const CODE_ACCOUNT_ALREADY_EXISTS = 'account_already_exists';
const CODE_ACCOUNT_COUNTRY_INVALID_ADDRESS = 'account_country_invalid_address';
@@ -136,8 +137,8 @@ class ErrorObject extends StripeObject
* Refreshes this object using the provided values.
*
* @param array $values
- * @param null|string|array|Util\RequestOptions $opts
- * @param boolean $partial Defaults to false.
+ * @param array|string|Util\RequestOptions|null $opts
+ * @param bool $partial Defaults to false.
*/
public function refreshFrom($values, $opts, $partial = false)
{
diff --git a/lib/Event.php b/lib/Event.php
index 99f1613ea..e3fe65814 100644
--- a/lib/Event.php
+++ b/lib/Event.php
@@ -5,16 +5,16 @@
/**
* Class Event
*
- * @property string $id
- * @property string $object
- * @property string $account
- * @property string|null $api_version
- * @property int $created
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string $account The connected account that originated the event.
+ * @property string|null $api_version The Stripe API version used to render data. Note: This property is populated only for events on or after October 31, 2014.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @property \Stripe\StripeObject $data
- * @property bool $livemode
- * @property int $pending_webhooks
- * @property \Stripe\StripeObject|null $request
- * @property string $type
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $pending_webhooks Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.
+ * @property \Stripe\StripeObject|null $request Information on the API request that instigated the event.
+ * @property string $type Description of the event (e.g., invoice.created or charge.refunded).
*
* @package Stripe
*/
@@ -27,7 +27,8 @@ class Event extends ApiResource
/**
* Possible string representations of event types.
- * @link https://stripe.com/docs/api#event_types
+ *
+ * @see https://stripe.com/docs/api#event_types
*/
const ACCOUNT_UPDATED = 'account.updated';
const ACCOUNT_APPLICATION_AUTHORIZED = 'account.application.authorized';
diff --git a/lib/ExchangeRate.php b/lib/ExchangeRate.php
index ff6cc1419..003a27c5b 100644
--- a/lib/ExchangeRate.php
+++ b/lib/ExchangeRate.php
@@ -5,9 +5,9 @@
/**
* Class ExchangeRate
*
- * @property string $id
- * @property string $object
- * @property \Stripe\StripeObject $rates
+ * @property string $id Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property \Stripe\StripeObject $rates Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
*
* @package Stripe
*/
diff --git a/lib/File.php b/lib/File.php
index 0e6438b5e..1a81142c6 100644
--- a/lib/File.php
+++ b/lib/File.php
@@ -5,16 +5,16 @@
/**
* Class File
*
- * @property string $id
- * @property string $object
- * @property int $created
- * @property string|null $filename
- * @property \Stripe\Collection|null $links
- * @property string $purpose
- * @property int $size
- * @property string|null $title
- * @property string|null $type
- * @property string|null $url
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $filename A filename for the file, suitable for saving to a filesystem.
+ * @property \Stripe\Collection|null $links A list of file links that point at this file.
+ * @property string $purpose The purpose of the file. Possible values are additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document, pci_document, sigma_scheduled_query, or tax_document_user_upload.
+ * @property int $size The size in bytes of the file object.
+ * @property string|null $title A user friendly title for the document.
+ * @property string|null $type The type of the file returned (e.g., csv, pdf, jpg, or png).
+ * @property string|null $url The URL from which the file can be downloaded using your live secret API key.
*
* @package Stripe
*/
diff --git a/lib/FileLink.php b/lib/FileLink.php
index b0ed661d3..7b6c9e551 100644
--- a/lib/FileLink.php
+++ b/lib/FileLink.php
@@ -5,15 +5,15 @@
/**
* Class FileLink
*
- * @property string $id
- * @property string $object
- * @property int $created
- * @property bool $expired
- * @property int|null $expires_at
- * @property string|\Stripe\File $file
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string|null $url
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property bool $expired Whether this link is already expired.
+ * @property int|null $expires_at Time at which the link expires.
+ * @property string|\Stripe\File $file The file object this link points to.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $url The publicly accessible URL to download the file.
*
* @package Stripe
*/
diff --git a/lib/HttpClient/ClientInterface.php b/lib/HttpClient/ClientInterface.php
index 4d31e4f1c..ec4ef3a6b 100644
--- a/lib/HttpClient/ClientInterface.php
+++ b/lib/HttpClient/ClientInterface.php
@@ -9,11 +9,12 @@ interface ClientInterface
* @param string $absUrl The URL being requested, including domain and protocol
* @param array $headers Headers to be used in the request (full strings, not KV pairs)
* @param array $params KV pairs for parameters. Can be nested for arrays and hashes
- * @param boolean $hasFile Whether or not $params references a file (via an @ prefix or
+ * @param bool $hasFile Whether or not $params references a file (via an @ prefix or
* CURLFile)
*
* @throws \Stripe\Exception\ApiConnectionException
* @throws \Stripe\Exception\UnexpectedValueException
+ *
* @return array An array whose first element is raw request body, second
* element is HTTP status code and third array of HTTP headers.
*/
diff --git a/lib/HttpClient/CurlClient.php b/lib/HttpClient/CurlClient.php
index c12ab9731..11b1b7e17 100644
--- a/lib/HttpClient/CurlClient.php
+++ b/lib/HttpClient/CurlClient.php
@@ -63,6 +63,7 @@ public static function instance()
* throw an exception if $defaultOptions returns a non-array value.
*
* @param array|callable|null $defaultOptions
+ * @param \Stripe\Util\RandomGenerator|null $randomGenerator
*/
public function __construct($defaultOptions = null, $randomGenerator = null)
{
@@ -98,7 +99,7 @@ public function getUserAgentInfo()
}
/**
- * @return boolean
+ * @return bool
*/
public function getEnablePersistentConnections()
{
@@ -106,7 +107,7 @@ public function getEnablePersistentConnections()
}
/**
- * @param boolean $enable
+ * @param bool $enable
*/
public function setEnablePersistentConnections($enable)
{
@@ -114,7 +115,7 @@ public function setEnablePersistentConnections($enable)
}
/**
- * @return boolean
+ * @return bool
*/
public function getEnableHttp2()
{
@@ -122,7 +123,7 @@ public function getEnableHttp2()
}
/**
- * @param boolean $enable
+ * @param bool $enable
*/
public function setEnableHttp2($enable)
{
@@ -273,6 +274,7 @@ public function request($method, $absUrl, $headers, $params, $hasFile)
/**
* @param array $opts cURL options
+ * @param string $absUrl
*/
private function executeRequestWithRetries($opts, $absUrl)
{
@@ -341,6 +343,7 @@ private function executeRequestWithRetries($opts, $absUrl)
* @param int $errno
* @param string $message
* @param int $numRetries
+ *
* @throws Exception\ApiConnectionException
*/
private function handleCurlError($url, $errno, $message, $numRetries)
@@ -504,7 +507,7 @@ private function resetCurlHandle()
/**
* Indicates whether it is safe to use HTTP/2 or not.
*
- * @return boolean
+ * @return bool
*/
private function canSafelyUseHttp2()
{
@@ -519,7 +522,8 @@ private function canSafelyUseHttp2()
*
* @param string[] $headers
* @param string $name
- * @return boolean
+ *
+ * @return bool
*/
private function hasHeader($headers, $name)
{
diff --git a/lib/Invoice.php b/lib/Invoice.php
index f44e27070..beb4f0ec1 100644
--- a/lib/Invoice.php
+++ b/lib/Invoice.php
@@ -5,66 +5,66 @@
/**
* Class Invoice
*
- * @property string $id
- * @property string $object
- * @property string|null $account_country
- * @property string|null $account_name
- * @property int $amount_due
- * @property int $amount_paid
- * @property int $amount_remaining
- * @property int|null $application_fee_amount
- * @property int $attempt_count
- * @property bool $attempted
- * @property bool $auto_advance
- * @property string|null $billing_reason
- * @property string|\Stripe\Charge|null $charge
- * @property string|null $collection_method
- * @property int $created
- * @property string $currency
- * @property \Stripe\StripeObject[]|null $custom_fields
- * @property string|\Stripe\Customer $customer
- * @property \Stripe\StripeObject|null $customer_address
- * @property string|null $customer_email
- * @property string|null $customer_name
- * @property string|null $customer_phone
- * @property \Stripe\StripeObject|null $customer_shipping
- * @property string|null $customer_tax_exempt
- * @property \Stripe\StripeObject[]|null $customer_tax_ids
- * @property string|\Stripe\PaymentMethod|null $default_payment_method
- * @property string|\Stripe\StripeObject|null $default_source
- * @property \Stripe\TaxRate[]|null $default_tax_rates
- * @property string|null $description
- * @property \Stripe\Discount|null $discount
- * @property int|null $due_date
- * @property int|null $ending_balance
- * @property string|null $footer
- * @property string|null $hosted_invoice_url
- * @property string|null $invoice_pdf
- * @property \Stripe\Collection $lines
- * @property bool $livemode
- * @property \Stripe\StripeObject|null $metadata
- * @property int|null $next_payment_attempt
- * @property string|null $number
- * @property bool $paid
- * @property string|\Stripe\PaymentIntent|null $payment_intent
- * @property int $period_end
- * @property int $period_start
- * @property int $post_payment_credit_notes_amount
- * @property int $pre_payment_credit_notes_amount
- * @property string|null $receipt_number
- * @property int $starting_balance
- * @property string|null $statement_descriptor
- * @property string|null $status
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|null $account_country The country of the business associated with this invoice, most often the business creating the invoice.
+ * @property string|null $account_name The public name of the business associated with this invoice, most often the business creating the invoice.
+ * @property int $amount_due Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
+ * @property int $amount_paid The amount, in %s, that was paid.
+ * @property int $amount_remaining The amount remaining, in %s, that is due.
+ * @property int|null $application_fee_amount The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
+ * @property int $attempt_count Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.
+ * @property bool $attempted Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
+ * @property bool $auto_advance Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action.
+ * @property string|null $billing_reason Indicates the reason why the invoice was created. subscription_cycle indicates an invoice created by a subscription advancing into a new period. subscription_create indicates an invoice created due to creating a subscription. subscription_update indicates an invoice created due to updating a subscription. subscription is set for all old invoices to indicate either a change to a subscription or a period advancement. manual is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The upcoming value is reserved for simulated invoices per the upcoming invoice endpoint. subscription_threshold indicates an invoice created due to a billing threshold being reached.
+ * @property string|\Stripe\Charge|null $charge ID of the latest charge generated for this invoice, if any.
+ * @property string|null $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\StripeObject[]|null $custom_fields Custom fields displayed on the invoice.
+ * @property string|\Stripe\Customer $customer The ID of the customer who will be billed.
+ * @property \Stripe\StripeObject|null $customer_address The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
+ * @property string|null $customer_email The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
+ * @property string|null $customer_name The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
+ * @property string|null $customer_phone The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
+ * @property \Stripe\StripeObject|null $customer_shipping The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
+ * @property string|null $customer_tax_exempt The customer's tax exempt status. Until the invoice is finalized, this field will equal customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.
+ * @property \Stripe\StripeObject[]|null $customer_tax_ids The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
+ * @property string|\Stripe\PaymentMethod|null $default_payment_method ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
+ * @property string|\Stripe\StripeObject|null $default_source ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
+ * @property \Stripe\TaxRate[]|null $default_tax_rates The tax rates applied to this invoice, if any.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
+ * @property \Stripe\Discount|null $discount Describes the current discount applied to this invoice, if there is one.
+ * @property int|null $due_date The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
+ * @property int|null $ending_balance Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
+ * @property string|null $footer Footer displayed on the invoice.
+ * @property string|null $hosted_invoice_url The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
+ * @property string|null $invoice_pdf The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
+ * @property \Stripe\Collection $lines The individual line items that make up the invoice. lines is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject|null $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property int|null $next_payment_attempt The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
+ * @property string|null $number A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
+ * @property bool $paid Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
+ * @property string|\Stripe\PaymentIntent|null $payment_intent The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
+ * @property int $period_end End of the usage period during which invoice items were added to this invoice.
+ * @property int $period_start Start of the usage period during which invoice items were added to this invoice.
+ * @property int $post_payment_credit_notes_amount Total amount of all post-payment credit notes issued for this invoice.
+ * @property int $pre_payment_credit_notes_amount Total amount of all pre-payment credit notes issued for this invoice.
+ * @property string|null $receipt_number This is the transaction number that appears on email receipts sent for this invoice.
+ * @property int $starting_balance Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.
+ * @property string|null $statement_descriptor Extra information about an invoice for the customer's credit card statement.
+ * @property string|null $status The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
* @property \Stripe\StripeObject $status_transitions
- * @property string|\Stripe\Subscription|null $subscription
- * @property int $subscription_proration_date
- * @property int $subtotal
- * @property int|null $tax
- * @property float|null $tax_percent
+ * @property string|\Stripe\Subscription|null $subscription The subscription that this invoice was prepared for, if any.
+ * @property int $subscription_proration_date Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
+ * @property int $subtotal Total of all subscriptions, invoice items, and prorations on the invoice before any discount or tax is applied.
+ * @property int|null $tax The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
+ * @property float|null $tax_percent This percentage of the subtotal has been added to the total amount of the invoice, including invoice line items and discounts. This field is inherited from the subscription's tax_percent field, but can be changed before the invoice is paid. This field defaults to null.
* @property \Stripe\StripeObject $threshold_reason
- * @property int $total
- * @property \Stripe\StripeObject[]|null $total_tax_amounts
- * @property int|null $webhooks_delivered_at
+ * @property int $total Total after discounts and taxes.
+ * @property \Stripe\StripeObject[]|null $total_tax_amounts The aggregate amounts calculated per tax rate for all line items.
+ * @property int|null $webhooks_delivered_at The time at which webhooks for this invoice were successfully delivered (if the invoice had no webhooks to deliver, this will match created). Invoice payment is delayed until webhooks are delivered, or until all webhook delivery attempts have been exhausted.
*
* @package Stripe
*/
@@ -82,7 +82,8 @@ class Invoice extends ApiResource
/**
* Possible string representations of the billing reason.
- * @link https://stripe.com/docs/api/invoices/object#invoice_object-billing_reason
+ *
+ * @see https://stripe.com/docs/api/invoices/object#invoice_object-billing_reason
*/
const BILLING_REASON_MANUAL = 'manual';
const BILLING_REASON_SUBSCRIPTION = 'subscription';
@@ -94,14 +95,16 @@ class Invoice extends ApiResource
/**
* Possible string representations of the `collection_method` property.
- * @link https://stripe.com/docs/api/invoices/object#invoice_object-collection_method
+ *
+ * @see https://stripe.com/docs/api/invoices/object#invoice_object-collection_method
*/
const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically';
const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice';
/**
* Possible string representations of the invoice status.
- * @link https://stripe.com/docs/api/invoices/object#invoice_object-status
+ *
+ * @see https://stripe.com/docs/api/invoices/object#invoice_object-status
*/
const STATUS_DRAFT = 'draft';
const STATUS_OPEN = 'open';
@@ -111,8 +114,9 @@ class Invoice extends ApiResource
/**
* Possible string representations of the `billing` property.
+ *
* @deprecated Use `collection_method` instead.
- * @link https://stripe.com/docs/api/invoices/object#invoice_object-billing
+ * @see https://stripe.com/docs/api/invoices/object#invoice_object-billing
*/
const BILLING_CHARGE_AUTOMATICALLY = 'charge_automatically';
const BILLING_SEND_INVOICE = 'send_invoice';
diff --git a/lib/InvoiceItem.php b/lib/InvoiceItem.php
index a275809e3..7da70a0aa 100644
--- a/lib/InvoiceItem.php
+++ b/lib/InvoiceItem.php
@@ -5,27 +5,27 @@
/**
* Class InvoiceItem
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property string $currency
- * @property string|\Stripe\Customer $customer
- * @property int $date
- * @property string|null $description
- * @property bool $discountable
- * @property string|\Stripe\Invoice|null $invoice
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer $customer The ID of the customer who will be billed when this invoice item is billed.
+ * @property int $date Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property bool $discountable If true, discounts will apply to this invoice item. Always false for prorations.
+ * @property string|\Stripe\Invoice|null $invoice The ID of the invoice this invoice item belongs to.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* @property \Stripe\StripeObject $period
- * @property \Stripe\Plan|null $plan
- * @property bool $proration
- * @property int $quantity
- * @property string|\Stripe\Subscription|null $subscription
- * @property string $subscription_item
- * @property \Stripe\TaxRate[]|null $tax_rates
- * @property bool $unified_proration
- * @property int|null $unit_amount
- * @property string|null $unit_amount_decimal
+ * @property \Stripe\Plan|null $plan If the invoice item is a proration, the plan of the subscription that the proration was computed for.
+ * @property bool $proration Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
+ * @property int $quantity Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
+ * @property string|\Stripe\Subscription|null $subscription The subscription that this invoice item has been created for, if any.
+ * @property string $subscription_item The subscription item that this invoice item has been created for, if any.
+ * @property \Stripe\TaxRate[]|null $tax_rates The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
+ * @property bool $unified_proration For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.
+ * @property int|null $unit_amount Unit Amount (in the currency specified) of the invoice item.
+ * @property string|null $unit_amount_decimal Same as unit_amount, but contains a decimal value with at most 12 decimal places.
*
* @package Stripe
*/
diff --git a/lib/Issuing/Authorization.php b/lib/Issuing/Authorization.php
index 28cf18985..83261b194 100644
--- a/lib/Issuing/Authorization.php
+++ b/lib/Issuing/Authorization.php
@@ -5,29 +5,29 @@
/**
* Class Authorization
*
- * @property string $id
- * @property string $object
- * @property bool $approved
- * @property string $authorization_method
- * @property int $authorized_amount
- * @property string $authorized_currency
- * @property \Stripe\BalanceTransaction[] $balance_transactions
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property bool $approved Whether the authorization has been approved.
+ * @property string $authorization_method How the card details were provided.
+ * @property int $authorized_amount The amount that has been authorized. This will be 0 when the object is created, and increase after it has been approved.
+ * @property string $authorized_currency The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this authorization.
* @property \Stripe\Issuing\Card $card
- * @property string|\Stripe\Issuing\Cardholder|null $cardholder
- * @property int $created
- * @property int $held_amount
- * @property string $held_currency
- * @property bool $is_held_amount_controllable
- * @property bool $livemode
+ * @property string|\Stripe\Issuing\Cardholder|null $cardholder The cardholder to whom this authorization belongs.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $held_amount The amount the authorization is expected to be in held_currency. When Stripe holds funds from you, this is the amount reserved for the authorization. This will be 0 when the object is created, and increase after it has been approved. For multi-currency transactions, held_amount can be used to determine the expected exchange rate.
+ * @property string $held_currency The currency of the held amount. This will always be the card currency.
+ * @property bool $is_held_amount_controllable If set true, you may provide held_amount to control how much to hold for the authorization.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property \Stripe\StripeObject $merchant_data
- * @property \Stripe\StripeObject $metadata
- * @property int $pending_authorized_amount
- * @property int $pending_held_amount
- * @property \Stripe\StripeObject[] $request_history
- * @property string $status
- * @property \Stripe\Issuing\Transaction[] $transactions
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property int $pending_authorized_amount The amount the user is requesting to be authorized. This field will only be non-zero during an issuing.authorization.request webhook.
+ * @property int $pending_held_amount The additional amount Stripe will hold if the authorization is approved. This field will only be non-zero during an issuing.authorization.request webhook.
+ * @property \Stripe\StripeObject[] $request_history History of every time the authorization was approved/denied (whether approved/denied by you directly, or by Stripe based on your authorization_controls). If the merchant changes the authorization by performing an incremental authorization or partial capture, you can look at request_history to see the previous states of the authorization.
+ * @property string $status The current status of the authorization in its lifecycle.
+ * @property \Stripe\Issuing\Transaction[] $transactions List of transactions associated with this authorization.
* @property \Stripe\StripeObject $verification_data
- * @property string|null $wallet_provider
+ * @property string|null $wallet_provider What, if any, digital wallet was used for this authorization. One of apple_pay, google_pay, or samsung_pay.
*
* @package Stripe\Issuing
*/
diff --git a/lib/Issuing/Card.php b/lib/Issuing/Card.php
index 63459a777..452330e9f 100644
--- a/lib/Issuing/Card.php
+++ b/lib/Issuing/Card.php
@@ -5,25 +5,25 @@
/**
* Class Card
*
- * @property string $id
- * @property string $object
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\StripeObject $authorization_controls
- * @property string $brand
- * @property \Stripe\Issuing\Cardholder|null $cardholder
- * @property int $created
- * @property string $currency
- * @property int $exp_month
- * @property int $exp_year
- * @property string $last4
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string $name
- * @property \Stripe\StripeObject|null $pin
- * @property string|\Stripe\Issuing\Card|null $replacement_for
- * @property string|null $replacement_reason
- * @property \Stripe\StripeObject|null $shipping
- * @property string $status
- * @property string $type
+ * @property string $brand The brand of the card.
+ * @property \Stripe\Issuing\Cardholder|null $cardholder The Cardholder object to which the card belongs.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property int $exp_month The expiration month of the card.
+ * @property int $exp_year The expiration year of the card.
+ * @property string $last4 The last 4 digits of the card number.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $name The name of the cardholder, printed on the card.
+ * @property \Stripe\StripeObject|null $pin Metadata about the PIN on the card.
+ * @property string|\Stripe\Issuing\Card|null $replacement_for The card this card replaces, if any.
+ * @property string|null $replacement_reason The reason why the previous card needed to be replaced.
+ * @property \Stripe\StripeObject|null $shipping Where and how the card will be shipped.
+ * @property string $status Whether authorizations can be approved on this card.
+ * @property string $type The type of the card.
*
* @package Stripe\Issuing
*/
diff --git a/lib/Issuing/Cardholder.php b/lib/Issuing/Cardholder.php
index 3768c1e2a..e1f554f55 100644
--- a/lib/Issuing/Cardholder.php
+++ b/lib/Issuing/Cardholder.php
@@ -5,22 +5,22 @@
/**
* Class Cardholder
*
- * @property string $id
- * @property string $object
- * @property \Stripe\StripeObject|null $authorization_controls
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property \Stripe\StripeObject|null $authorization_controls Spending rules that give you some control over how this cardholder's cards can be used. Refer to our authorizations documentation for more details.
* @property \Stripe\StripeObject $billing
- * @property \Stripe\StripeObject|null $company
- * @property int $created
- * @property string|null $email
- * @property \Stripe\StripeObject|null $individual
- * @property bool $is_default
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string $name
- * @property string|null $phone_number
+ * @property \Stripe\StripeObject|null $company Additional information about a business_entity cardholder.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $email The cardholder's email address.
+ * @property \Stripe\StripeObject|null $individual Additional information about an individual cardholder.
+ * @property bool $is_default Whether or not this cardholder is the default cardholder.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $name The cardholder's name. This will be printed on cards issued to them.
+ * @property string|null $phone_number The cardholder's phone number.
* @property \Stripe\StripeObject $requirements
- * @property string $status
- * @property string $type
+ * @property string $status Specifies whether to permit authorizations on this cardholder's cards.
+ * @property string $type One of individual or business_entity.
*
* @package Stripe\Issuing
*/
diff --git a/lib/Issuing/Dispute.php b/lib/Issuing/Dispute.php
index 9572519a3..985b1f526 100644
--- a/lib/Issuing/Dispute.php
+++ b/lib/Issuing/Dispute.php
@@ -5,17 +5,17 @@
/**
* Class Dispute
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $created
- * @property string $currency
- * @property string|\Stripe\Issuing\Transaction $disputed_transaction
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Disputed amount. Usually the amount of the disputed_transaction, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency The currency the disputed_transaction was made in.
+ * @property string|\Stripe\Issuing\Transaction $disputed_transaction The transaction being disputed.
* @property \Stripe\StripeObject $evidence
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string $reason
- * @property string $status
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $reason Reason for this dispute. One of fraudulent or other.
+ * @property string $status Current status of dispute. One of unsubmitted, under_review, won, or lost.
*
* @package Stripe\Issuing
*/
diff --git a/lib/Issuing/Transaction.php b/lib/Issuing/Transaction.php
index f2988c92e..6494d45bd 100644
--- a/lib/Issuing/Transaction.php
+++ b/lib/Issuing/Transaction.php
@@ -5,22 +5,22 @@
/**
* Class Transaction
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property string|\Stripe\Issuing\Authorization|null $authorization
- * @property string|\Stripe\BalanceTransaction|null $balance_transaction
- * @property string|\Stripe\Issuing\Card $card
- * @property string|\Stripe\Issuing\Cardholder|null $cardholder
- * @property int $created
- * @property string $currency
- * @property string|\Stripe\Issuing\Dispute|null $dispute
- * @property bool $livemode
- * @property int $merchant_amount
- * @property string $merchant_currency
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount The amount of this transaction in your currency. This is the amount that your balance will be updated by.
+ * @property string|\Stripe\Issuing\Authorization|null $authorization The Authorization object that led to this transaction.
+ * @property string|\Stripe\BalanceTransaction|null $balance_transaction ID of the balance transaction associated with this transaction.
+ * @property string|\Stripe\Issuing\Card $card The card used to make this transaction.
+ * @property string|\Stripe\Issuing\Cardholder|null $cardholder The cardholder to whom this transaction belongs.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Issuing\Dispute|null $dispute If you've disputed the transaction, the ID of the dispute object.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $merchant_amount The amount that the merchant will receive, denominated in merchant_currency. It will be different from amount if the merchant is taking payment in a different currency.
+ * @property string $merchant_currency The currency with which the merchant is taking payment.
* @property \Stripe\StripeObject $merchant_data
- * @property \Stripe\StripeObject $metadata
- * @property string $type
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $type The nature of the transaction.
*
* @package Stripe\Issuing
*/
diff --git a/lib/Mandate.php b/lib/Mandate.php
index 8538844ee..15ea3764e 100644
--- a/lib/Mandate.php
+++ b/lib/Mandate.php
@@ -5,16 +5,16 @@
/**
* Class Mandate
*
- * @property string $id
- * @property string $object
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\StripeObject $customer_acceptance
- * @property bool $livemode
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property \Stripe\StripeObject $multi_use
- * @property string|\Stripe\PaymentMethod $payment_method
+ * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method associated with this mandate.
* @property \Stripe\StripeObject $payment_method_details
* @property \Stripe\StripeObject $single_use
- * @property string $status
- * @property string $type
+ * @property string $status The status of the Mandate, one of pending, inactive, or active. The Mandate can be used to initiate a payment only if status=active.
+ * @property string $type The type of the mandate, one of single_use or multi_use
*
* @package Stripe
*/
diff --git a/lib/OAuthErrorObject.php b/lib/OAuthErrorObject.php
index ca2bbc553..6cd355fd6 100644
--- a/lib/OAuthErrorObject.php
+++ b/lib/OAuthErrorObject.php
@@ -16,8 +16,8 @@ class OAuthErrorObject extends StripeObject
* Refreshes this object using the provided values.
*
* @param array $values
- * @param null|string|array|Util\RequestOptions $opts
- * @param boolean $partial Defaults to false.
+ * @param array|string|Util\RequestOptions|null $opts
+ * @param bool $partial Defaults to false.
*/
public function refreshFrom($values, $opts, $partial = false)
{
diff --git a/lib/Order.php b/lib/Order.php
index 86b621c2e..99200980b 100644
--- a/lib/Order.php
+++ b/lib/Order.php
@@ -5,29 +5,29 @@
/**
* Class Order
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int|null $amount_returned
- * @property string|null $application
- * @property int|null $application_fee
- * @property string|\Stripe\Charge|null $charge
- * @property int $created
- * @property string $currency
- * @property string|\Stripe\Customer|null $customer
- * @property string|null $email
- * @property string $external_coupon_code
- * @property \Stripe\OrderItem[] $items
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property \Stripe\Collection|null $returns
- * @property string|null $selected_shipping_method
- * @property \Stripe\StripeObject|null $shipping
- * @property \Stripe\StripeObject[]|null $shipping_methods
- * @property string $status
- * @property \Stripe\StripeObject|null $status_transitions
- * @property int|null $updated
- * @property string $upstream_id
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
+ * @property int|null $amount_returned The total amount that was returned to the customer.
+ * @property string|null $application ID of the Connect Application that created the order.
+ * @property int|null $application_fee A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
+ * @property string|\Stripe\Charge|null $charge The ID of the payment used to pay for the order. Present if the order status is paid, fulfilled, or refunded.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer|null $customer The customer used for the order.
+ * @property string|null $email The email address of the customer placing the order.
+ * @property string $external_coupon_code External coupon code to load for this order.
+ * @property \Stripe\OrderItem[] $items List of items constituting the order. An order can have up to 25 items.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property \Stripe\Collection|null $returns A list of returns that have taken place for this order.
+ * @property string|null $selected_shipping_method The shipping method that is currently selected for this order, if any. If present, it is equal to one of the ids of shipping methods in the shipping_methods array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method.
+ * @property \Stripe\StripeObject|null $shipping The shipping address for the order. Present if the order is for goods to be shipped.
+ * @property \Stripe\StripeObject[]|null $shipping_methods A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it.
+ * @property string $status Current order status. One of created, paid, canceled, fulfilled, or returned. More details in the Orders Guide.
+ * @property \Stripe\StripeObject|null $status_transitions The timestamps at which the order status was updated.
+ * @property int|null $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
+ * @property string $upstream_id The user's order ID if it is different from the Stripe order ID.
*
* @package Stripe
*/
diff --git a/lib/OrderReturn.php b/lib/OrderReturn.php
index 0195a77ba..4140adc1b 100644
--- a/lib/OrderReturn.php
+++ b/lib/OrderReturn.php
@@ -5,15 +5,15 @@
/**
* Class OrderReturn
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $created
- * @property string $currency
- * @property \Stripe\OrderItem[] $items
- * @property bool $livemode
- * @property string|\Stripe\Order|null $order
- * @property string|\Stripe\Refund|null $refund
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\OrderItem[] $items The items included in this order return.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|\Stripe\Order|null $order The order that this return includes items from.
+ * @property string|\Stripe\Refund|null $refund The ID of the refund issued for this return.
*
* @package Stripe
*/
diff --git a/lib/PaymentIntent.php b/lib/PaymentIntent.php
index 3163fcee0..a09f32ee3 100644
--- a/lib/PaymentIntent.php
+++ b/lib/PaymentIntent.php
@@ -5,42 +5,42 @@
/**
* Class PaymentIntent
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $amount_capturable
- * @property int $amount_received
- * @property string|\Stripe\StripeObject|null $application
- * @property int|null $application_fee_amount
- * @property int|null $canceled_at
- * @property string|null $cancellation_reason
- * @property string $capture_method
- * @property \Stripe\Collection $charges
- * @property string|null $client_secret
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+ * @property int $amount_capturable Amount that can be captured from this PaymentIntent.
+ * @property int $amount_received Amount that was collected by this PaymentIntent.
+ * @property string|\Stripe\StripeObject|null $application ID of the Connect application that created the PaymentIntent.
+ * @property int|null $application_fee_amount The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts for details.
+ * @property int|null $canceled_at Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
+ * @property string|null $cancellation_reason Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
+ * @property string $capture_method Controls when the funds will be captured from the customer's account.
+ * @property \Stripe\Collection $charges Charges that were created by this PaymentIntent, if any.
+ * @property string|null $client_secret The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Refer to our docs to accept a payment and learn about how client_secret should be handled.
ID of the Customer this PaymentIntent belongs to, if one exists.
If present, payment methods used with this PaymentIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this PaymentIntent.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users. + * @property string|\Stripe\Invoice|null $invoice ID of the invoice that created this PaymentIntent, if it exists. + * @property \Stripe\ErrorObject|null $last_payment_error The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. + * @property bool $livemode Has the valuetrue if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the documentation.
+ * @property \Stripe\StripeObject|null $next_action If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
+ * @property string|\Stripe\Account|null $on_behalf_of The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.
+ * @property string|\Stripe\PaymentMethod|null $payment_method ID of the payment method used in this PaymentIntent.
+ * @property \Stripe\StripeObject|null $payment_method_options Payment-method-specific configuration for this PaymentIntent.
+ * @property string[] $payment_method_types The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
+ * @property string|null $receipt_email Email address that the receipt for the resulting payment will be sent to.
+ * @property string|\Stripe\Review|null $review ID of the review associated with this PaymentIntent, if any.
+ * @property string|null $setup_future_usage Indicates that you intend to make future payments with this PaymentIntent's payment method.
If present, the payment method used with this PaymentIntent can be attached to a Customer, even after the transaction completes.
For more, learn to save card details after a payment.
Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by SCA, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.
requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
+ * @property \Stripe\StripeObject|null $transfer_data The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.
+ * @property string|null $transfer_group A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
*
* @package Stripe
*/
@@ -56,7 +56,7 @@ class PaymentIntent extends ApiResource
/**
* These constants are possible representations of the status field.
*
- * @link https://stripe.com/docs/api/payment_intents/object#payment_intent_object-status
+ * @see https://stripe.com/docs/api/payment_intents/object#payment_intent_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_PROCESSING = 'processing';
diff --git a/lib/PaymentMethod.php b/lib/PaymentMethod.php
index 817a50c5f..2e8167e55 100644
--- a/lib/PaymentMethod.php
+++ b/lib/PaymentMethod.php
@@ -5,20 +5,20 @@
/**
* Class PaymentMethod
*
- * @property string $id
- * @property string $object
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\StripeObject $au_becs_debit
* @property \Stripe\StripeObject $billing_details
* @property \Stripe\StripeObject $card
* @property \Stripe\StripeObject $card_present
- * @property int $created
- * @property string|\Stripe\Customer|null $customer
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|\Stripe\Customer|null $customer The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
* @property \Stripe\StripeObject $fpx
* @property \Stripe\StripeObject $ideal
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* @property \Stripe\StripeObject $sepa_debit
- * @property string $type
+ * @property string $type The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
*
* @package Stripe
*/
diff --git a/lib/Payout.php b/lib/Payout.php
index 5281068db..6054dab29 100644
--- a/lib/Payout.php
+++ b/lib/Payout.php
@@ -5,26 +5,26 @@
/**
* Class Payout
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $arrival_date
- * @property bool $automatic
- * @property string|\Stripe\BalanceTransaction|null $balance_transaction
- * @property int $created
- * @property string $currency
- * @property string|null $description
- * @property string|\Stripe\StripeObject|null $destination
- * @property string|\Stripe\BalanceTransaction|null $failure_balance_transaction
- * @property string|null $failure_code
- * @property string|null $failure_message
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string $method
- * @property string $source_type
- * @property string|null $statement_descriptor
- * @property string $status
- * @property string $type
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount (in %s) to be transferred to your bank account or debit card.
+ * @property int $arrival_date Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
+ * @property bool $automatic Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.
+ * @property string|\Stripe\BalanceTransaction|null $balance_transaction ID of the balance transaction that describes the impact of this payout on your account balance.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property string|\Stripe\StripeObject|null $destination ID of the bank account or card the payout was sent to.
+ * @property string|\Stripe\BalanceTransaction|null $failure_balance_transaction If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.
+ * @property string|null $failure_code Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.
+ * @property string|null $failure_message Message to user further explaining reason for payout failure if available.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $method The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
+ * @property string $source_type The source balance this payout came from. One of card or bank_account.
+ * @property string|null $statement_descriptor Extra information about a payout to be displayed on the user's bank statement.
+ * @property string $status Current status of the payout (paid, pending, in_transit, canceled or failed). A payout will be pending until it is submitted to the bank, at which point it becomes in_transit. It will then change to paid if the transaction goes through. If it does not go through successfully, its status will change to failed or canceled.
+ * @property string $type Can be bank_account or card.
*
* @package Stripe
*/
@@ -39,7 +39,8 @@ class Payout extends ApiResource
/**
* Types of payout failure codes.
- * @link https://stripe.com/docs/api#payout_failures
+ *
+ * @see https://stripe.com/docs/api#payout_failures
*/
const FAILURE_ACCOUNT_CLOSED = 'account_closed';
const FAILURE_ACCOUNT_FROZEN = 'account_frozen';
@@ -57,14 +58,16 @@ class Payout extends ApiResource
/**
* Possible string representations of the payout methods.
- * @link https://stripe.com/docs/api/payouts/object#payout_object-method
+ *
+ * @see https://stripe.com/docs/api/payouts/object#payout_object-method
*/
const METHOD_STANDARD = 'standard';
const METHOD_INSTANT = 'instant';
/**
* Possible string representations of the status of the payout.
- * @link https://stripe.com/docs/api/payouts/object#payout_object-status
+ *
+ * @see https://stripe.com/docs/api/payouts/object#payout_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_IN_TRANSIT = 'in_transit';
@@ -74,7 +77,8 @@ class Payout extends ApiResource
/**
* Possible string representations of the type of payout.
- * @link https://stripe.com/docs/api/payouts/object#payout_object-type
+ *
+ * @see https://stripe.com/docs/api/payouts/object#payout_object-type
*/
const TYPE_BANK_ACCOUNT = 'bank_account';
const TYPE_CARD = 'card';
diff --git a/lib/Person.php b/lib/Person.php
index c6c16cbaa..40339b3a3 100644
--- a/lib/Person.php
+++ b/lib/Person.php
@@ -42,14 +42,16 @@ class Person extends ApiResource
/**
* Possible string representations of a person's gender.
- * @link https://stripe.com/docs/api/persons/object#person_object-gender
+ *
+ * @see https://stripe.com/docs/api/persons/object#person_object-gender
*/
const GENDER_MALE = 'male';
const GENDER_FEMALE = 'female';
/**
* Possible string representations of a person's verification status.
- * @link https://stripe.com/docs/api/persons/object#person_object-verification-status
+ *
+ * @see https://stripe.com/docs/api/persons/object#person_object-verification-status
*/
const VERIFICATION_STATUS_PENDING = 'pending';
const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
diff --git a/lib/Plan.php b/lib/Plan.php
index ffaf87360..e559f64ae 100644
--- a/lib/Plan.php
+++ b/lib/Plan.php
@@ -5,26 +5,26 @@
/**
* Class Plan
*
- * @property string $id
- * @property string $object
- * @property bool $active
- * @property string|null $aggregate_usage
- * @property int|null $amount
- * @property string|null $amount_decimal
- * @property string|null $billing_scheme
- * @property int $created
- * @property string $currency
- * @property string $interval
- * @property int $interval_count
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string|null $nickname
- * @property string|\Stripe\Product|null $product
- * @property \Stripe\StripeObject[]|null $tiers
- * @property string|null $tiers_mode
- * @property \Stripe\StripeObject|null $transform_usage
- * @property int|null $trial_period_days
- * @property string $usage_type
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property bool $active Whether the plan is currently available for new subscriptions.
+ * @property string|null $aggregate_usage Specifies a usage aggregation strategy for plans of usage_type=metered. Allowed values are sum for summing up all usage during a period, last_during_period for picking the last usage record reported within a period, last_ever for picking the last usage record ever (across period bounds) or max which picks the usage record with the maximum reported usage during a period. Defaults to sum.
+ * @property int|null $amount The amount in %s to be charged on the interval specified.
+ * @property string|null $amount_decimal Same as amount, but contains a decimal value with at most 12 decimal places.
+ * @property string|null $billing_scheme Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in amount) will be charged per unit in quantity (for plans with usage_type=licensed), or per unit of total usage (for plans with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $interval One of day, week, month or year. The frequency with which a subscription should be billed.
+ * @property int $interval_count The number of intervals (specified in the interval property) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|null $nickname A brief description of the plan, hidden from customers.
+ * @property string|\Stripe\Product|null $product The product whose pricing this plan determines.
+ * @property \Stripe\StripeObject[]|null $tiers Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
+ * @property string|null $tiers_mode Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price, in graduated tiering pricing can successively change as the quantity grows.
+ * @property \Stripe\StripeObject|null $transform_usage Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers.
+ * @property int|null $trial_period_days Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
+ * @property string $usage_type Configures how the quantity per period should be determined, can be either metered or licensed. licensed will automatically bill the quantity set when adding it to a subscription, metered will aggregate the total usage based on usage records. Defaults to licensed.
*
* @package Stripe
*/
diff --git a/lib/Product.php b/lib/Product.php
index 3c75cc731..89fad8106 100644
--- a/lib/Product.php
+++ b/lib/Product.php
@@ -5,25 +5,25 @@
/**
* Class Product
*
- * @property string $id
- * @property string $object
- * @property bool $active
- * @property string[]|null $attributes
- * @property string|null $caption
- * @property int $created
- * @property string[] $deactivate_on
- * @property string|null $description
- * @property string[] $images
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string $name
- * @property \Stripe\StripeObject|null $package_dimensions
- * @property bool|null $shippable
- * @property string|null $statement_descriptor
- * @property string $type
- * @property string|null $unit_label
- * @property int $updated
- * @property string|null $url
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property bool $active Whether the product is currently available for purchase.
+ * @property string[]|null $attributes A list of up to 5 attributes that each SKU can provide values for (e.g., ["color", "size"]).
+ * @property string|null $caption A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of type=good.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string[] $deactivate_on An array of connect application identifiers that cannot purchase this product. Only applicable to products of type=good.
+ * @property string|null $description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+ * @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer. Only applicable to products of type=good.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $name The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
+ * @property \Stripe\StripeObject|null $package_dimensions The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own package_dimensions. Only applicable to products of type=good.
+ * @property bool|null $shippable Whether this product is a shipped good. Only applicable to products of type=good.
+ * @property string|null $statement_descriptor Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.
+ * @property string $type The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
+ * @property string|null $unit_label A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
+ * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
+ * @property string|null $url A URL of a publicly-accessible webpage for this product. Only applicable to products of type=good.
*
* @package Stripe
*/
@@ -39,7 +39,8 @@ class Product extends ApiResource
/**
* Possible string representations of the type of product.
- * @link https://stripe.com/docs/api/service_products/object#service_product_object-type
+ *
+ * @see https://stripe.com/docs/api/service_products/object#service_product_object-type
*/
const TYPE_GOOD = 'good';
const TYPE_SERVICE = 'service';
diff --git a/lib/Radar/EarlyFraudWarning.php b/lib/Radar/EarlyFraudWarning.php
index 92979d4be..d44793603 100644
--- a/lib/Radar/EarlyFraudWarning.php
+++ b/lib/Radar/EarlyFraudWarning.php
@@ -5,13 +5,13 @@
/**
* Class EarlyFraudWarning
*
- * @property string $id
- * @property string $object
- * @property bool $actionable
- * @property string|\Stripe\Charge $charge
- * @property int $created
- * @property string $fraud_type
- * @property bool $livemode
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property bool $actionable An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.
+ * @property string|\Stripe\Charge $charge ID of the charge this early fraud warning is for, optionally expanded.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $fraud_type The type of fraud labelled by the issuer. One of card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
*
* @package Stripe\Radar
*/
@@ -24,7 +24,8 @@ class EarlyFraudWarning extends \Stripe\ApiResource
/**
* Possible string representations of an early fraud warning's fraud type.
- * @link https://stripe.com/docs/api/early_fraud_warnings/object#early_fraud_warning_object-fraud_type
+ *
+ * @see https://stripe.com/docs/api/early_fraud_warnings/object#early_fraud_warning_object-fraud_type
*/
const FRAUD_TYPE_CARD_NEVER_RECEIVED = 'card_never_received';
const FRAUD_TYPE_FRAUDULENT_CARD_APPLICATION = 'fraudulent_card_application';
diff --git a/lib/Radar/ValueList.php b/lib/Radar/ValueList.php
index 772370f48..10731e953 100644
--- a/lib/Radar/ValueList.php
+++ b/lib/Radar/ValueList.php
@@ -5,16 +5,16 @@
/**
* Class ValueList
*
- * @property string $id
- * @property string $object
- * @property string $alias
- * @property int $created
- * @property string $created_by
- * @property string $item_type
- * @property \Stripe\Collection $list_items
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string $name
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string $alias The name of the value list for use in rules.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $created_by The name or email address of the user who created this value list.
+ * @property string $item_type The type of items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, or case_sensitive_string.
+ * @property \Stripe\Collection $list_items List of items contained within this value list.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $name The name of the value list.
*
* @package Stripe\Radar
*/
diff --git a/lib/Radar/ValueListItem.php b/lib/Radar/ValueListItem.php
index 5a79b71c9..9b9edb45c 100644
--- a/lib/Radar/ValueListItem.php
+++ b/lib/Radar/ValueListItem.php
@@ -5,13 +5,13 @@
/**
* Class ValueListItem
*
- * @property string $id
- * @property string $object
- * @property int $created
- * @property string $created_by
- * @property bool $livemode
- * @property string $value
- * @property string $value_list
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $created_by The name or email address of the user who added this item to the value list.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $value The value of the item.
+ * @property string $value_list The identifier of the value list this item belongs to.
*
* @package Stripe\Radar
*/
diff --git a/lib/Recipient.php b/lib/Recipient.php
index 0f788561a..cd5458f51 100644
--- a/lib/Recipient.php
+++ b/lib/Recipient.php
@@ -5,21 +5,21 @@
/**
* Class Recipient
*
- * @property string $id
- * @property string $object
- * @property \Stripe\BankAccount|null $active_account
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property \Stripe\BankAccount|null $active_account Hash describing the current account on the recipient, if there is one.
* @property \Stripe\Collection|null $cards
- * @property int $created
- * @property string|\Stripe\Card|null $default_card
- * @property string|null $description
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|\Stripe\Card|null $default_card The default card to use for creating transfers to this recipient.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
* @property string|null $email
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property string|\Stripe\Account|null $migrated_to
- * @property string|null $name
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|\Stripe\Account|null $migrated_to The ID of the Custom account this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.
+ * @property string|null $name Full, legal name of the recipient.
* @property string|\Stripe\Account $rolled_back_from
- * @property string $type
- * @property bool $verified
+ * @property string $type Type of the recipient, one of individual or corporation.
+ * @property bool $verified Whether the recipient has been verified. This field is non-standard, and maybe removed in the future
*
* @package Stripe
*/
diff --git a/lib/Refund.php b/lib/Refund.php
index 66300d97b..6b4822625 100644
--- a/lib/Refund.php
+++ b/lib/Refund.php
@@ -5,23 +5,23 @@
/**
* Class Refund
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property string|\Stripe\BalanceTransaction|null $balance_transaction
- * @property string|\Stripe\Charge|null $charge
- * @property int $created
- * @property string $currency
- * @property string $description
- * @property string|\Stripe\BalanceTransaction $failure_balance_transaction
- * @property string $failure_reason
- * @property \Stripe\StripeObject $metadata
- * @property string|\Stripe\PaymentIntent|null $payment_intent
- * @property string|null $reason
- * @property string|null $receipt_number
- * @property string|\Stripe\TransferReversal|null $source_transfer_reversal
- * @property string|null $status
- * @property string|\Stripe\TransferReversal|null $transfer_reversal
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount, in %s.
+ * @property string|\Stripe\BalanceTransaction|null $balance_transaction Balance transaction that describes the impact on your account balance.
+ * @property string|\Stripe\Charge|null $charge ID of the charge that was refunded.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)
+ * @property string|\Stripe\BalanceTransaction $failure_balance_transaction If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
+ * @property string $failure_reason If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string|\Stripe\PaymentIntent|null $payment_intent ID of the PaymentIntent that was refunded.
+ * @property string|null $reason Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
+ * @property string|null $receipt_number This is the transaction number that appears on email receipts sent for this refund.
+ * @property string|\Stripe\TransferReversal|null $source_transfer_reversal The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.
+ * @property string|null $status Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled. Refer to our refunds documentation for more details.
+ * @property string|\Stripe\TransferReversal|null $transfer_reversal If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.
*
* @package Stripe
*/
@@ -36,7 +36,8 @@ class Refund extends ApiResource
/**
* Possible string representations of the failure reason.
- * @link https://stripe.com/docs/api/refunds/object#refund_object-failure_reason
+ *
+ * @see https://stripe.com/docs/api/refunds/object#refund_object-failure_reason
*/
const FAILURE_REASON = 'expired_or_canceled_card';
const FAILURE_REASON_LOST_OR_STOLEN_CARD = 'lost_or_stolen_card';
@@ -44,7 +45,8 @@ class Refund extends ApiResource
/**
* Possible string representations of the refund reason.
- * @link https://stripe.com/docs/api/refunds/object#refund_object-reason
+ *
+ * @see https://stripe.com/docs/api/refunds/object#refund_object-reason
*/
const REASON_DUPLICATE = 'duplicate';
const REASON_FRAUDULENT = 'fraudulent';
@@ -52,7 +54,8 @@ class Refund extends ApiResource
/**
* Possible string representations of the refund status.
- * @link https://stripe.com/docs/api/refunds/object#refund_object-status
+ *
+ * @see https://stripe.com/docs/api/refunds/object#refund_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_FAILED = 'failed';
diff --git a/lib/Reporting/ReportRun.php b/lib/Reporting/ReportRun.php
index ba27f3a29..e7050a211 100644
--- a/lib/Reporting/ReportRun.php
+++ b/lib/Reporting/ReportRun.php
@@ -5,16 +5,16 @@
/**
* Class ReportRun
*
- * @property string $id
- * @property string $object
- * @property int $created
- * @property string|null $error
- * @property bool $livemode
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $error If something should go wrong during the run, a message about the failure (populated when
status=failed).
true: reports can only be run on live-mode data.
* @property \Stripe\StripeObject $parameters
- * @property string $report_type
- * @property \Stripe\File|null $result
- * @property string $status
- * @property int|null $succeeded_at
+ * @property string $report_type The ID of the report type to run, such as "balance.summary.1".
+ * @property \Stripe\File|null $result The file object representing the result of the report run (populated when
status=succeeded).
Status of this report run. This will be pending when the run is initially created.
When the run finishes, this will be set to succeeded and the result field will be populated.
Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.
Timestamp at which this run successfully finished (populated when
status=succeeded). Measured in seconds since the Unix epoch.
balance.summary.1.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $data_available_end Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
+ * @property int $data_available_start Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
+ * @property string[]|null $default_columns List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)
+ * @property string $name Human-readable name of the Report Type
+ * @property int $updated When this Report Type was latest updated. Measured in seconds since the Unix epoch.
+ * @property int $version Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
*
* @package Stripe\Reporting
*/
diff --git a/lib/RequestTelemetry.php b/lib/RequestTelemetry.php
index f677a7f76..1d01ae75c 100644
--- a/lib/RequestTelemetry.php
+++ b/lib/RequestTelemetry.php
@@ -6,6 +6,7 @@
* Class RequestTelemetry
*
* Tracks client request telemetry
+ *
* @package Stripe
*/
class RequestTelemetry
diff --git a/lib/Review.php b/lib/Review.php
index 86226c5e3..c44302116 100644
--- a/lib/Review.php
+++ b/lib/Review.php
@@ -5,20 +5,20 @@
/**
* Class Review
*
- * @property string $id
- * @property string $object
- * @property string|null $billing_zip
- * @property string|\Stripe\Charge|null $charge
- * @property string|null $closed_reason
- * @property int $created
- * @property string|null $ip_address
- * @property \Stripe\StripeObject|null $ip_address_location
- * @property bool $livemode
- * @property bool $open
- * @property string $opened_reason
- * @property string|\Stripe\PaymentIntent $payment_intent
- * @property string $reason
- * @property \Stripe\StripeObject|null $session
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|null $billing_zip The ZIP or postal code of the card used, if applicable.
+ * @property string|\Stripe\Charge|null $charge The charge associated with this review.
+ * @property string|null $closed_reason The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, or disputed.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $ip_address The IP address where the payment originated.
+ * @property \Stripe\StripeObject|null $ip_address_location Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property bool $open If true, the review needs action.
+ * @property string $opened_reason The reason the review was opened. One of rule or manual.
+ * @property string|\Stripe\PaymentIntent $payment_intent The PaymentIntent ID associated with this review, if one exists.
+ * @property string $reason The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, or disputed.
+ * @property \Stripe\StripeObject|null $session Information related to the browsing session of the user who initiated the payment.
*
* @package Stripe
*/
@@ -33,7 +33,8 @@ class Review extends ApiResource
* Possible string representations of the current, the opening or the closure reason of the review.
* Not all of these enumeration apply to all of the ´reason´ fields. Please consult the Review object to
* determine where these are apply.
- * @link https://stripe.com/docs/api/radar/reviews/object
+ *
+ * @see https://stripe.com/docs/api/radar/reviews/object
*/
const REASON_APPROVED = 'approved';
const REASON_DISPUTED = 'disputed';
diff --git a/lib/SKU.php b/lib/SKU.php
index b7b97715b..6bb068990 100644
--- a/lib/SKU.php
+++ b/lib/SKU.php
@@ -5,20 +5,20 @@
/**
* Class SKU
*
- * @property string $id
- * @property string $object
- * @property bool $active
- * @property \Stripe\StripeObject $attributes
- * @property int $created
- * @property string $currency
- * @property string|null $image
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property bool $active Whether the SKU is available for purchase.
+ * @property \Stripe\StripeObject $attributes A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are ["size", "gender"], a valid SKU has the following dictionary of attributes: {"size": "Medium", "gender": "Unisex"}.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|null $image The URL of an image for this SKU, meant to be displayable to the customer.
* @property \Stripe\StripeObject $inventory
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property \Stripe\StripeObject|null $package_dimensions
- * @property int $price
- * @property string|\Stripe\Product $product
- * @property int $updated
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property \Stripe\StripeObject|null $package_dimensions The dimensions of this SKU for shipping purposes.
+ * @property int $price The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
+ * @property string|\Stripe\Product $product The ID of the product this SKU is associated with. The product must be currently active.
+ * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
*
* @package Stripe
*/
diff --git a/lib/SetupIntent.php b/lib/SetupIntent.php
index b86319fc6..6c0719511 100644
--- a/lib/SetupIntent.php
+++ b/lib/SetupIntent.php
@@ -5,26 +5,26 @@
/**
* Class SetupIntent
*
- * @property string $id
- * @property string $object
- * @property string|\Stripe\StripeObject|null $application
- * @property string|null $cancellation_reason
- * @property string|null $client_secret
- * @property int $created
- * @property string|\Stripe\Customer|null $customer
- * @property string|null $description
- * @property \Stripe\ErrorObject|null $last_setup_error
- * @property bool $livemode
- * @property string|\Stripe\Mandate|null $mandate
- * @property \Stripe\StripeObject $metadata
- * @property \Stripe\StripeObject|null $next_action
- * @property string|\Stripe\Account|null $on_behalf_of
- * @property string|\Stripe\PaymentMethod|null $payment_method
- * @property \Stripe\StripeObject|null $payment_method_options
- * @property string[] $payment_method_types
- * @property string|\Stripe\Mandate|null $single_use_mandate
- * @property string $status
- * @property string $usage
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|\Stripe\StripeObject|null $application ID of the Connect application that created the SetupIntent.
+ * @property string|null $cancellation_reason Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
+ * @property string|null $client_secret The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property string|\Stripe\Customer|null $customerID of the Customer this SetupIntent belongs to, if one exists.
If present, payment methods used with this SetupIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this SetupIntent.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users. + * @property \Stripe\ErrorObject|null $last_setup_error The error encountered in the previous SetupIntent confirmation. + * @property bool $livemode Has the valuetrue if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|\Stripe\Mandate|null $mandate ID of the multi use Mandate generated by the SetupIntent.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property \Stripe\StripeObject|null $next_action If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
+ * @property string|\Stripe\Account|null $on_behalf_of The account (if any) for which the setup is intended.
+ * @property string|\Stripe\PaymentMethod|null $payment_method ID of the payment method used with this SetupIntent.
+ * @property \Stripe\StripeObject|null $payment_method_options Payment-method-specific configuration for this SetupIntent.
+ * @property string[] $payment_method_types The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
+ * @property string|\Stripe\Mandate|null $single_use_mandate ID of the single_use Mandate generated by the SetupIntent.
+ * @property string $status Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
+ * @property string $usage Indicates how the payment method is intended to be used in the future.
Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.
true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $result_available_until Time at which the result expires and is no longer available for download.
+ * @property string $sql SQL for the query.
+ * @property string $status The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.
+ * @property string $title Title of the query.
*
* @package Stripe\Sigma
*/
diff --git a/lib/Source.php b/lib/Source.php
index fca13d148..a7238f56c 100644
--- a/lib/Source.php
+++ b/lib/Source.php
@@ -5,31 +5,31 @@
/**
* Class Source
*
- * @property string $id
- * @property string $object
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\StripeObject $ach_credit_transfer
* @property \Stripe\StripeObject $ach_debit
* @property \Stripe\StripeObject $acss_debit
* @property \Stripe\StripeObject $alipay
- * @property int|null $amount
+ * @property int|null $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
* @property \Stripe\StripeObject $au_becs_debit
* @property \Stripe\StripeObject $bancontact
* @property \Stripe\StripeObject $card
* @property \Stripe\StripeObject $card_present
- * @property string $client_secret
+ * @property string $client_secret The client secret of the source. Used for client-side retrieval using a publishable key.
* @property \Stripe\StripeObject $code_verification
- * @property int $created
- * @property string|null $currency
- * @property string $customer
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $currency Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
+ * @property string $customer The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
* @property \Stripe\StripeObject $eps
- * @property string $flow
+ * @property string $flow The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
* @property \Stripe\StripeObject $giropay
* @property \Stripe\StripeObject $ideal
* @property \Stripe\StripeObject $klarna
- * @property bool $livemode
- * @property \Stripe\StripeObject|null $metadata
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject|null $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* @property \Stripe\StripeObject $multibanco
- * @property \Stripe\StripeObject|null $owner
+ * @property \Stripe\StripeObject|null $owner Information about the owner of the payment instrument that may be used or required by particular source types.
* @property \Stripe\StripeObject $p24
* @property \Stripe\StripeObject $receiver
* @property \Stripe\StripeObject $redirect
@@ -37,11 +37,11 @@
* @property \Stripe\StripeObject $sepa_debit
* @property \Stripe\StripeObject $sofort
* @property \Stripe\StripeObject $source_order
- * @property string|null $statement_descriptor
- * @property string $status
+ * @property string|null $statement_descriptor Extra information about a source. This will appear on your customer's statement every time you charge the source.
+ * @property string $status The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
* @property \Stripe\StripeObject $three_d_secure
- * @property string $type
- * @property string|null $usage
+ * @property string $type The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
+ * @property string|null $usage Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
* @property \Stripe\StripeObject $wechat
*
* @package Stripe
@@ -58,7 +58,8 @@ class Source extends ApiResource
/**
* Possible string representations of source flows.
- * @link https://stripe.com/docs/api#source_object-flow
+ *
+ * @see https://stripe.com/docs/api#source_object-flow
*/
const FLOW_REDIRECT = 'redirect';
const FLOW_RECEIVER = 'receiver';
@@ -67,7 +68,8 @@ class Source extends ApiResource
/**
* Possible string representations of source statuses.
- * @link https://stripe.com/docs/api#source_object-status
+ *
+ * @see https://stripe.com/docs/api#source_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_CHARGEABLE = 'chargeable';
@@ -77,7 +79,8 @@ class Source extends ApiResource
/**
* Possible string representations of source usage.
- * @link https://stripe.com/docs/api#source_object-usage
+ *
+ * @see https://stripe.com/docs/api#source_object-usage
*/
const USAGE_REUSABLE = 'reusable';
const USAGE_SINGLE_USE = 'single_use';
diff --git a/lib/Stripe.php b/lib/Stripe.php
index e142d9eb1..4872a8227 100644
--- a/lib/Stripe.php
+++ b/lib/Stripe.php
@@ -33,7 +33,7 @@ class Stripe
/** @var string Path to the CA bundle used to verify SSL certificates */
public static $caBundlePath = null;
- /** @var boolean Defaults to true. */
+ /** @var bool Defaults to true. */
public static $verifySslCerts = true;
/** @var array The application's information (name, version, URL) */
@@ -48,7 +48,7 @@ class Stripe
/** @var int Maximum number of request retries */
public static $maxNetworkRetries = 0;
- /** @var boolean Whether client telemetry is enabled. Defaults to true. */
+ /** @var bool Whether client telemetry is enabled. Defaults to true. */
public static $enableTelemetry = true;
/** @var float Maximum delay between retries, in seconds */
@@ -161,7 +161,7 @@ public static function setCABundlePath($caBundlePath)
}
/**
- * @return boolean
+ * @return bool
*/
public static function getVerifySslCerts()
{
@@ -169,7 +169,7 @@ public static function getVerifySslCerts()
}
/**
- * @param boolean $verify
+ * @param bool $verify
*/
public static function setVerifySslCerts($verify)
{
@@ -204,8 +204,9 @@ public static function getAppInfo()
/**
* @param string $appName The application's name
- * @param string $appVersion The application's version
- * @param string $appUrl The application's URL
+ * @param string|null $appVersion The application's version
+ * @param string|null $appUrl The application's URL
+ * @param string|null $appPartnerId The application's partner ID
*/
public static function setAppInfo($appName, $appVersion = null, $appUrl = null, $appPartnerId = null)
{
diff --git a/lib/StripeObject.php b/lib/StripeObject.php
index 5b69dfc39..6f73f5ed2 100644
--- a/lib/StripeObject.php
+++ b/lib/StripeObject.php
@@ -218,7 +218,7 @@ public function values()
* This unfortunately needs to be public to be used in Util\Util
*
* @param array $values
- * @param null|string|array|Util\RequestOptions $opts
+ * @param array|string|Util\RequestOptions|null $opts
*
* @return static The object constructed from the given values.
*/
@@ -233,8 +233,8 @@ public static function constructFrom($values, $opts = null)
* Refreshes this object using the provided values.
*
* @param array $values
- * @param null|string|array|Util\RequestOptions $opts
- * @param boolean $partial Defaults to false.
+ * @param array|string|Util\RequestOptions|null $opts
+ * @param bool $partial Defaults to false.
*/
public function refreshFrom($values, $opts, $partial = false)
{
@@ -270,8 +270,8 @@ public function refreshFrom($values, $opts, $partial = false)
* Mass assigns attributes on the model.
*
* @param array $values
- * @param null|string|array|Util\RequestOptions $opts
- * @param boolean $dirty Defaults to true.
+ * @param array|string|Util\RequestOptions|null $opts
+ * @param bool $dirty Defaults to true.
*/
public function updateAttributes($values, $opts = null, $dirty = true)
{
@@ -293,6 +293,8 @@ public function updateAttributes($values, $opts = null, $dirty = true)
}
/**
+ * @param bool $force Defaults to false.
+ *
* @return array A recursive mapping of attributes to values for this object,
* including the proper value for deleted attributes.
*/
@@ -479,6 +481,8 @@ protected function dirtyValue($value)
/**
* Produces a deep copy of the given object including support for arrays
* and StripeObjects.
+ *
+ * @param mixed $obj
*/
protected static function deepCopy($obj)
{
@@ -501,6 +505,8 @@ protected static function deepCopy($obj)
/**
* Returns a hash of empty values for all the values that are in the given
* StripeObject.
+ *
+ * @param mixed $obj
*/
public static function emptyValues($obj)
{
@@ -528,7 +534,6 @@ public function getLastResponse()
* Sets the last response from the Stripe API
*
* @param ApiResponse $resp
- * @return void
*/
public function setLastResponse($resp)
{
diff --git a/lib/Subscription.php b/lib/Subscription.php
index 5e9e28b05..44f2087d1 100644
--- a/lib/Subscription.php
+++ b/lib/Subscription.php
@@ -5,41 +5,41 @@
/**
* Class Subscription
*
- * @property string $id
- * @property string $object
- * @property float|null $application_fee_percent
- * @property int $billing_cycle_anchor
- * @property \Stripe\StripeObject|null $billing_thresholds
- * @property int|null $cancel_at
- * @property bool $cancel_at_period_end
- * @property int|null $canceled_at
- * @property string|null $collection_method
- * @property int $created
- * @property int $current_period_end
- * @property int $current_period_start
- * @property string|\Stripe\Customer $customer
- * @property int|null $days_until_due
- * @property string|\Stripe\PaymentMethod|null $default_payment_method
- * @property string|\Stripe\StripeObject|null $default_source
- * @property \Stripe\TaxRate[]|null $default_tax_rates
- * @property \Stripe\Discount|null $discount
- * @property int|null $ended_at
- * @property \Stripe\Collection $items
- * @property string|\Stripe\Invoice|null $latest_invoice
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property int|null $next_pending_invoice_item_invoice
- * @property \Stripe\StripeObject|null $pending_invoice_item_interval
- * @property string|\Stripe\SetupIntent|null $pending_setup_intent
- * @property \Stripe\StripeObject|null $pending_update
- * @property \Stripe\Plan|null $plan
- * @property int|null $quantity
- * @property string|\Stripe\SubscriptionSchedule|null $schedule
- * @property int $start_date
- * @property string $status
- * @property float|null $tax_percent
- * @property int|null $trial_end
- * @property int|null $trial_start
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property float|null $application_fee_percent A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.
+ * @property int $billing_cycle_anchor Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.
+ * @property \Stripe\StripeObject|null $billing_thresholds Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
+ * @property int|null $cancel_at A date in the future at which the subscription will automatically get canceled
+ * @property bool $cancel_at_period_end If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
+ * @property int|null $canceled_at If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
+ * @property string|null $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $current_period_end End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
+ * @property int $current_period_start Start of the current period that the subscription has been invoiced for.
+ * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription.
+ * @property int|null $days_until_due Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
+ * @property string|\Stripe\PaymentMethod|null $default_payment_method ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings.
+ * @property string|\Stripe\StripeObject|null $default_source ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If not set, defaults to the customer's default source.
+ * @property \Stripe\TaxRate[]|null $default_tax_rates The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
+ * @property \Stripe\Discount|null $discount Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
+ * @property int|null $ended_at If the subscription has ended, the date the subscription ended.
+ * @property \Stripe\Collection $items List of subscription items, each with an attached plan.
+ * @property string|\Stripe\Invoice|null $latest_invoice The most recent invoice this subscription has generated.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property int|null $next_pending_invoice_item_invoice Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
+ * @property \Stripe\StripeObject|null $pending_invoice_item_interval Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
+ * @property string|\Stripe\SetupIntent|null $pending_setup_intent You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
+ * @property \Stripe\StripeObject|null $pending_update If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
+ * @property \Stripe\Plan|null $plan Hash describing the plan the customer is subscribed to. Only set if the subscription contains a single plan.
+ * @property int|null $quantity The quantity of the plan to which the customer is subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly. Only set if the subscription contains a single plan.
+ * @property string|\Stripe\SubscriptionSchedule|null $schedule The schedule attached to the subscription
+ * @property int $start_date Date when the subscription was first created. The date might differ from the created date due to backdating.
+ * @property string $status Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.
For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal state, the open invoice will be voided and no further invoices will be generated.
A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.
If subscription collection_method=charge_automatically it becomes past_due when payment to renew it fails and canceled or unpaid (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.
If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
subscription this subscription_item belongs to.
+ * @property \Stripe\TaxRate[]|null $tax_rates The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item.
*
* @package Stripe
*/
diff --git a/lib/SubscriptionSchedule.php b/lib/SubscriptionSchedule.php
index b00836021..640354350 100644
--- a/lib/SubscriptionSchedule.php
+++ b/lib/SubscriptionSchedule.php
@@ -5,23 +5,23 @@
/**
* Class SubscriptionSchedule
*
- * @property string $id
- * @property string $object
- * @property int|null $canceled_at
- * @property int|null $completed_at
- * @property int $created
- * @property \Stripe\StripeObject|null $current_phase
- * @property string|\Stripe\Customer $customer
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int|null $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
+ * @property int|null $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property \Stripe\StripeObject|null $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
+ * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.
* @property \Stripe\StripeObject $default_settings
- * @property string $end_behavior
- * @property bool $livemode
- * @property \Stripe\StripeObject|null $metadata
- * @property \Stripe\StripeObject[] $phases
- * @property int|null $released_at
- * @property string|null $released_subscription
- * @property \Stripe\StripeObject|null $renewal_interval
- * @property string $status
- * @property string|\Stripe\Subscription|null $subscription
+ * @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject|null $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.
+ * @property int|null $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
+ * @property string|null $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).
+ * @property \Stripe\StripeObject|null $renewal_interval This field has been deprecated. Interval and duration at which the subscription schedule renews for when it ends if renewal_behavior is renew.
+ * @property string $status The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
+ * @property string|\Stripe\Subscription|null $subscription ID of the subscription managed by the subscription schedule.
*
* @package Stripe
*/
diff --git a/lib/TaxId.php b/lib/TaxId.php
index 1a5a0405f..821cea66d 100644
--- a/lib/TaxId.php
+++ b/lib/TaxId.php
@@ -25,7 +25,8 @@ class TaxId extends ApiResource
/**
* Possible string representations of a tax id's type.
- * @link https://stripe.com/docs/api/customer_tax_ids/object#tax_id_object-type
+ *
+ * @see https://stripe.com/docs/api/customer_tax_ids/object#tax_id_object-type
*/
const TYPE_AU_ABN = 'au_abn';
const TYPE_CA_BN = 'ca_bn';
@@ -46,7 +47,8 @@ class TaxId extends ApiResource
/**
* Possible string representations of the verification status.
- * @link https://stripe.com/docs/api/customer_tax_ids/object#tax_id_object-verification
+ *
+ * @see https://stripe.com/docs/api/customer_tax_ids/object#tax_id_object-verification
*/
const VERIFICATION_STATUS_PENDING = 'pending';
const VERIFICATION_STATUS_UNAVAILABLE = 'unavailable';
diff --git a/lib/TaxRate.php b/lib/TaxRate.php
index 88096e23a..5e582016f 100644
--- a/lib/TaxRate.php
+++ b/lib/TaxRate.php
@@ -5,17 +5,17 @@
/**
* Class TaxRate
*
- * @property string $id
- * @property string $object
- * @property bool $active
- * @property int $created
- * @property string|null $description
- * @property string $display_name
- * @property bool $inclusive
- * @property string|null $jurisdiction
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property float $percentage
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property bool $active Defaults to true. When set to false, this tax rate cannot be applied to objects in the API, but will still be applied to subscriptions and invoices that already have it set.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string|null $description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
+ * @property string $display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
+ * @property bool $inclusive This specifies if the tax rate is inclusive or exclusive.
+ * @property string|null $jurisdiction The jurisdiction for the tax rate.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property float $percentage This represents the tax rate percent out of 100.
*
* @package Stripe
*/
diff --git a/lib/Terminal/ConnectionToken.php b/lib/Terminal/ConnectionToken.php
index 676dec689..a36fd18de 100644
--- a/lib/Terminal/ConnectionToken.php
+++ b/lib/Terminal/ConnectionToken.php
@@ -5,9 +5,9 @@
/**
* Class ConnectionToken
*
- * @property string $object
- * @property string $location
- * @property string $secret
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string $location The id of the location that this connection token is scoped to.
+ * @property string $secret Your application should pass this token to the Stripe Terminal SDK.
*
* @package Stripe\Terminal
*/
diff --git a/lib/Terminal/Location.php b/lib/Terminal/Location.php
index 01230a03a..e8bc6d582 100644
--- a/lib/Terminal/Location.php
+++ b/lib/Terminal/Location.php
@@ -5,12 +5,12 @@
/**
* Class Location
*
- * @property string $id
- * @property string $object
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\StripeObject $address
- * @property string $display_name
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
+ * @property string $display_name The display name of the location.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*
* @package Stripe\Terminal
*/
diff --git a/lib/Terminal/Reader.php b/lib/Terminal/Reader.php
index a536c7a9e..9a11a13f1 100644
--- a/lib/Terminal/Reader.php
+++ b/lib/Terminal/Reader.php
@@ -5,17 +5,17 @@
/**
* Class Reader
*
- * @property string $id
- * @property string $object
- * @property string|null $device_sw_version
- * @property string $device_type
- * @property string|null $ip_address
- * @property string $label
- * @property bool $livemode
- * @property string|null $location
- * @property \Stripe\StripeObject $metadata
- * @property string $serial_number
- * @property string|null $status
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|null $device_sw_version The current software version of the reader.
+ * @property string $device_type Type of reader, one of bbpos_chipper2x or verifone_P400.
+ * @property string|null $ip_address The local IP address of the reader.
+ * @property string $label Custom label given to the reader for easier identification.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|null $location The location identifier of the reader.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property string $serial_number Serial number of the reader.
+ * @property string|null $status The networking status of the reader.
*
* @package Stripe\Terminal
*/
diff --git a/lib/ThreeDSecure.php b/lib/ThreeDSecure.php
index 3c1015784..3ba59176e 100644
--- a/lib/ThreeDSecure.php
+++ b/lib/ThreeDSecure.php
@@ -5,16 +5,16 @@
/**
* Class ThreeDSecure
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property bool $authenticated
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount of the charge that you will create when authentication completes.
+ * @property bool $authenticated True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.
* @property \Stripe\Card $card
- * @property int $created
- * @property string $currency
- * @property bool $livemode
- * @property string|null $redirect_url
- * @property string $status
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|null $redirect_url If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback".
+ * @property string $status Possible values are redirect_pending, succeeded, or failed. When the cardholder can be authenticated, the object starts with status redirect_pending. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status succeeded. failed indicates that authentication was attempted unsuccessfully.
*
* @package Stripe
*/
diff --git a/lib/Token.php b/lib/Token.php
index d608574b2..c9a850882 100644
--- a/lib/Token.php
+++ b/lib/Token.php
@@ -5,15 +5,15 @@
/**
* Class Token
*
- * @property string $id
- * @property string $object
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\BankAccount $bank_account
* @property \Stripe\Card $card
- * @property string|null $client_ip
- * @property int $created
- * @property bool $livemode
- * @property string $type
- * @property bool $used
+ * @property string|null $client_ip IP address of the client that generated the token.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $type Type of the token: account, bank_account, card, or pii.
+ * @property bool $used Whether this token has already been used (tokens can be used only once).
*
* @package Stripe
*/
@@ -26,7 +26,8 @@ class Token extends ApiResource
/**
* Possible string representations of the token type.
- * @link https://stripe.com/docs/api/tokens/object#token_object-type
+ *
+ * @see https://stripe.com/docs/api/tokens/object#token_object-type
*/
const TYPE_ACCOUNT = 'account';
const TYPE_BANK_ACCOUNT = 'bank_account';
diff --git a/lib/Topup.php b/lib/Topup.php
index d479e3c99..5cd92e78b 100644
--- a/lib/Topup.php
+++ b/lib/Topup.php
@@ -5,22 +5,22 @@
/**
* Class Topup
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property string|\Stripe\BalanceTransaction|null $balance_transaction
- * @property int $created
- * @property string $currency
- * @property string|null $description
- * @property int|null $expected_availability_date
- * @property string|null $failure_code
- * @property string|null $failure_message
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount transferred.
+ * @property string|\Stripe\BalanceTransaction|null $balance_transaction ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property int|null $expected_availability_date Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
+ * @property string|null $failure_code Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
+ * @property string|null $failure_message Message to user further explaining reason for top-up failure if available.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* @property \Stripe\Source $source
- * @property string|null $statement_descriptor
- * @property string $status
- * @property string|null $transfer_group
+ * @property string|null $statement_descriptor Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
+ * @property string $status The status of the top-up is either canceled, failed, pending, reversed, or succeeded.
+ * @property string|null $transfer_group A string that identifies this top-up as part of a group.
*
* @package Stripe
*/
@@ -35,7 +35,8 @@ class Topup extends ApiResource
/**
* Possible string representations of the status of the top-up.
- * @link https://stripe.com/docs/api/topups/object#topup_object-status
+ *
+ * @see https://stripe.com/docs/api/topups/object#topup_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_FAILED = 'failed';
diff --git a/lib/Transfer.php b/lib/Transfer.php
index ab25486d2..98b4728a7 100644
--- a/lib/Transfer.php
+++ b/lib/Transfer.php
@@ -5,23 +5,23 @@
/**
* Class Transfer
*
- * @property string $id
- * @property string $object
- * @property int $amount
- * @property int $amount_reversed
- * @property string|\Stripe\BalanceTransaction|null $balance_transaction
- * @property int $created
- * @property string $currency
- * @property string|null $description
- * @property string|\Stripe\Account|null $destination
- * @property string|\Stripe\Charge $destination_payment
- * @property bool $livemode
- * @property \Stripe\StripeObject $metadata
- * @property \Stripe\Collection $reversals
- * @property bool $reversed
- * @property string|\Stripe\Charge|null $source_transaction
- * @property string|null $source_type
- * @property string|null $transfer_group
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $amount Amount in %s to be transferred.
+ * @property int $amount_reversed Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
+ * @property string|\Stripe\BalanceTransaction|null $balance_transaction Balance transaction that describes the impact of this transfer on your account balance.
+ * @property int $created Time that this record of the transfer was first created.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|null $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property string|\Stripe\Account|null $destination ID of the Stripe account the transfer was sent to.
+ * @property string|\Stripe\Charge $destination_payment If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+ * @property \Stripe\Collection $reversals A list of reversals that have been applied to the transfer.
+ * @property bool $reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
+ * @property string|\Stripe\Charge|null $source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.
+ * @property string|null $source_type The source balance this transfer came from. One of card or bank_account.
+ * @property string|null $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details.
*
* @package Stripe
*/
@@ -37,7 +37,8 @@ class Transfer extends ApiResource
/**
* Possible string representations of the source type of the transfer.
- * @link https://stripe.com/docs/api/transfers/object#transfer_object-source_type
+ *
+ * @see https://stripe.com/docs/api/transfers/object#transfer_object-source_type
*/
const SOURCE_TYPE_ALIPAY_ACCOUNT = 'alipay_account';
const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account';
diff --git a/lib/Util/LoggerInterface.php b/lib/Util/LoggerInterface.php
index cf04e1d2b..f61629dc9 100644
--- a/lib/Util/LoggerInterface.php
+++ b/lib/Util/LoggerInterface.php
@@ -30,7 +30,6 @@ interface LoggerInterface
*
* @param string $message
* @param array $context
- * @return void
*/
public function error($message, array $context = []);
}
diff --git a/lib/Util/RandomGenerator.php b/lib/Util/RandomGenerator.php
index 0709f65c0..490377fb4 100644
--- a/lib/Util/RandomGenerator.php
+++ b/lib/Util/RandomGenerator.php
@@ -12,6 +12,7 @@ class RandomGenerator
* Returns a random value between 0 and $max.
*
* @param float $max (optional)
+ *
* @return float
*/
public function randFloat($max = 1.0)
diff --git a/lib/Util/RequestOptions.php b/lib/Util/RequestOptions.php
index 0442e35b5..242eaf328 100644
--- a/lib/Util/RequestOptions.php
+++ b/lib/Util/RequestOptions.php
@@ -37,6 +37,7 @@ public function __debugInfo()
/**
* Unpacks an options array and merges it into the existing RequestOptions
* object.
+ *
* @param array|string|null $options a key => value array
*
* @return RequestOptions
@@ -68,6 +69,7 @@ public function discardNonPersistentHeaders()
/**
* Unpacks an options array into an RequestOptions object
+ *
* @param array|string|null $options a key => value array
*
* @return RequestOptions
diff --git a/lib/Util/Util.php b/lib/Util/Util.php
index 14a3d70d6..7f3b279a5 100644
--- a/lib/Util/Util.php
+++ b/lib/Util/Util.php
@@ -15,7 +15,8 @@ abstract class Util
* integers starting at 0. Empty arrays are considered to be lists.
*
* @param array|mixed $array
- * @return boolean true if the given object is a list.
+ *
+ * @return bool true if the given object is a list.
*/
public static function isList($array)
{
@@ -36,7 +37,8 @@ public static function isList($array)
*
* @param array $resp The response from the Stripe API.
* @param array $opts
- * @return StripeObject|array
+ *
+ * @return array|StripeObject
*/
public static function convertToStripeObject($resp, $opts)
{
@@ -144,9 +146,9 @@ public static function convertToStripeObject($resp, $opts)
}
/**
- * @param string|mixed $value A string to UTF8-encode.
+ * @param mixed|string $value A string to UTF8-encode.
*
- * @return string|mixed The UTF8-encoded string, or the object passed in if
+ * @return mixed|string The UTF8-encoded string, or the object passed in if
* it wasn't a string.
*/
public static function utf8($value)
@@ -174,6 +176,7 @@ public static function utf8($value)
*
* @param string $a one of the strings to compare.
* @param string $b the other string to compare.
+ *
* @return bool true if the strings are equal, false otherwise.
*/
public static function secureCompare($a, $b)
@@ -202,6 +205,7 @@ public static function secureCompare($a, $b)
* Also clears out null values.
*
* @param mixed $h
+ *
* @return mixed
*/
public static function objectsToIds($h)
@@ -324,7 +328,7 @@ public static function normalizeId($id)
/**
* Returns UNIX timestamp in milliseconds
*
- * @return integer current time in millis
+ * @return int current time in millis
*/
public static function currentTimeMillis()
{
diff --git a/lib/Webhook.php b/lib/Webhook.php
index 84bde71a1..5130fed47 100644
--- a/lib/Webhook.php
+++ b/lib/Webhook.php
@@ -18,9 +18,11 @@ abstract class Webhook
* @param string $secret secret used to generate the signature.
* @param int $tolerance maximum difference allowed between the header's
* timestamp and the current time
- * @return Event the Event instance
+ *
* @throws Exception\UnexpectedValueException if the payload is not valid JSON,
* @throws Exception\SignatureVerificationException if the verification fails.
+ *
+ * @return Event the Event instance
*/
public static function constructEvent($payload, $sigHeader, $secret, $tolerance = self::DEFAULT_TOLERANCE)
{
diff --git a/lib/WebhookEndpoint.php b/lib/WebhookEndpoint.php
index f83ef9453..3adfa16b6 100644
--- a/lib/WebhookEndpoint.php
+++ b/lib/WebhookEndpoint.php
@@ -5,16 +5,16 @@
/**
* Class WebhookEndpoint
*
- * @property string $id
- * @property string $object
- * @property string|null $api_version
- * @property string|null $application
- * @property int $created
- * @property string[] $enabled_events
- * @property bool $livemode
- * @property string $secret
- * @property string $status
- * @property string $url
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|null $api_version The API version events are rendered as for this webhook endpoint.
+ * @property string|null $application The ID of the associated Connect application.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string[] $enabled_events The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $secret The endpoint's secret, used to generate webhook signatures. Only returned at creation.
+ * @property string $status The status of the webhook. It can be enabled or disabled.
+ * @property string $url The URL of the webhook endpoint.
*
* @package Stripe
*/
diff --git a/lib/WebhookSignature.php b/lib/WebhookSignature.php
index 95afa0776..ba0859b5c 100644
--- a/lib/WebhookSignature.php
+++ b/lib/WebhookSignature.php
@@ -17,7 +17,9 @@ abstract class WebhookSignature
* @param string $secret secret used to generate the signature.
* @param int $tolerance maximum difference allowed between the header's
* timestamp and the current time
+ *
* @throws Exception\SignatureVerificationException if the verification fails.
+ *
* @return bool
*/
public static function verifyHeader($payload, $header, $secret, $tolerance = null)
@@ -75,6 +77,7 @@ public static function verifyHeader($payload, $header, $secret, $tolerance = nul
* Extracts the timestamp in a signature header.
*
* @param string $header the signature header
+ *
* @return int the timestamp contained in the header, or -1 if no valid
* timestamp is found
*/
@@ -100,6 +103,7 @@ private static function getTimestamp($header)
*
* @param string $header the signature header
* @param string $scheme the signature scheme to look for.
+ *
* @return array the list of signatures matching the provided scheme.
*/
private static function getSignatures($header, $scheme)
@@ -124,6 +128,7 @@ private static function getSignatures($header, $scheme)
*
* @param string $payload the payload to sign.
* @param string $secret the secret used to generate the signature.
+ *
* @return string the signature as a string.
*/
private static function computeSignature($payload, $secret)
diff --git a/tests/Stripe/HttpClient/CurlClientTest.php b/tests/Stripe/HttpClient/CurlClientTest.php
index bb14e2e6d..ac456c62d 100644
--- a/tests/Stripe/HttpClient/CurlClientTest.php
+++ b/tests/Stripe/HttpClient/CurlClientTest.php
@@ -10,13 +10,13 @@ class CurlClientTest extends \Stripe\TestCase
/** @var \ReflectionProperty */
private $maxNetworkRetryDelayProperty;
- /** @var double */
+ /** @var float */
private $origInitialNetworkRetryDelay;
/** @var int */
private $origMaxNetworkRetries;
- /** @var double */
+ /** @var float */
private $origMaxNetworkRetryDelay;
/** @var \ReflectionMethod */
diff --git a/tests/TestCase.php b/tests/TestCase.php
index b0ea1d133..983d7d963 100644
--- a/tests/TestCase.php
+++ b/tests/TestCase.php
@@ -105,7 +105,7 @@ function ($method, $absUrl, $headers, $params, $hasFile) {
* @param bool $hasFile Whether the request parameters contains a file.
* Defaults to false.
* @param array $response
- * @param integer $rcode
+ * @param int $rcode
* @param string|null $base
*
* @return array