diff --git a/lib/Checkout/Session.php b/lib/Checkout/Session.php index 371ec14a5..1a4e6fd78 100644 --- a/lib/Checkout/Session.php +++ b/lib/Checkout/Session.php @@ -5,24 +5,24 @@ /** * Class Session * - * @property string $id

Unique identifier for the object. Used to pass to redirectToCheckout

in Stripe.js.

+ * @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_collection

The value (auto or required) for whether Checkout collected the

customer's billing address.

+ * @property string|null $billing_address_collection The 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_id

A 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 $customer

The 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_email

If 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.

+ * @property string|null $client_reference_id A 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 $customer The 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_email If 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. * @property \Stripe\StripeObject[]|null $display_items The line items, plans, or SKUs purchased by the customer. * @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 $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[] $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 in setup 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.

+ * @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. * @property string|\Stripe\Subscription|null $subscription The ID of the subscription for Checkout Sessions in subscription mode. - * @property string $success_url

The URL the customer will be directed to after the payment or

subscription creation is successful.

+ * @property string $success_url The URL the customer will be directed to after the payment or subscription creation is successful. * * @package Stripe\Checkout */ diff --git a/lib/Payout.php b/lib/Payout.php index 6054dab29..160ee0119 100644 --- a/lib/Payout.php +++ b/lib/Payout.php @@ -21,7 +21,7 @@ * @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 $source_type The source balance this payout came from. One of card, fpx, 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. diff --git a/lib/Plan.php b/lib/Plan.php index e559f64ae..4c15260b3 100644 --- a/lib/Plan.php +++ b/lib/Plan.php @@ -8,23 +8,23 @@ * @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 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 using the last usage record reported within a period, last_ever for using the last usage record ever (across period bounds) or max which uses 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 string $interval The frequency at which a subscription is billed. One of day, week, month or year. + * @property int $interval_count The number of intervals (specified in the interval attribute) 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 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 change as the quantity grows. + * @property \Stripe\StripeObject|null $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. 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. + * @property string $usage_type Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. * * @package Stripe */ diff --git a/lib/Reporting/ReportRun.php b/lib/Reporting/ReportRun.php index e7050a211..66c0e9a17 100644 --- a/lib/Reporting/ReportRun.php +++ b/lib/Reporting/ReportRun.php @@ -8,13 +8,13 @@ * @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).

+ * @property string|null $error If something should go wrong during the run, a message about the failure (populated when status=failed). * @property bool $livemode Always true: reports can only be run on live-mode data. * @property \Stripe\StripeObject $parameters * @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).

- * @property string $status

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.

- * @property int|null $succeeded_at

Timestamp at which this run successfully finished (populated when

status=succeeded). Measured in seconds since the Unix epoch.

+ * @property \Stripe\File|null $result The file object representing the result of the report run (populated when status=succeeded). + * @property string $status 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. + * @property int|null $succeeded_at Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch. * * @package Stripe\Reporting */ diff --git a/lib/Transfer.php b/lib/Transfer.php index 98b4728a7..71842b798 100644 --- a/lib/Transfer.php +++ b/lib/Transfer.php @@ -20,7 +20,7 @@ * @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 $source_type The source balance this transfer came from. One of card, fpx, 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