From fd3aef7766dca7dc7c5ee7a6c2796c5b43be1739 Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Thu, 3 Aug 2023 12:45:55 -0700 Subject: [PATCH 01/10] Update generated code for v446 (#1544) Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- OPENAPI_VERSION | 2 +- lib/ApplicationFee.php | 4 ++-- lib/ApplicationFeeRefund.php | 2 +- lib/BalanceTransaction.php | 8 ++++---- lib/Charge.php | 4 ++-- lib/Coupon.php | 2 +- lib/CreditNote.php | 12 ++++++------ lib/CreditNoteLineItem.php | 8 ++++---- lib/Invoice.php | 10 +++++----- lib/InvoiceLineItem.php | 6 +++--- lib/Payout.php | 2 +- lib/Plan.php | 4 ++-- lib/Price.php | 4 ++-- lib/Refund.php | 2 +- lib/Transfer.php | 4 ++-- lib/TransferReversal.php | 2 +- 16 files changed, 38 insertions(+), 38 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 6f0a9aab6..dae9a81fb 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v440 \ No newline at end of file +v446 \ No newline at end of file diff --git a/lib/ApplicationFee.php b/lib/ApplicationFee.php index a03956a22..1ffc0987d 100644 --- a/lib/ApplicationFee.php +++ b/lib/ApplicationFee.php @@ -8,8 +8,8 @@ * @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 int $amount Amount earned, in cents (or local equivalent). + * @property int $amount_refunded Amount in cents (or local equivalent) 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 null|string|\Stripe\BalanceTransaction $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. diff --git a/lib/ApplicationFeeRefund.php b/lib/ApplicationFeeRefund.php index b4fe9b15d..1d383c014 100644 --- a/lib/ApplicationFeeRefund.php +++ b/lib/ApplicationFeeRefund.php @@ -13,7 +13,7 @@ * * @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 int $amount Amount, in cents (or local equivalent). * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact 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. diff --git a/lib/BalanceTransaction.php b/lib/BalanceTransaction.php index 551872b52..3980138fa 100644 --- a/lib/BalanceTransaction.php +++ b/lib/BalanceTransaction.php @@ -12,15 +12,15 @@ * * @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 $amount Gross amount of the transaction, in cents (or local equivalent). * @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 null|string $description An arbitrary string attached to the object. Often useful for displaying to users. * @property null|float $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 int $fee Fees (in cents (or local equivalent)) paid for this transaction. + * @property \Stripe\StripeObject[] $fee_details Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. + * @property int $net Net amount of the transaction, in cents (or local equivalent). * @property string $reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective. * @property null|string|\Stripe\StripeObject $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. diff --git a/lib/Charge.php b/lib/Charge.php index 9fdcf74cc..8100255c4 100644 --- a/lib/Charge.php +++ b/lib/Charge.php @@ -14,8 +14,8 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property null|\Stripe\StripeObject $alternate_statement_descriptors * @property int $amount Amount intended to be collected by this payment. 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_captured Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). - * @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 int $amount_captured Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). + * @property int $amount_refunded Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). * @property null|string|\Stripe\StripeObject $application ID of the Connect application that created the charge. * @property null|string|\Stripe\ApplicationFee $application_fee The application fee (if any) for the charge. See the Connect documentation for details. * @property null|int $application_fee_amount The amount of the application fee (if any) requested for the charge. See the Connect documentation for details. diff --git a/lib/Coupon.php b/lib/Coupon.php index 45ae25f34..4e2348d07 100644 --- a/lib/Coupon.php +++ b/lib/Coupon.php @@ -22,7 +22,7 @@ * @property null|int $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. * @property null|\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 null|string $name Name of the coupon displayed to customers on for instance invoices or receipts. - * @property null|float $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 null|float $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 $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. * @property null|int $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. diff --git a/lib/CreditNote.php b/lib/CreditNote.php index fbed84143..9edb4048b 100644 --- a/lib/CreditNote.php +++ b/lib/CreditNote.php @@ -11,13 +11,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 $amount The integer amount in %s representing the total amount of the credit note, including tax. + * @property int $amount The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax. * @property int $amount_shipping This is the sum of all the shipping amounts. * @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 null|string|\Stripe\CustomerBalanceTransaction $customer_balance_transaction Customer balance transaction related to this credit note. - * @property int $discount_amount The integer amount in %s representing the total amount of discount that was credited. + * @property int $discount_amount The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. * @property \Stripe\StripeObject[] $discount_amounts The aggregate amounts calculated per discount for all line items. * @property null|int $effective_at The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. * @property string|\Stripe\Invoice $invoice ID of the invoice. @@ -32,11 +32,11 @@ * @property null|string|\Stripe\Refund $refund Refund related to this credit note. * @property null|\Stripe\StripeObject $shipping_cost The details of the cost of shipping, including the ShippingRate applied to the invoice. * @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 exclusive tax and invoice level discounts. - * @property null|int $subtotal_excluding_tax The integer amount in %s representing the amount of the credit note, excluding all tax and invoice level discounts. + * @property int $subtotal The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. + * @property null|int $subtotal_excluding_tax The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. * @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 all discount. - * @property null|int $total_excluding_tax The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts. + * @property int $total The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. + * @property null|int $total_excluding_tax The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. * @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 null|int $voided_at The time that the credit note was voided. */ diff --git a/lib/CreditNoteLineItem.php b/lib/CreditNoteLineItem.php index 30eb8e763..31b90d5b3 100644 --- a/lib/CreditNoteLineItem.php +++ b/lib/CreditNoteLineItem.php @@ -7,10 +7,10 @@ /** * @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 gross amount being credited for this line item, excluding (exclusive) tax and discounts. - * @property null|int $amount_excluding_tax The integer amount in %s representing the amount being credited for this line item, excluding all tax and discounts. + * @property int $amount The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. + * @property null|int $amount_excluding_tax The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. * @property null|string $description Description of the item being credited. - * @property int $discount_amount The integer amount in %s representing the discount being credited for this line item. + * @property int $discount_amount The integer amount in cents (or local equivalent) representing the discount being credited for this line item. * @property \Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item * @property null|string $invoice_line_item ID of the invoice line item being credited * @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. @@ -20,7 +20,7 @@ * @property string $type The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice. * @property null|int $unit_amount The cost of each unit of product being credited. * @property null|string $unit_amount_decimal Same as unit_amount, but contains a decimal value with at most 12 decimal places. - * @property null|string $unit_amount_excluding_tax The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts. + * @property null|string $unit_amount_excluding_tax The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. */ class CreditNoteLineItem extends ApiResource { diff --git a/lib/Invoice.php b/lib/Invoice.php index 3d16ab23d..e9511b69a 100644 --- a/lib/Invoice.php +++ b/lib/Invoice.php @@ -44,11 +44,11 @@ * @property null|string $account_name The public name of the business associated with this invoice, most often the business creating the invoice. * @property null|(string|\Stripe\TaxId)[] $account_tax_ids The account tax IDs associated with the invoice. Only editable when the invoice is a draft. * @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 difference between amount_due and amount_paid, in %s. + * @property int $amount_paid The amount, in cents (or local equivalent), that was paid. + * @property int $amount_remaining The difference between amount_due and amount_paid, in cents (or local equivalent). * @property int $amount_shipping This is the sum of all the shipping amounts. * @property null|string|\Stripe\StripeObject $application ID of the Connect Application that created the invoice. - * @property null|int $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 null|int $application_fee_amount The fee in cents (or local equivalent) 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 null|bool $auto_advance Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action. @@ -109,13 +109,13 @@ * @property null|\Stripe\StripeObject $subscription_details Details about the subscription that created this invoice. * @property null|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 invoice level discount or exclusive tax is applied. Item discounts are already incorporated - * @property null|int $subtotal_excluding_tax The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated + * @property null|int $subtotal_excluding_tax The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated * @property null|int $tax The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice belongs to. * @property null|\Stripe\StripeObject $threshold_reason * @property int $total Total after discounts and taxes. * @property null|\Stripe\StripeObject[] $total_discount_amounts The aggregate amounts calculated per discount across all line items. - * @property null|int $total_excluding_tax The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax. + * @property null|int $total_excluding_tax The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. * @property \Stripe\StripeObject[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items. * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. * @property null|int $webhooks_delivered_at Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. diff --git a/lib/InvoiceLineItem.php b/lib/InvoiceLineItem.php index 411712190..3cc8a7de7 100644 --- a/lib/InvoiceLineItem.php +++ b/lib/InvoiceLineItem.php @@ -7,8 +7,8 @@ /** * @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, in %s. - * @property null|int $amount_excluding_tax The integer amount in %s representing the amount for this line item, excluding all tax and discounts. + * @property int $amount The amount, in cents (or local equivalent). + * @property null|int $amount_excluding_tax The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. * @property null|\Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item. @@ -28,7 +28,7 @@ * @property null|\Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item. * @property string $type A string identifying the type of the source of this line item, either an invoiceitem or a subscription. - * @property null|string $unit_amount_excluding_tax The amount in %s representing the unit amount for this line item, excluding all tax and discounts. + * @property null|string $unit_amount_excluding_tax The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. */ class InvoiceLineItem extends ApiResource { diff --git a/lib/Payout.php b/lib/Payout.php index f34263752..5dd927146 100644 --- a/lib/Payout.php +++ b/lib/Payout.php @@ -16,7 +16,7 @@ * * @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 $amount Amount (in cents (or local equivalent)) 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 null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this payout on your account balance. diff --git a/lib/Plan.php b/lib/Plan.php index 148138b4e..b0ed6c3f1 100644 --- a/lib/Plan.php +++ b/lib/Plan.php @@ -18,8 +18,8 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property bool $active Whether the plan can be used for new purchases. * @property null|string $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 null|int $amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. - * @property null|string $amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit. + * @property null|int $amount The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. + * @property null|string $amount_decimal The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit. * @property string $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. diff --git a/lib/Price.php b/lib/Price.php index 2cb28f132..32ef4bcf3 100644 --- a/lib/Price.php +++ b/lib/Price.php @@ -31,8 +31,8 @@ * @property null|string $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 null|\Stripe\StripeObject $transform_quantity Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers. * @property string $type One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. - * @property null|int $unit_amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. - * @property null|string $unit_amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit. + * @property null|int $unit_amount The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. + * @property null|string $unit_amount_decimal The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit. */ class Price extends ApiResource { diff --git a/lib/Refund.php b/lib/Refund.php index 5042d0081..caf29175b 100644 --- a/lib/Refund.php +++ b/lib/Refund.php @@ -13,7 +13,7 @@ * * @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 int $amount Amount, in cents (or local equivalent). * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance. * @property null|string|\Stripe\Charge $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. diff --git a/lib/Transfer.php b/lib/Transfer.php index 6682e9e21..cf0206238 100644 --- a/lib/Transfer.php +++ b/lib/Transfer.php @@ -18,8 +18,8 @@ * * @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 int $amount Amount in cents (or local equivalent) to be transferred. + * @property int $amount_reversed Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). * @property null|string|\Stripe\BalanceTransaction $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. diff --git a/lib/TransferReversal.php b/lib/TransferReversal.php index cb0a9e0c6..f48c68f68 100644 --- a/lib/TransferReversal.php +++ b/lib/TransferReversal.php @@ -21,7 +21,7 @@ * * @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 int $amount Amount, in cents (or local equivalent). * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact 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. From 6be8827ee0d6466bf48e2b6997a8feac596405f9 Mon Sep 17 00:00:00 2001 From: Annie Li Date: Thu, 3 Aug 2023 13:01:03 -0700 Subject: [PATCH 02/10] Bump version to 10.20.0 --- CHANGELOG.md | 14 ++++++++++---- VERSION | 2 +- lib/Stripe.php | 2 +- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ca7ed565..198aa3926 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## 10.20.0 - 2023-08-03 +* [#1544](https://github.com/stripe/stripe-php/pull/1544) Update generated code +* [#1539](https://github.com/stripe/stripe-php/pull/1539) Update generated code + * Add support for `subscription_details` on `Invoice` + * Add support for new values `sepa_debit_fingerprint` and `us_bank_account_fingerprint` on enum `Radar.ValueList.item_type` + ## 10.19.0 - 2023-07-27 * [#1534](https://github.com/stripe/stripe-php/pull/1534) Update generated code * Improve PHPDoc type for `ApplicationFee.refunds` @@ -17,10 +23,10 @@ ## 10.17.0 - 2023-07-13 * [#1525](https://github.com/stripe/stripe-php/pull/1525) Update generated code - * Add support for new resource `Tax.Settings` - * Add support for `retrieve` and `update` methods on resource `Settings` - * Add support for new value `invalid_tax_location` on enum `StripeError.code` - * Add support for `product` on `Tax.TransactionLineItem` + * Add support for new resource `Tax.Settings` + * Add support for `retrieve` and `update` methods on resource `Settings` + * Add support for new value `invalid_tax_location` on enum `StripeError.code` + * Add support for `product` on `Tax.TransactionLineItem` * Add constant for `tax.settings.updated` webhook event * [#1520](https://github.com/stripe/stripe-php/pull/1520) Update generated code * Release specs are identical. diff --git a/VERSION b/VERSION index 5b7269c0a..ea4ccb283 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -10.19.0 +10.20.0 diff --git a/lib/Stripe.php b/lib/Stripe.php index e7dc8ffbd..e56890b23 100644 --- a/lib/Stripe.php +++ b/lib/Stripe.php @@ -58,7 +58,7 @@ class Stripe /** @var float Initial delay between retries, in seconds */ private static $initialNetworkRetryDelay = 0.5; - const VERSION = '10.19.0'; + const VERSION = '10.20.0'; /** * @return string the API key used for requests From 0b9bc4ae945999dd5d7a6f407c17809b682e9293 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Mon, 7 Aug 2023 14:51:41 +0000 Subject: [PATCH 03/10] Update generated code for v450 --- OPENAPI_VERSION | 2 +- lib/TaxRate.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index e0f8781c8..b46614ccd 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v449 \ No newline at end of file +v450 \ No newline at end of file diff --git a/lib/TaxRate.php b/lib/TaxRate.php index c0bc90262..b210270de 100644 --- a/lib/TaxRate.php +++ b/lib/TaxRate.php @@ -16,7 +16,7 @@ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $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 null|float $effective_percentage Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage does not include the statutory tax rate of non-taxable jurisdictions. + * @property null|float $effective_percentage Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. * @property bool $inclusive This specifies if the tax rate is inclusive or exclusive. * @property null|string $jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. * @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. From 7640497a6266313adbb173feed35c0744ba13a99 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Mon, 7 Aug 2023 17:19:01 +0000 Subject: [PATCH 04/10] Update generated code for v451 --- OPENAPI_VERSION | 2 +- lib/CreditNoteLineItem.php | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index b46614ccd..b54aeebde 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v450 \ No newline at end of file +v451 \ No newline at end of file diff --git a/lib/CreditNoteLineItem.php b/lib/CreditNoteLineItem.php index 31b90d5b3..1df1f8bb3 100644 --- a/lib/CreditNoteLineItem.php +++ b/lib/CreditNoteLineItem.php @@ -5,6 +5,8 @@ namespace Stripe; /** + * The credit note line item 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 int $amount The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. From e9b311a75732b2bb4ea8023fb4f90cbe6ccebb15 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 8 Aug 2023 04:10:40 +0000 Subject: [PATCH 05/10] Update generated code for v452 --- OPENAPI_VERSION | 2 +- lib/BalanceTransaction.php | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index b54aeebde..85c8b08d1 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v451 \ No newline at end of file +v452 \ No newline at end of file diff --git a/lib/BalanceTransaction.php b/lib/BalanceTransaction.php index 3980138fa..23e4fc32d 100644 --- a/lib/BalanceTransaction.php +++ b/lib/BalanceTransaction.php @@ -24,7 +24,7 @@ * @property string $reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective. * @property null|string|\Stripe\StripeObject $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, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, 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. + * @property string $type Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payment_reversal, 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. */ class BalanceTransaction extends ApiResource { @@ -49,6 +49,7 @@ class BalanceTransaction extends ApiResource const TYPE_PAYMENT = 'payment'; const TYPE_PAYMENT_FAILURE_REFUND = 'payment_failure_refund'; const TYPE_PAYMENT_REFUND = 'payment_refund'; + const TYPE_PAYMENT_REVERSAL = 'payment_reversal'; const TYPE_PAYOUT = 'payout'; const TYPE_PAYOUT_CANCEL = 'payout_cancel'; const TYPE_PAYOUT_FAILURE = 'payout_failure'; From 7ad9867f7e0f24c766442829a3c0108401ade1f7 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 8 Aug 2023 17:47:27 +0000 Subject: [PATCH 06/10] Update generated code for v453 --- OPENAPI_VERSION | 2 +- lib/Event.php | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 85c8b08d1..9a80ace3d 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v452 \ No newline at end of file +v453 \ No newline at end of file diff --git a/lib/Event.php b/lib/Event.php index 12894d475..636ec6470 100644 --- a/lib/Event.php +++ b/lib/Event.php @@ -214,6 +214,7 @@ class Event extends ApiResource const PROMOTION_CODE_UPDATED = 'promotion_code.updated'; const QUOTE_ACCEPTED = 'quote.accepted'; const QUOTE_ACCEPTING = 'quote.accepting'; + const QUOTE_ACCEPT_FAILED = 'quote.accept_failed'; const QUOTE_CANCELED = 'quote.canceled'; const QUOTE_CREATED = 'quote.created'; const QUOTE_DRAFT = 'quote.draft'; From da636d90acd18637807295945c95ec58b3135392 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 9 Aug 2023 18:11:36 +0000 Subject: [PATCH 07/10] Update generated code for v454 --- OPENAPI_VERSION | 2 +- lib/CustomerCashBalanceTransaction.php | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 9a80ace3d..1c6f65d1b 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v453 \ No newline at end of file +v454 \ No newline at end of file diff --git a/lib/CustomerCashBalanceTransaction.php b/lib/CustomerCashBalanceTransaction.php index 1793247d3..e7d182348 100644 --- a/lib/CustomerCashBalanceTransaction.php +++ b/lib/CustomerCashBalanceTransaction.php @@ -12,6 +12,7 @@ * * @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 null|\Stripe\StripeObject $adjusted_for_overdraft * @property null|\Stripe\StripeObject $applied_to_payment * @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. @@ -31,6 +32,7 @@ class CustomerCashBalanceTransaction extends ApiResource use ApiOperations\All; use ApiOperations\Retrieve; + const TYPE_ADJUSTED_FOR_OVERDRAFT = 'adjusted_for_overdraft'; const TYPE_APPLIED_TO_PAYMENT = 'applied_to_payment'; const TYPE_FUNDED = 'funded'; const TYPE_FUNDING_REVERSED = 'funding_reversed'; From d77cb6e8f9c5ce997f633fac64617a489dcadd84 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 9 Aug 2023 23:01:56 +0000 Subject: [PATCH 08/10] Update generated code for v455 --- OPENAPI_VERSION | 2 +- lib/Service/AccountService.php | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 1c6f65d1b..dad490c23 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v454 \ No newline at end of file +v455 \ No newline at end of file diff --git a/lib/Service/AccountService.php b/lib/Service/AccountService.php index 9cc5713df..6ab79a7e0 100644 --- a/lib/Service/AccountService.php +++ b/lib/Service/AccountService.php @@ -160,8 +160,8 @@ public function createPerson($parentId, $params = null, $opts = null) * zero. * * If you want to delete your own account, use the account information tab in your - * account settings instead. + * href="https://dashboard.stripe.com/settings/account">account information tab in + * your account settings instead. * * @param string $id * @param null|array $params @@ -296,9 +296,9 @@ public function retrievePerson($parentId, $id, $params = null, $opts = null) * Custom Only or Custom and Express below. * * To update your own account, use the Dashboard. Refer to our Connect documentation to learn more - * about updating accounts. + * href="https://dashboard.stripe.com/settings/account">Dashboard. Refer to our + * Connect documentation to learn + * more about updating accounts. * * @param string $id * @param null|array $params From 37e48555edd9ba8ce9d7cf76679aa342a01c80d3 Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Thu, 10 Aug 2023 12:53:19 -0700 Subject: [PATCH 09/10] Update generated code (#1546) * Update generated code for v450 * Update generated code for v451 * Update generated code for v452 * Update generated code for v454 * Update generated code for v455 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- OPENAPI_VERSION | 2 +- lib/BalanceTransaction.php | 3 ++- lib/CreditNoteLineItem.php | 2 ++ lib/CustomerCashBalanceTransaction.php | 2 ++ lib/Service/AccountService.php | 10 +++++----- lib/TaxRate.php | 2 +- 6 files changed, 13 insertions(+), 8 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index dae9a81fb..dad490c23 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v446 \ No newline at end of file +v455 \ No newline at end of file diff --git a/lib/BalanceTransaction.php b/lib/BalanceTransaction.php index 3980138fa..23e4fc32d 100644 --- a/lib/BalanceTransaction.php +++ b/lib/BalanceTransaction.php @@ -24,7 +24,7 @@ * @property string $reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective. * @property null|string|\Stripe\StripeObject $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, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, 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. + * @property string $type Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payment_reversal, 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. */ class BalanceTransaction extends ApiResource { @@ -49,6 +49,7 @@ class BalanceTransaction extends ApiResource const TYPE_PAYMENT = 'payment'; const TYPE_PAYMENT_FAILURE_REFUND = 'payment_failure_refund'; const TYPE_PAYMENT_REFUND = 'payment_refund'; + const TYPE_PAYMENT_REVERSAL = 'payment_reversal'; const TYPE_PAYOUT = 'payout'; const TYPE_PAYOUT_CANCEL = 'payout_cancel'; const TYPE_PAYOUT_FAILURE = 'payout_failure'; diff --git a/lib/CreditNoteLineItem.php b/lib/CreditNoteLineItem.php index 31b90d5b3..1df1f8bb3 100644 --- a/lib/CreditNoteLineItem.php +++ b/lib/CreditNoteLineItem.php @@ -5,6 +5,8 @@ namespace Stripe; /** + * The credit note line item 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 int $amount The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. diff --git a/lib/CustomerCashBalanceTransaction.php b/lib/CustomerCashBalanceTransaction.php index 1793247d3..e7d182348 100644 --- a/lib/CustomerCashBalanceTransaction.php +++ b/lib/CustomerCashBalanceTransaction.php @@ -12,6 +12,7 @@ * * @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 null|\Stripe\StripeObject $adjusted_for_overdraft * @property null|\Stripe\StripeObject $applied_to_payment * @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. @@ -31,6 +32,7 @@ class CustomerCashBalanceTransaction extends ApiResource use ApiOperations\All; use ApiOperations\Retrieve; + const TYPE_ADJUSTED_FOR_OVERDRAFT = 'adjusted_for_overdraft'; const TYPE_APPLIED_TO_PAYMENT = 'applied_to_payment'; const TYPE_FUNDED = 'funded'; const TYPE_FUNDING_REVERSED = 'funding_reversed'; diff --git a/lib/Service/AccountService.php b/lib/Service/AccountService.php index 9cc5713df..6ab79a7e0 100644 --- a/lib/Service/AccountService.php +++ b/lib/Service/AccountService.php @@ -160,8 +160,8 @@ public function createPerson($parentId, $params = null, $opts = null) * zero. * * If you want to delete your own account, use the account information tab in your - * account settings instead. + * href="https://dashboard.stripe.com/settings/account">account information tab in + * your account settings instead. * * @param string $id * @param null|array $params @@ -296,9 +296,9 @@ public function retrievePerson($parentId, $id, $params = null, $opts = null) * Custom Only or Custom and Express below. * * To update your own account, use the Dashboard. Refer to our Connect documentation to learn more - * about updating accounts. + * href="https://dashboard.stripe.com/settings/account">Dashboard. Refer to our + * Connect documentation to learn + * more about updating accounts. * * @param string $id * @param null|array $params diff --git a/lib/TaxRate.php b/lib/TaxRate.php index c0bc90262..b210270de 100644 --- a/lib/TaxRate.php +++ b/lib/TaxRate.php @@ -16,7 +16,7 @@ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $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 null|float $effective_percentage Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage does not include the statutory tax rate of non-taxable jurisdictions. + * @property null|float $effective_percentage Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. * @property bool $inclusive This specifies if the tax rate is inclusive or exclusive. * @property null|string $jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. * @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. From 86fc712f44cdc73bd90197ebc5a4d87a0467956d Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Thu, 10 Aug 2023 15:33:41 -0700 Subject: [PATCH 10/10] Update generated code for v458 (#1547) Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- OPENAPI_VERSION | 2 +- lib/Invoice.php | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index dad490c23..a21df3b6d 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v455 \ No newline at end of file +v458 \ No newline at end of file diff --git a/lib/Invoice.php b/lib/Invoice.php index e9511b69a..e1642919e 100644 --- a/lib/Invoice.php +++ b/lib/Invoice.php @@ -98,6 +98,7 @@ * @property int $pre_payment_credit_notes_amount Total amount of all pre-payment credit notes issued for this invoice. * @property null|string|\Stripe\Quote $quote The quote this invoice was generated from. * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this invoice. + * @property null|\Stripe\StripeObject $rendering The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. * @property null|\Stripe\StripeObject $rendering_options Options for invoice PDF rendering. * @property null|\Stripe\StripeObject $shipping_cost The details of the cost of shipping, including the ShippingRate applied on the invoice. * @property null|\Stripe\StripeObject $shipping_details Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.