From fecce93a68df73fe46618096cd8868bcf0f72d5d Mon Sep 17 00:00:00 2001 From: Prathmesh Ranaut Date: Wed, 11 Dec 2024 12:14:24 -0500 Subject: [PATCH] Fixed issue with union and intersectioned types --- lib/Account.php | 26 ++-- lib/AccountNotice.php | 6 +- lib/AccountSession.php | 2 +- lib/ApplePayDomain.php | 2 +- lib/ApplicationFee.php | 2 +- lib/ApplicationFeeRefund.php | 2 +- lib/Apps/Secret.php | 2 +- lib/Balance.php | 10 +- lib/BalanceTransaction.php | 2 +- lib/BankAccount.php | 8 +- lib/Billing/Alert.php | 2 +- lib/Billing/CreditBalanceSummary.php | 2 +- lib/Billing/CreditBalanceTransaction.php | 4 +- lib/Billing/CreditGrant.php | 4 +- lib/Billing/Meter.php | 8 +- lib/Billing/MeterErrorReport.php | 4 +- lib/Billing/MeterEventAdjustment.php | 2 +- lib/BillingPortal/Configuration.php | 10 +- lib/BillingPortal/Session.php | 2 +- lib/Capability.php | 4 +- lib/Capital/FinancingOffer.php | 4 +- lib/Capital/FinancingSummary.php | 2 +- lib/Capital/FinancingTransaction.php | 2 +- lib/Card.php | 6 +- lib/CashBalance.php | 4 +- lib/Charge.php | 22 ++-- lib/Checkout/Session.php | 48 ++++---- lib/Climate/Order.php | 4 +- lib/Climate/Supplier.php | 2 +- lib/ConfirmationToken.php | 8 +- lib/CountrySpec.php | 2 +- lib/Coupon.php | 10 +- lib/CreditNote.php | 12 +- lib/CreditNoteLineItem.php | 6 +- lib/Customer.php | 14 +-- lib/CustomerBalanceTransaction.php | 2 +- lib/CustomerCashBalanceTransaction.php | 12 +- lib/CustomerSession.php | 2 +- lib/Dispute.php | 8 +- lib/Entitlements/Feature.php | 2 +- lib/Event.php | 6 +- ...lingMeterErrorReportTriggeredEventData.php | 2 +- .../V1BillingMeterNoMeterFoundEventData.php | 2 +- lib/File.php | 2 +- lib/FileLink.php | 4 +- lib/FinancialConnections/Account.php | 12 +- lib/FinancialConnections/Institution.php | 2 +- lib/FinancialConnections/Session.php | 10 +- lib/FinancialConnections/Transaction.php | 2 +- lib/Forwarding/Request.php | 8 +- lib/FundingInstructions.php | 2 +- lib/GiftCards/Card.php | 6 +- lib/GiftCards/Transaction.php | 6 +- lib/Identity/VerificationReport.php | 12 +- lib/Identity/VerificationSession.php | 10 +- lib/Invoice.php | 50 ++++---- lib/InvoiceItem.php | 10 +- lib/InvoiceLineItem.php | 14 +-- lib/InvoicePayment.php | 4 +- lib/InvoiceRenderingTemplate.php | 2 +- lib/Issuing/Authorization.php | 22 ++-- lib/Issuing/Card.php | 8 +- lib/Issuing/Cardholder.php | 10 +- lib/Issuing/CreditUnderwritingRecord.php | 10 +- lib/Issuing/Dispute.php | 6 +- lib/Issuing/PersonalizationDesign.php | 6 +- lib/Issuing/PhysicalBundle.php | 2 +- lib/Issuing/Token.php | 2 +- lib/Issuing/Transaction.php | 12 +- lib/LineItem.php | 10 +- lib/Mandate.php | 8 +- lib/Margin.php | 2 +- lib/Order.php | 22 ++-- lib/PaymentAttemptRecord.php | 16 +-- lib/PaymentIntent.php | 24 ++-- lib/PaymentLink.php | 32 ++--- lib/PaymentMethod.php | 112 +++++++++--------- lib/PaymentMethodConfiguration.php | 92 +++++++------- lib/PaymentMethodDomain.php | 10 +- lib/PaymentRecord.php | 18 +-- lib/Payout.php | 6 +- lib/Person.php | 20 ++-- lib/Plan.php | 12 +- lib/Price.php | 12 +- lib/Product.php | 10 +- lib/PromotionCode.php | 6 +- lib/Quote.php | 26 ++-- lib/QuoteLine.php | 14 +-- lib/QuotePreviewInvoice.php | 46 +++---- lib/QuotePreviewSubscriptionSchedule.php | 14 +-- lib/Radar/ValueList.php | 2 +- lib/Radar/ValueListItem.php | 2 +- lib/Refund.php | 10 +- lib/Reporting/ReportRun.php | 2 +- lib/Review.php | 4 +- lib/Service/AccountService.php | 16 +-- lib/Service/ApplePayDomainService.php | 2 +- lib/Service/ApplicationFeeService.php | 2 +- .../BillingPortal/ConfigurationService.php | 2 +- lib/Service/ChargeService.php | 4 +- lib/Service/Checkout/SessionService.php | 2 +- lib/Service/CouponService.php | 6 +- lib/Service/CustomerService.php | 16 +-- lib/Service/DisputeService.php | 2 +- lib/Service/Entitlements/FeatureService.php | 2 +- lib/Service/FileLinkService.php | 4 +- lib/Service/GiftCards/CardService.php | 2 +- lib/Service/GiftCards/TransactionService.php | 2 +- lib/Service/InvoiceItemService.php | 6 +- lib/Service/InvoiceService.php | 22 ++-- lib/Service/Issuing/AuthorizationService.php | 6 +- lib/Service/Issuing/CardService.php | 2 +- lib/Service/Issuing/DisputeService.php | 4 +- lib/Service/Issuing/TransactionService.php | 2 +- lib/Service/OrderService.php | 4 +- lib/Service/PaymentIntentService.php | 4 +- lib/Service/PaymentLinkService.php | 4 +- lib/Service/PaymentMethodService.php | 2 +- lib/Service/PayoutService.php | 2 +- lib/Service/PlanService.php | 6 +- lib/Service/PriceService.php | 2 +- lib/Service/ProductService.php | 6 +- lib/Service/PromotionCodeService.php | 2 +- lib/Service/QuoteService.php | 4 +- lib/Service/Radar/ValueListItemService.php | 2 +- lib/Service/Radar/ValueListService.php | 2 +- lib/Service/RefundService.php | 4 +- lib/Service/SetupIntentService.php | 2 +- lib/Service/ShippingRateService.php | 2 +- lib/Service/SourceService.php | 2 +- lib/Service/SubscriptionItemService.php | 2 +- lib/Service/SubscriptionScheduleService.php | 6 +- lib/Service/SubscriptionService.php | 6 +- lib/Service/TaxIdService.php | 2 +- lib/Service/TaxRateService.php | 2 +- lib/Service/Terminal/ConfigurationService.php | 2 +- lib/Service/Terminal/LocationService.php | 6 +- lib/Service/Terminal/ReaderService.php | 6 +- lib/Service/TestHelpers/TestClockService.php | 2 +- lib/Service/TokenService.php | 2 +- lib/Service/TopupService.php | 4 +- lib/Service/TransferService.php | 6 +- .../V2/Billing/MeterEventSessionService.php | 2 +- .../V2/Core/EventDestinationService.php | 8 +- lib/Service/V2/Core/EventService.php | 2 +- lib/Service/WebhookEndpointService.php | 6 +- lib/SetupAttempt.php | 4 +- lib/SetupIntent.php | 14 +-- lib/ShippingRate.php | 6 +- lib/Sigma/ScheduledQueryRun.php | 2 +- lib/Source.php | 54 ++++----- lib/SourceMandateNotification.php | 6 +- lib/SourceTransaction.php | 10 +- lib/Subscription.php | 30 ++--- lib/SubscriptionItem.php | 6 +- lib/SubscriptionSchedule.php | 16 +-- lib/Tax/Association.php | 2 +- lib/Tax/Calculation.php | 10 +- lib/Tax/CalculationLineItem.php | 2 +- lib/Tax/Form.php | 20 ++-- lib/Tax/Registration.php | 2 +- lib/Tax/Settings.php | 6 +- lib/Tax/Transaction.php | 12 +- lib/Tax/TransactionLineItem.php | 4 +- lib/TaxId.php | 6 +- lib/TaxRate.php | 6 +- lib/Terminal/Configuration.php | 14 +-- lib/Terminal/Location.php | 8 +- lib/Terminal/Reader.php | 8 +- lib/Terminal/ReaderCollectedData.php | 2 +- lib/TestHelpers/TestClock.php | 4 +- lib/Token.php | 2 +- lib/Topup.php | 4 +- lib/Transfer.php | 2 +- lib/TransferReversal.php | 2 +- lib/Treasury/CreditReversal.php | 2 +- lib/Treasury/DebitReversal.php | 4 +- lib/Treasury/FinancialAccount.php | 10 +- lib/Treasury/FinancialAccountFeatures.php | 14 +-- lib/Treasury/InboundTransfer.php | 8 +- lib/Treasury/OutboundPayment.php | 10 +- lib/Treasury/OutboundTransfer.php | 10 +- lib/Treasury/ReceivedCredit.php | 8 +- lib/Treasury/ReceivedDebit.php | 8 +- lib/Treasury/Transaction.php | 8 +- lib/Treasury/TransactionEntry.php | 4 +- lib/UsageRecordSummary.php | 2 +- lib/V2/Billing/MeterEventAdjustment.php | 2 +- lib/V2/EventDestination.php | 8 +- lib/WebhookEndpoint.php | 6 +- 190 files changed, 819 insertions(+), 819 deletions(-) diff --git a/lib/Account.php b/lib/Account.php index 342b58c5e..85f1b00cf 100644 --- a/lib/Account.php +++ b/lib/Account.php @@ -20,27 +20,27 @@ * * @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|object{annual_revenue: null|object{amount: null|int, currency: null|string, fiscal_year_end: null|string}&\Stripe\StripeObject&\stdClass, estimated_worker_count: null|int, mcc: null|string, monthly_estimated_revenue?: object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass, name: null|string, product_description?: null|string, support_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, support_email: null|string, support_phone: null|string, support_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass $business_profile Business information about the account. + * @property null|(object{annual_revenue: null|(object{amount: null|int, currency: null|string, fiscal_year_end: null|string}&\Stripe\StripeObject&\stdClass), estimated_worker_count: null|int, mcc: null|string, monthly_estimated_revenue?: (object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass), name: null|string, product_description?: null|string, support_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), support_email: null|string, support_phone: null|string, support_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass) $business_profile Business information about the account. * @property null|string $business_type The business type. After you create an Account Link or Account Session, this property is only returned for accounts where controller.requirement_collection is application, which includes Custom accounts. - * @property null|object{acss_debit_payments?: string, affirm_payments?: string, afterpay_clearpay_payments?: string, alma_payments?: string, amazon_pay_payments?: string, au_becs_debit_payments?: string, automatic_indirect_tax?: string, bacs_debit_payments?: string, bancontact_payments?: string, bank_transfer_payments?: string, blik_payments?: string, boleto_payments?: string, card_issuing?: string, card_payments?: string, cartes_bancaires_payments?: string, cashapp_payments?: string, eps_payments?: string, fpx_payments?: string, gb_bank_transfer_payments?: string, giropay_payments?: string, gopay_payments?: string, grabpay_payments?: string, id_bank_transfer_payments?: string, id_bank_transfer_payments_bca?: string, ideal_payments?: string, india_international_payments?: string, jcb_payments?: string, jp_bank_transfer_payments?: string, kakao_pay_payments?: string, klarna_payments?: string, konbini_payments?: string, kr_card_payments?: string, legacy_payments?: string, link_payments?: string, mb_way_payments?: string, mobilepay_payments?: string, multibanco_payments?: string, mx_bank_transfer_payments?: string, naver_pay_payments?: string, oxxo_payments?: string, p24_payments?: string, payco_payments?: string, paynow_payments?: string, paypal_payments?: string, payto_payments?: string, promptpay_payments?: string, qris_payments?: string, rechnung_payments?: string, revolut_pay_payments?: string, samsung_pay_payments?: string, sepa_bank_transfer_payments?: string, sepa_debit_payments?: string, shopeepay_payments?: string, sofort_payments?: string, swish_payments?: string, tax_reporting_us_1099_k?: string, tax_reporting_us_1099_misc?: string, transfers?: string, treasury?: string, treasury_evolve?: string, treasury_fifth_third?: string, treasury_goldman_sachs?: string, twint_payments?: string, us_bank_account_ach_payments?: string, us_bank_transfer_payments?: string, zip_payments?: string}&\Stripe\StripeObject&\stdClass $capabilities + * @property null|(object{acss_debit_payments?: string, affirm_payments?: string, afterpay_clearpay_payments?: string, alma_payments?: string, amazon_pay_payments?: string, au_becs_debit_payments?: string, automatic_indirect_tax?: string, bacs_debit_payments?: string, bancontact_payments?: string, bank_transfer_payments?: string, blik_payments?: string, boleto_payments?: string, card_issuing?: string, card_payments?: string, cartes_bancaires_payments?: string, cashapp_payments?: string, eps_payments?: string, fpx_payments?: string, gb_bank_transfer_payments?: string, giropay_payments?: string, gopay_payments?: string, grabpay_payments?: string, id_bank_transfer_payments?: string, id_bank_transfer_payments_bca?: string, ideal_payments?: string, india_international_payments?: string, jcb_payments?: string, jp_bank_transfer_payments?: string, kakao_pay_payments?: string, klarna_payments?: string, konbini_payments?: string, kr_card_payments?: string, legacy_payments?: string, link_payments?: string, mb_way_payments?: string, mobilepay_payments?: string, multibanco_payments?: string, mx_bank_transfer_payments?: string, naver_pay_payments?: string, oxxo_payments?: string, p24_payments?: string, payco_payments?: string, paynow_payments?: string, paypal_payments?: string, payto_payments?: string, promptpay_payments?: string, qris_payments?: string, rechnung_payments?: string, revolut_pay_payments?: string, samsung_pay_payments?: string, sepa_bank_transfer_payments?: string, sepa_debit_payments?: string, shopeepay_payments?: string, sofort_payments?: string, swish_payments?: string, tax_reporting_us_1099_k?: string, tax_reporting_us_1099_misc?: string, transfers?: string, treasury?: string, treasury_evolve?: string, treasury_fifth_third?: string, treasury_goldman_sachs?: string, twint_payments?: string, us_bank_account_ach_payments?: string, us_bank_transfer_payments?: string, zip_payments?: string}&\Stripe\StripeObject&\stdClass) $capabilities * @property null|bool $charges_enabled Whether the account can process charges. - * @property object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, address_kana?: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass, address_kanji?: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: null|string, name_kana?: null|string, name_kanji?: null|string, owners_provided?: bool, ownership_declaration?: null|object{date: null|int, ip: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass, phone?: null|string, structure?: string, tax_id_provided?: bool, tax_id_registrar?: string, vat_id_provided?: bool, verification?: null|object{document: object{back: null|string|\Stripe\File, details: null|string, details_code: null|string, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $company - * @property null|object{application?: object{loss_liable: bool, onboarding_owner: bool, pricing_controls: bool}&\Stripe\StripeObject&\stdClass, dashboard?: object{type: string}&\Stripe\StripeObject&\stdClass, fees?: object{payer: string}&\Stripe\StripeObject&\stdClass, is_controller?: bool, losses?: object{payments: string}&\Stripe\StripeObject&\stdClass, requirement_collection?: string, stripe_dashboard?: object{type: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $controller + * @property (object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), address_kana?: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass), address_kanji?: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass), directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: null|string, name_kana?: null|string, name_kanji?: null|string, owners_provided?: bool, ownership_declaration?: null|(object{date: null|int, ip: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass), phone?: null|string, structure?: string, tax_id_provided?: bool, tax_id_registrar?: string, vat_id_provided?: bool, verification?: null|(object{document: (object{back: null|string|\Stripe\File, details: null|string, details_code: null|string, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $company + * @property null|(object{application?: (object{loss_liable: bool, onboarding_owner: bool, pricing_controls: bool}&\Stripe\StripeObject&\stdClass), dashboard?: (object{type: string}&\Stripe\StripeObject&\stdClass), fees?: (object{payer: string}&\Stripe\StripeObject&\stdClass), is_controller?: bool, losses?: (object{payments: string}&\Stripe\StripeObject&\stdClass), requirement_collection?: string, stripe_dashboard?: (object{type: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $controller * @property null|string $country The account's country. * @property null|int $created Time at which the account was connected. Measured in seconds since the Unix epoch. * @property null|string $default_currency Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country. * @property null|bool $details_submitted Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details. * @property null|string $email An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. * @property null|\Stripe\Collection<\Stripe\BankAccount|\Stripe\Card> $external_accounts External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where controller[is_controller] is true. - * @property object{alternatives: null|object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass[], current_deadline: null|int, currently_due: null|string[], disabled_reason: null|string, errors: null|object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], eventually_due: null|string[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass $future_requirements - * @property null|object{payments_pricing: null|string}&\Stripe\StripeObject&\stdClass $groups The groups associated with the account. + * @property (object{alternatives: null|(object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass)[], current_deadline: null|int, currently_due: null|string[], disabled_reason: null|string, errors: null|(object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], eventually_due: null|string[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass) $future_requirements + * @property null|(object{payments_pricing: null|string}&\Stripe\StripeObject&\stdClass) $groups The groups associated with the account. * @property null|\Stripe\Person $individual

This is an object representing a person associated with a Stripe account.

A platform cannot access a person for an account where account.controller.requirement_collection is stripe, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.

See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.

* @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|bool $payouts_enabled Whether the funds in this account can be paid out. - * @property object{alternatives: null|object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass[], current_deadline: null|int, currently_due: null|string[], disabled_reason: null|string, errors: null|object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], eventually_due: null|string[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass $requirements - * @property null|object{charges: object{pause_requested: bool}&\Stripe\StripeObject&\stdClass, payouts: object{pause_requested: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $risk_controls - * @property null|object{bacs_debit_payments?: object{display_name: null|string, service_user_number: null|string}&\Stripe\StripeObject&\stdClass, bank_bca_onboarding?: object{account_holder_name?: string, business_account_number?: string}&\Stripe\StripeObject&\stdClass, branding: object{icon: null|string|\Stripe\File, logo: null|string|\Stripe\File, primary_color: null|string, secondary_color: null|string}&\Stripe\StripeObject&\stdClass, capital?: object{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass, card_issuing?: object{tos_acceptance?: object{date: null|int, ip: null|string, user_agent?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, card_payments: object{decline_on?: object{avs_failure: bool, cvc_failure: bool}&\Stripe\StripeObject&\stdClass, statement_descriptor_prefix: null|string, statement_descriptor_prefix_kana: null|string, statement_descriptor_prefix_kanji: null|string}&\Stripe\StripeObject&\stdClass, dashboard: object{display_name: null|string, timezone: null|string}&\Stripe\StripeObject&\stdClass, invoices?: object{default_account_tax_ids: null|(string|\Stripe\TaxId)[]}&\Stripe\StripeObject&\stdClass, payments: object{statement_descriptor: null|string, statement_descriptor_kana: null|string, statement_descriptor_kanji: null|string, statement_descriptor_prefix_kana: null|string, statement_descriptor_prefix_kanji: null|string}&\Stripe\StripeObject&\stdClass, payouts?: object{debit_negative_balances: bool, schedule: object{delay_days: int, interval: string, monthly_anchor?: int, weekly_anchor?: string}&\Stripe\StripeObject&\stdClass, statement_descriptor: null|string}&\Stripe\StripeObject&\stdClass, sepa_debit_payments?: object{creditor_id?: string}&\Stripe\StripeObject&\stdClass, tax_forms?: object{consented_to_paperless_delivery: bool}&\Stripe\StripeObject&\stdClass, treasury?: object{tos_acceptance?: object{date: null|int, ip: null|string, user_agent?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $settings Options for customizing how the account functions within Stripe. - * @property object{date?: null|int, ip?: null|string, service_agreement?: string, user_agent?: null|string}&\Stripe\StripeObject&\stdClass $tos_acceptance + * @property (object{alternatives: null|(object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass)[], current_deadline: null|int, currently_due: null|string[], disabled_reason: null|string, errors: null|(object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], eventually_due: null|string[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass) $requirements + * @property null|(object{charges: (object{pause_requested: bool}&\Stripe\StripeObject&\stdClass), payouts: (object{pause_requested: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $risk_controls + * @property null|(object{bacs_debit_payments?: (object{display_name: null|string, service_user_number: null|string}&\Stripe\StripeObject&\stdClass), bank_bca_onboarding?: (object{account_holder_name?: string, business_account_number?: string}&\Stripe\StripeObject&\stdClass), branding: (object{icon: null|string|\Stripe\File, logo: null|string|\Stripe\File, primary_color: null|string, secondary_color: null|string}&\Stripe\StripeObject&\stdClass), capital?: (object{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass), card_issuing?: (object{tos_acceptance?: (object{date: null|int, ip: null|string, user_agent?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), card_payments: (object{decline_on?: (object{avs_failure: bool, cvc_failure: bool}&\Stripe\StripeObject&\stdClass), statement_descriptor_prefix: null|string, statement_descriptor_prefix_kana: null|string, statement_descriptor_prefix_kanji: null|string}&\Stripe\StripeObject&\stdClass), dashboard: (object{display_name: null|string, timezone: null|string}&\Stripe\StripeObject&\stdClass), invoices?: (object{default_account_tax_ids: null|(string|\Stripe\TaxId)[]}&\Stripe\StripeObject&\stdClass), payments: (object{statement_descriptor: null|string, statement_descriptor_kana: null|string, statement_descriptor_kanji: null|string, statement_descriptor_prefix_kana: null|string, statement_descriptor_prefix_kanji: null|string}&\Stripe\StripeObject&\stdClass), payouts?: (object{debit_negative_balances: bool, schedule: (object{delay_days: int, interval: string, monthly_anchor?: int, weekly_anchor?: string}&\Stripe\StripeObject&\stdClass), statement_descriptor: null|string}&\Stripe\StripeObject&\stdClass), sepa_debit_payments?: (object{creditor_id?: string}&\Stripe\StripeObject&\stdClass), tax_forms?: (object{consented_to_paperless_delivery: bool}&\Stripe\StripeObject&\stdClass), treasury?: (object{tos_acceptance?: (object{date: null|int, ip: null|string, user_agent?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $settings Options for customizing how the account functions within Stripe. + * @property (object{date?: null|int, ip?: null|string, service_agreement?: string, user_agent?: null|string}&\Stripe\StripeObject&\stdClass) $tos_acceptance * @property null|string $type The Stripe account type. Can be standard, express, custom, or none. */ class Account extends ApiResource @@ -72,7 +72,7 @@ class Account extends ApiResource * information during account onboarding. You can prefill any information on the * account. * - * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, controller?: array{application?: array{loss_liable: bool, onboarding_owner?: bool, pricing_controls?: bool}, dashboard?: array{type?: string}, fees?: array{payer?: string}, losses?: array{payments?: string}, requirement_collection?: string, stripe_dashboard?: array{type?: string}}, country?: string, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}, type?: string} $params + * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, controller?: array{application?: array{loss_liable: bool, onboarding_owner?: bool, pricing_controls?: bool}, dashboard?: array{type?: string}, fees?: array{payer?: string}, losses?: array{payments?: string}, requirement_collection?: string, stripe_dashboard?: array{type?: string}}, country?: string, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|\Stripe\StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}, type?: string} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -106,7 +106,7 @@ public static function create($params = null, $options = null) * href="https://dashboard.stripe.com/settings/account">account information tab in * your account settings instead. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -164,7 +164,7 @@ public static function all($params = null, $opts = null) * more about updating accounts. * * @param string $id the ID of the resource to update - * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: null|string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, invoices?: array{default_account_tax_ids?: null|string[]}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}} $params + * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: null|string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|\Stripe\StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, invoices?: array{default_account_tax_ids?: null|string[]}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/AccountNotice.php b/lib/AccountNotice.php index 1879f407e..e62d61880 100644 --- a/lib/AccountNotice.php +++ b/lib/AccountNotice.php @@ -13,10 +13,10 @@ * @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 null|int $deadline When present, the deadline for sending the notice to meet the relevant regulations. - * @property null|object{plain_text: string, recipient: string, subject: string}&\Stripe\StripeObject&\stdClass $email Information about the email when sent. - * @property null|object{capability: null|string, issuing_credit_underwriting_record?: null|string, issuing_dispute: null|string}&\Stripe\StripeObject&\stdClass $linked_objects Information about objects related to the notice. + * @property null|(object{plain_text: string, recipient: string, subject: string}&\Stripe\StripeObject&\stdClass) $email Information about the email when sent. + * @property null|(object{capability: null|string, issuing_credit_underwriting_record?: null|string, issuing_dispute: null|string}&\Stripe\StripeObject&\stdClass) $linked_objects Information about objects related to the notice. * @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 null|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|\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 the notice is being sent. The reason determines what copy the notice must contain. See the regulated customer notices guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason. * @property null|int $sent_at Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent. */ diff --git a/lib/AccountSession.php b/lib/AccountSession.php index 8e53b9a2f..8d09dcffb 100644 --- a/lib/AccountSession.php +++ b/lib/AccountSession.php @@ -16,7 +16,7 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property string $account The ID of the account the AccountSession was created for * @property string $client_secret

The client secret of this AccountSession. Used on the client to set up secure access to the given account.

The client secret can be used to provide access to account from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.

Refer to our docs to setup Connect embedded components and learn about how client_secret should be handled.

- * @property object{account_management: object{enabled: bool, features: object{disable_stripe_user_authentication: bool, external_account_collection: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, account_onboarding: object{enabled: bool, features: object{disable_stripe_user_authentication: bool, external_account_collection: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, balances: object{enabled: bool, features: object{disable_stripe_user_authentication: bool, edit_payout_schedule: bool, external_account_collection: bool, instant_payouts: bool, standard_payouts: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, capital_financing?: null|object{enabled: bool, features: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, capital_financing_application?: null|object{enabled: bool, features: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, capital_financing_promotion?: null|object{enabled: bool, features: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, documents: object{enabled: bool, features: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, notification_banner: object{enabled: bool, features: object{disable_stripe_user_authentication: bool, external_account_collection: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payment_details: object{enabled: bool, features: object{capture_payments: bool, destination_on_behalf_of_charge_management: bool, dispute_management: bool, refund_management: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payments: object{enabled: bool, features: object{capture_payments: bool, destination_on_behalf_of_charge_management: bool, dispute_management: bool, refund_management: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payouts: object{enabled: bool, features: object{disable_stripe_user_authentication: bool, edit_payout_schedule: bool, external_account_collection: bool, instant_payouts: bool, standard_payouts: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payouts_list: object{enabled: bool, features: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, tax_registrations: object{enabled: bool, features: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, tax_settings: object{enabled: bool, features: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $components + * @property (object{account_management: (object{enabled: bool, features: (object{disable_stripe_user_authentication: bool, external_account_collection: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), account_onboarding: (object{enabled: bool, features: (object{disable_stripe_user_authentication: bool, external_account_collection: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), balances: (object{enabled: bool, features: (object{disable_stripe_user_authentication: bool, edit_payout_schedule: bool, external_account_collection: bool, instant_payouts: bool, standard_payouts: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), capital_financing?: null|(object{enabled: bool, features: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), capital_financing_application?: null|(object{enabled: bool, features: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), capital_financing_promotion?: null|(object{enabled: bool, features: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), documents: (object{enabled: bool, features: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), notification_banner: (object{enabled: bool, features: (object{disable_stripe_user_authentication: bool, external_account_collection: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payment_details: (object{enabled: bool, features: (object{capture_payments: bool, destination_on_behalf_of_charge_management: bool, dispute_management: bool, refund_management: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payments: (object{enabled: bool, features: (object{capture_payments: bool, destination_on_behalf_of_charge_management: bool, dispute_management: bool, refund_management: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payouts: (object{enabled: bool, features: (object{disable_stripe_user_authentication: bool, edit_payout_schedule: bool, external_account_collection: bool, instant_payouts: bool, standard_payouts: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payouts_list: (object{enabled: bool, features: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), tax_registrations: (object{enabled: bool, features: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), tax_settings: (object{enabled: bool, features: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $components * @property int $expires_at The timestamp at which this AccountSession will expire. * @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. */ diff --git a/lib/ApplePayDomain.php b/lib/ApplePayDomain.php index b1c0b1f84..2eb882161 100644 --- a/lib/ApplePayDomain.php +++ b/lib/ApplePayDomain.php @@ -40,7 +40,7 @@ public static function create($params = null, $options = null) /** * Delete an apple pay domain. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/ApplicationFee.php b/lib/ApplicationFee.php index ba5a23b27..7b17b878e 100644 --- a/lib/ApplicationFee.php +++ b/lib/ApplicationFee.php @@ -15,7 +15,7 @@ * @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 null|object{charge?: string, payout?: string, type: string}&\Stripe\StripeObject&\stdClass $fee_source Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. + * @property null|(object{charge?: string, payout?: string, type: string}&\Stripe\StripeObject&\stdClass) $fee_source Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. * @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 null|string|\Stripe\Charge $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. diff --git a/lib/ApplicationFeeRefund.php b/lib/ApplicationFeeRefund.php index b38342c0d..1d383c014 100644 --- a/lib/ApplicationFeeRefund.php +++ b/lib/ApplicationFeeRefund.php @@ -18,7 +18,7 @@ * @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\ApplicationFee $fee ID of the application fee that was refunded. - * @property null|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|\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. */ class ApplicationFeeRefund extends ApiResource { diff --git a/lib/Apps/Secret.php b/lib/Apps/Secret.php index 622fdf13d..c2ec48bc4 100644 --- a/lib/Apps/Secret.php +++ b/lib/Apps/Secret.php @@ -23,7 +23,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 string $name A name for the secret that's unique within the scope. * @property null|string $payload The plaintext secret value to be stored. - * @property object{type: string, user?: string}&\Stripe\StripeObject&\stdClass $scope + * @property (object{type: string, user?: string}&\Stripe\StripeObject&\stdClass) $scope */ class Secret extends \Stripe\ApiResource { diff --git a/lib/Balance.php b/lib/Balance.php index aae175f28..89e66c002 100644 --- a/lib/Balance.php +++ b/lib/Balance.php @@ -18,12 +18,12 @@ * Related guide: Understanding Connect account balances * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property object{amount: int, currency: string, source_types?: object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[] $available Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property. - * @property null|object{amount: int, currency: string, source_types?: object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[] $connect_reserved Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the source_types property. - * @property null|object{amount: int, currency: string, net_available?: object{amount: int, destination: string, source_types?: object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[], source_types?: object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[] $instant_available Funds that you can pay out using Instant Payouts. - * @property null|object{available: object{amount: int, currency: string, source_types?: object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass $issuing + * @property (object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[] $available Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property. + * @property null|(object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[] $connect_reserved Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the source_types property. + * @property null|(object{amount: int, currency: string, net_available?: (object{amount: int, destination: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[], source_types?: (object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[] $instant_available Funds that you can pay out using Instant Payouts. + * @property null|(object{available: (object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass) $issuing * @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 object{amount: int, currency: string, source_types?: object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[] $pending Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property. + * @property (object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[] $pending Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property. */ class Balance extends SingletonApiResource { diff --git a/lib/BalanceTransaction.php b/lib/BalanceTransaction.php index 3dc8d0782..310ac9103 100644 --- a/lib/BalanceTransaction.php +++ b/lib/BalanceTransaction.php @@ -19,7 +19,7 @@ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. * @property null|float $exchange_rate If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the amount in currency A, multipled by the exchange_rate, equals the amount in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's amount is 1000 and currency is eur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's amount is 1234, its currency is usd, and the exchange_rate is 1.234. * @property int $fee Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. - * @property (object{amount: int, application: null|string, currency: string, description: null|string, type: string}&\Stripe\StripeObject&\stdClass)[] $fee_details Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. + * @property ((object{amount: int, application: null|string, currency: string, description: null|string, type: string}&\Stripe\StripeObject&\stdClass))[] $fee_details Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. * @property int $net Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by amount - fee * @property string $reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective. * @property null|string|\Stripe\ApplicationFee|\Stripe\ApplicationFeeRefund|\Stripe\Charge|\Stripe\ConnectCollectionTransfer|\Stripe\CustomerCashBalanceTransaction|\Stripe\Dispute|\Stripe\Issuing\Authorization|\Stripe\Issuing\Dispute|\Stripe\Issuing\Transaction|\Stripe\Payout|\Stripe\Refund|\Stripe\ReserveTransaction|\Stripe\TaxDeductedAtSource|\Stripe\Topup|\Stripe\Transfer|\Stripe\TransferReversal $source This transaction relates to the Stripe object. diff --git a/lib/BankAccount.php b/lib/BankAccount.php index 14d39dfc1..23cd15e5c 100644 --- a/lib/BankAccount.php +++ b/lib/BankAccount.php @@ -26,10 +26,10 @@ * @property null|string|\Stripe\Customer $customer The ID of the customer that the bank account is associated with. * @property null|bool $default_for_currency Whether this bank account is the default external account for its currency. * @property null|string $fingerprint Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - * @property null|object{currently_due: null|string[], errors: null|object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass $future_requirements Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when. + * @property null|(object{currently_due: null|string[], errors: null|(object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass) $future_requirements Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when. * @property string $last4 The last four digits of the bank account number. - * @property null|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|object{currently_due: null|string[], errors: null|object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass $requirements Information about the requirements for the bank account, including what information needs to be collected. + * @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|(object{currently_due: null|string[], errors: null|(object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], past_due: null|string[], pending_verification: null|string[]}&\Stripe\StripeObject&\stdClass) $requirements Information about the requirements for the bank account, including what information needs to be collected. * @property null|string $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 payout sent to this bank account fails, we'll set the status to errored and will not continue to send scheduled payouts until the bank details are updated.

For external accounts, possible values are new, errored and verification_failed. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated. In the US and India, if we can't verify the owner of the bank account, we'll set the status to verification_failed. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.

*/ @@ -40,7 +40,7 @@ class BankAccount extends ApiResource /** * Delete a specified external account for a given account. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Billing/Alert.php b/lib/Billing/Alert.php index 3089f6743..d93f51e8b 100644 --- a/lib/Billing/Alert.php +++ b/lib/Billing/Alert.php @@ -13,7 +13,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 null|string $status Status of the alert. This can be active, inactive or archived. * @property string $title Title of the alert. - * @property null|object{filters: null|(object{customer: null|string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass)[], gte: int, meter: string|\Stripe\Billing\Meter, recurrence: string}&\Stripe\StripeObject&\stdClass $usage_threshold Encapsulates configuration of the alert to monitor usage on a specific Billing Meter. + * @property null|(object{filters: null|((object{customer: null|string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass))[], gte: int, meter: string|\Stripe\Billing\Meter, recurrence: string}&\Stripe\StripeObject&\stdClass) $usage_threshold Encapsulates configuration of the alert to monitor usage on a specific Billing Meter. */ class Alert extends \Stripe\ApiResource { diff --git a/lib/Billing/CreditBalanceSummary.php b/lib/Billing/CreditBalanceSummary.php index e41185051..b4eefe110 100644 --- a/lib/Billing/CreditBalanceSummary.php +++ b/lib/Billing/CreditBalanceSummary.php @@ -8,7 +8,7 @@ * Indicates the billing credit balance for billing credits granted to a customer. * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property (object{available_balance: object{monetary: null|object{currency: string, value: int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, ledger_balance: object{monetary: null|object{currency: string, value: int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[] $balances The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry. + * @property ((object{available_balance: (object{monetary: null|(object{currency: string, value: int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), ledger_balance: (object{monetary: null|(object{currency: string, value: int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[] $balances The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry. * @property string|\Stripe\Customer $customer The customer the balance is for. * @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. */ diff --git a/lib/Billing/CreditBalanceTransaction.php b/lib/Billing/CreditBalanceTransaction.php index 447720342..d82be4334 100644 --- a/lib/Billing/CreditBalanceTransaction.php +++ b/lib/Billing/CreditBalanceTransaction.php @@ -10,9 +10,9 @@ * @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 null|object{amount: object{monetary: null|object{currency: string, value: int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $credit Credit details for this credit balance transaction. Only present if type is credit. + * @property null|(object{amount: (object{monetary: null|(object{currency: string, value: int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $credit Credit details for this credit balance transaction. Only present if type is credit. * @property string|\Stripe\Billing\CreditGrant $credit_grant The credit grant associated with this credit balance transaction. - * @property null|object{amount: object{monetary: null|object{currency: string, value: int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, credits_applied: null|object{invoice: string|\Stripe\Invoice, invoice_line_item: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $debit Debit details for this credit balance transaction. Only present if type is debit. + * @property null|(object{amount: (object{monetary: null|(object{currency: string, value: int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), credits_applied: null|(object{invoice: string|\Stripe\Invoice, invoice_line_item: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $debit Debit details for this credit balance transaction. Only present if type is debit. * @property int $effective_at The effective time of this credit balance transaction. * @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 null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this credit balance transaction belongs to. diff --git a/lib/Billing/CreditGrant.php b/lib/Billing/CreditGrant.php index 4b170b4a9..2f4c2b67c 100644 --- a/lib/Billing/CreditGrant.php +++ b/lib/Billing/CreditGrant.php @@ -11,8 +11,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 object{monetary: null|object{currency: string, value: int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $amount - * @property object{scope: object{price_type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $applicability_config + * @property (object{monetary: null|(object{currency: string, value: int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $amount + * @property (object{scope: (object{price_type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $applicability_config * @property string $category The category of this credit grant. This is for tracking purposes and isn't displayed to the customer. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property string|\Stripe\Customer $customer ID of the customer receiving the billing credits. diff --git a/lib/Billing/Meter.php b/lib/Billing/Meter.php index d5bd79b04..4e6bd0788 100644 --- a/lib/Billing/Meter.php +++ b/lib/Billing/Meter.php @@ -12,16 +12,16 @@ * @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 object{event_payload_key: string, type: string}&\Stripe\StripeObject&\stdClass $customer_mapping - * @property object{formula: string}&\Stripe\StripeObject&\stdClass $default_aggregation + * @property (object{event_payload_key: string, type: string}&\Stripe\StripeObject&\stdClass) $customer_mapping + * @property (object{formula: string}&\Stripe\StripeObject&\stdClass) $default_aggregation * @property string $display_name The meter's name. * @property string $event_name The name of the meter event to record usage for. Corresponds with the event_name field on meter events. * @property null|string $event_time_window The time window to pre-aggregate meter events for, 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 string $status The meter's status. - * @property object{deactivated_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{deactivated_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch. - * @property object{event_payload_key: string}&\Stripe\StripeObject&\stdClass $value_settings + * @property (object{event_payload_key: string}&\Stripe\StripeObject&\stdClass) $value_settings */ class Meter extends \Stripe\ApiResource { diff --git a/lib/Billing/MeterErrorReport.php b/lib/Billing/MeterErrorReport.php index 2d4441acb..21cae28ae 100644 --- a/lib/Billing/MeterErrorReport.php +++ b/lib/Billing/MeterErrorReport.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 object{error_count: int, error_types: (object{sample_errors: (object{api_request: null|object{id: string, idempotency_key: string}&\Stripe\StripeObject&\stdClass, error_message: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $reason - * @property null|object{id: string, object: string, url: string}&\Stripe\StripeObject&\stdClass $related_object The related objects about the error + * @property (object{error_count: int, error_types: ((object{sample_errors: ((object{api_request: null|(object{id: string, idempotency_key: string}&\Stripe\StripeObject&\stdClass), error_message: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $reason + * @property null|(object{id: string, object: string, url: string}&\Stripe\StripeObject&\stdClass) $related_object The related objects about the error * @property string $summary Summary of invalid events * @property int $validation_end Time when validation ended. Measured in seconds since the Unix epoch * @property int $validation_start Time when validation started. Measured in seconds since the Unix epoch diff --git a/lib/Billing/MeterEventAdjustment.php b/lib/Billing/MeterEventAdjustment.php index 44ca781b3..5ede3b866 100644 --- a/lib/Billing/MeterEventAdjustment.php +++ b/lib/Billing/MeterEventAdjustment.php @@ -8,7 +8,7 @@ * A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer. * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property null|object{identifier: null|string}&\Stripe\StripeObject&\stdClass $cancel Specifies which event to cancel. + * @property null|(object{identifier: null|string}&\Stripe\StripeObject&\stdClass) $cancel Specifies which event to cancel. * @property string $event_name The name of the meter event. Corresponds with the event_name field on a meter. * @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 $status The meter event adjustment's status. diff --git a/lib/BillingPortal/Configuration.php b/lib/BillingPortal/Configuration.php index b1847c298..6fc45d4b2 100644 --- a/lib/BillingPortal/Configuration.php +++ b/lib/BillingPortal/Configuration.php @@ -11,14 +11,14 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property bool $active Whether the configuration is active and can be used to create portal sessions. * @property null|string|\Stripe\Application $application ID of the Connect Application that created the configuration. - * @property object{headline: null|string, privacy_policy_url: null|string, terms_of_service_url: null|string}&\Stripe\StripeObject&\stdClass $business_profile + * @property (object{headline: null|string, privacy_policy_url: null|string, terms_of_service_url: null|string}&\Stripe\StripeObject&\stdClass) $business_profile * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $default_return_url The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session. - * @property object{customer_update: object{allowed_updates: string[], enabled: bool}&\Stripe\StripeObject&\stdClass, invoice_history: object{enabled: bool}&\Stripe\StripeObject&\stdClass, payment_method_update: object{enabled: bool}&\Stripe\StripeObject&\stdClass, subscription_cancel: object{cancellation_reason: object{enabled: bool, options: string[]}&\Stripe\StripeObject&\stdClass, enabled: bool, mode: string, proration_behavior: string}&\Stripe\StripeObject&\stdClass, subscription_update: object{default_allowed_updates: string[], enabled: bool, products?: null|object{prices: string[], product: string}&\Stripe\StripeObject&\stdClass[], proration_behavior: string, schedule_at_period_end: object{conditions: object{type: string}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $features + * @property (object{customer_update: (object{allowed_updates: string[], enabled: bool}&\Stripe\StripeObject&\stdClass), invoice_history: (object{enabled: bool}&\Stripe\StripeObject&\stdClass), payment_method_update: (object{enabled: bool}&\Stripe\StripeObject&\stdClass), subscription_cancel: (object{cancellation_reason: (object{enabled: bool, options: string[]}&\Stripe\StripeObject&\stdClass), enabled: bool, mode: string, proration_behavior: string}&\Stripe\StripeObject&\stdClass), subscription_update: (object{default_allowed_updates: string[], enabled: bool, products?: null|(object{prices: string[], product: string}&\Stripe\StripeObject&\stdClass)[], proration_behavior: string, schedule_at_period_end: (object{conditions: (object{type: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $features * @property bool $is_default Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session. * @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 object{enabled: bool, url: null|string}&\Stripe\StripeObject&\stdClass $login_page - * @property null|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 (object{enabled: bool, url: null|string}&\Stripe\StripeObject&\stdClass) $login_page + * @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 int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch. */ class Configuration extends \Stripe\ApiResource @@ -92,7 +92,7 @@ public static function retrieve($id, $opts = null) * Updates a configuration that describes the functionality of the customer portal. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, business_profile?: array{headline?: null|string, privacy_policy_url?: null|string, terms_of_service_url?: null|string}, default_return_url?: null|string, expand?: string[], features?: array{customer_update?: array{allowed_updates?: null|string[], enabled?: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options?: null|string[]}, enabled?: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled?: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: null|array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: null|StripeObject} $params + * @param null|array{active?: bool, business_profile?: array{headline?: null|string, privacy_policy_url?: null|string, terms_of_service_url?: null|string}, default_return_url?: null|string, expand?: string[], features?: array{customer_update?: array{allowed_updates?: null|string[], enabled?: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options?: null|string[]}, enabled?: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled?: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: null|array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/BillingPortal/Session.php b/lib/BillingPortal/Session.php index fef784784..a7571ebbb 100644 --- a/lib/BillingPortal/Session.php +++ b/lib/BillingPortal/Session.php @@ -25,7 +25,7 @@ * @property string|\Stripe\BillingPortal\Configuration $configuration The configuration used by this session, describing the features available. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property string $customer The ID of the customer for this session. - * @property null|object{after_completion: object{hosted_confirmation: null|object{custom_message: null|string}&\Stripe\StripeObject&\stdClass, redirect: null|object{return_url: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, subscription_cancel: null|object{retention: null|object{coupon_offer: null|object{coupon: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, subscription: string}&\Stripe\StripeObject&\stdClass, subscription_update: null|object{subscription: string}&\Stripe\StripeObject&\stdClass, subscription_update_confirm: null|object{discounts: null|(object{coupon: null|string, promotion_code: null|string}&\Stripe\StripeObject&\stdClass)[], items: (object{id: null|string, price: null|string, quantity?: int}&\Stripe\StripeObject&\stdClass)[], subscription: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $flow Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows. + * @property null|(object{after_completion: (object{hosted_confirmation: null|(object{custom_message: null|string}&\Stripe\StripeObject&\stdClass), redirect: null|(object{return_url: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), subscription_cancel: null|(object{retention: null|(object{coupon_offer: null|(object{coupon: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), subscription: string}&\Stripe\StripeObject&\stdClass), subscription_update: null|(object{subscription: string}&\Stripe\StripeObject&\stdClass), subscription_update_confirm: null|(object{discounts: null|((object{coupon: null|string, promotion_code: null|string}&\Stripe\StripeObject&\stdClass))[], items: ((object{id: null|string, price: null|string, quantity?: int}&\Stripe\StripeObject&\stdClass))[], subscription: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $flow Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows. * @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 null|string $locale The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used. * @property null|string $on_behalf_of The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays. diff --git a/lib/Capability.php b/lib/Capability.php index 3c94d021a..4f62c8ee4 100644 --- a/lib/Capability.php +++ b/lib/Capability.php @@ -12,10 +12,10 @@ * @property string $id The identifier for the capability. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property string|\Stripe\Account $account The account for which the capability enables functionality. - * @property object{alternatives: null|object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass[], current_deadline: null|int, currently_due: string[], disabled_reason: null|string, errors: object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass $future_requirements + * @property (object{alternatives: null|(object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass)[], current_deadline: null|int, currently_due: string[], disabled_reason: null|string, errors: (object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass) $future_requirements * @property bool $requested Whether the capability has been requested. * @property null|int $requested_at Time at which the capability was requested. Measured in seconds since the Unix epoch. - * @property object{alternatives: null|object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass[], current_deadline: null|int, currently_due: string[], disabled_reason: null|string, errors: object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass $requirements + * @property (object{alternatives: null|(object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass)[], current_deadline: null|int, currently_due: string[], disabled_reason: null|string, errors: (object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass) $requirements * @property string $status The status of the capability. */ class Capability extends ApiResource diff --git a/lib/Capital/FinancingOffer.php b/lib/Capital/FinancingOffer.php index b8f03d92a..e83e86446 100644 --- a/lib/Capital/FinancingOffer.php +++ b/lib/Capital/FinancingOffer.php @@ -10,7 +10,7 @@ * * @property string $id A unique identifier for the financing object. * @property string $object The object type: financing_offer. - * @property object{advance_amount: int, currency: string, fee_amount: int, previous_financing_fee_discount_amount: null|int, withhold_rate: float}&\Stripe\StripeObject&\stdClass $accepted_terms This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents the terms accepted by the Connected account, which may differ from those offered. + * @property (object{advance_amount: int, currency: string, fee_amount: int, previous_financing_fee_discount_amount: null|int, withhold_rate: float}&\Stripe\StripeObject&\stdClass) $accepted_terms This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents the terms accepted by the Connected account, which may differ from those offered. * @property string $account The ID of the merchant associated with this financing object. * @property null|int $charged_off_at The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch. * @property int $created Time at which the offer was created. Given in seconds since unix epoch. @@ -18,7 +18,7 @@ * @property null|string $financing_type The type of financing being offered. * @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 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 object{advance_amount: int, campaign_type: string, currency: string, fee_amount: int, previous_financing_fee_discount_rate: null|float, withhold_rate: float}&\Stripe\StripeObject&\stdClass $offered_terms This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents both the terms offered to the Connected account. + * @property (object{advance_amount: int, campaign_type: string, currency: string, fee_amount: int, previous_financing_fee_discount_rate: null|float, withhold_rate: float}&\Stripe\StripeObject&\stdClass) $offered_terms This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents both the terms offered to the Connected account. * @property null|string $product_type Financing product identifier. * @property null|string $replacement The ID of the financing offer that replaced this offer. * @property null|string $replacement_for The ID of the financing offer that this offer is a replacement for. diff --git a/lib/Capital/FinancingSummary.php b/lib/Capital/FinancingSummary.php index e7a3547bc..5e930dfc5 100644 --- a/lib/Capital/FinancingSummary.php +++ b/lib/Capital/FinancingSummary.php @@ -9,7 +9,7 @@ * platforms to read the state of Capital offered to their connected accounts. * * @property string $object The object type: financing_summary - * @property null|object{advance_amount: int, advance_paid_out_at: null|float, currency: string, current_repayment_interval: null|object{due_at: float, paid_amount: null|int, remaining_amount: int}&\Stripe\StripeObject&\stdClass, fee_amount: int, paid_amount: int, remaining_amount: int, repayments_begin_at: null|float, withhold_rate: float}&\Stripe\StripeObject&\stdClass $details Additional information about the financing summary. Describes currency, advance amount, fee amount, withhold rate, remaining amount, paid amount, current repayment interval, repayment start date, and advance payout date. + * @property null|(object{advance_amount: int, advance_paid_out_at: null|float, currency: string, current_repayment_interval: null|(object{due_at: float, paid_amount: null|int, remaining_amount: int}&\Stripe\StripeObject&\stdClass), fee_amount: int, paid_amount: int, remaining_amount: int, repayments_begin_at: null|float, withhold_rate: float}&\Stripe\StripeObject&\stdClass) $details Additional information about the financing summary. Describes currency, advance amount, fee amount, withhold rate, remaining amount, paid amount, current repayment interval, repayment start date, and advance payout date. * @property null|string $financing_offer The Financing Offer ID this Financing Summary corresponds to * @property null|string $status Status of the Connected Account's financing. /v1/capital/financing_summary will only return details for paid_out financing. */ diff --git a/lib/Capital/FinancingTransaction.php b/lib/Capital/FinancingTransaction.php index 46d9088f5..3fe6a2141 100644 --- a/lib/Capital/FinancingTransaction.php +++ b/lib/Capital/FinancingTransaction.php @@ -11,7 +11,7 @@ * @property string $object The object type: financing_transaction * @property string $account The ID of the merchant associated with this financing transaction. * @property int $created_at Time at which the financing transaction was created. Given in seconds since unix epoch. - * @property object{advance_amount: int, currency: string, fee_amount: int, linked_payment?: string, reason?: string, reversed_transaction?: string, total_amount: int, transaction?: object{charge?: string, treasury_transaction?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $details This is an object representing a transaction on a Capital financing offer. + * @property (object{advance_amount: int, currency: string, fee_amount: int, linked_payment?: string, reason?: string, reversed_transaction?: string, total_amount: int, transaction?: (object{charge?: string, treasury_transaction?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $details This is an object representing a transaction on a Capital financing offer. * @property null|string $financing_offer The Capital financing offer for this financing transaction. * @property null|string $legacy_balance_transaction_source The Capital transaction object that predates the Financing Transactions API and corresponds with the balance transaction that was created as a result of this financing transaction. * @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. diff --git a/lib/Card.php b/lib/Card.php index 6fb067c16..bf2bdff70 100644 --- a/lib/Card.php +++ b/lib/Card.php @@ -35,9 +35,9 @@ * @property null|string $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. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.

* @property string $funding Card funding type. Can be credit, debit, prepaid, or unknown. * @property string $last4 The last four digits of the card. - * @property null|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|\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 Cardholder name. - * @property object{preferred: null|string}&\Stripe\StripeObject&\stdClass $networks + * @property (object{preferred: null|string}&\Stripe\StripeObject&\stdClass) $networks * @property null|string $status For external accounts that are cards, possible values are new and errored. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated. * @property null|string $tokenization_method If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null. */ @@ -48,7 +48,7 @@ class Card extends ApiResource /** * Delete a specified external account for a given account. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/CashBalance.php b/lib/CashBalance.php index bba8c8c13..a8adfab93 100644 --- a/lib/CashBalance.php +++ b/lib/CashBalance.php @@ -8,10 +8,10 @@ * A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property null|StripeObject $available A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit. + * @property null|\Stripe\StripeObject $available A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit. * @property string $customer The ID of the customer whose cash balance this object represents. * @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 object{reconciliation_mode: string, using_merchant_default: bool}&\Stripe\StripeObject&\stdClass $settings + * @property (object{reconciliation_mode: string, using_merchant_default: bool}&\Stripe\StripeObject&\stdClass) $settings */ class CashBalance extends ApiResource { diff --git a/lib/Charge.php b/lib/Charge.php index 2ef11bd70..caee6aa59 100644 --- a/lib/Charge.php +++ b/lib/Charge.php @@ -20,7 +20,7 @@ * @property null|int $application_fee_amount The amount of the application fee (if any) requested for the charge. See the Connect documentation for details. * @property null|string $authorization_code Authorization code on the charge. * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). - * @property object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $billing_details + * @property (object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $billing_details * @property null|string $calculated_statement_descriptor The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. * @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. @@ -31,32 +31,32 @@ * @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. * @property null|string $failure_code Error code explaining reason for charge failure if available (see the errors section for a list of codes). * @property null|string $failure_message Message to user further explaining reason for charge failure if available. - * @property null|object{stripe_report?: string, user_report?: string}&\Stripe\StripeObject&\stdClass $fraud_details Information on fraud assessments for the charge. + * @property null|(object{stripe_report?: string, user_report?: string}&\Stripe\StripeObject&\stdClass) $fraud_details Information on fraud assessments for the charge. * @property null|string|\Stripe\Invoice $invoice ID of the invoice this charge is for if one exists. - * @property object{customer_reference?: string, line_items: (object{discount_amount: null|int, product_code: string, product_description: string, quantity: null|int, tax_amount: null|int, unit_cost: null|int}&\Stripe\StripeObject&\stdClass)[], merchant_reference: string, shipping_address_zip?: string, shipping_amount?: int, shipping_from_zip?: string}&\Stripe\StripeObject&\stdClass $level3 + * @property (object{customer_reference?: string, line_items: ((object{discount_amount: null|int, product_code: string, product_description: string, quantity: null|int, tax_amount: null|int, unit_cost: null|int}&\Stripe\StripeObject&\stdClass))[], merchant_reference: string, shipping_address_zip?: string, shipping_amount?: int, shipping_from_zip?: string}&\Stripe\StripeObject&\stdClass) $level3 * @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 null|string|\Stripe\Account $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 null|object{network_advice_code: null|string, network_decline_code: null|string, network_status: null|string, reason: null|string, risk_level?: string, risk_score?: int, rule?: string|object{action: string, id: string, predicate: string}&\Stripe\StripeObject&\stdClass, seller_message: null|string, type: string}&\Stripe\StripeObject&\stdClass $outcome Details about whether the payment was accepted, and why. See understanding declines for details. + * @property null|(object{network_advice_code: null|string, network_decline_code: null|string, network_status: null|string, reason: null|string, risk_level?: string, risk_score?: int, rule?: string|(object{action: string, id: string, predicate: string}&\Stripe\StripeObject&\stdClass), seller_message: null|string, type: string}&\Stripe\StripeObject&\stdClass) $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 null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent associated with this charge, if one exists. * @property null|string $payment_method ID of the payment method used in this charge. - * @property null|object{ach_credit_transfer?: object{account_number: null|string, bank_name: null|string, routing_number: null|string, swift_code: null|string}&\Stripe\StripeObject&\stdClass, ach_debit?: object{account_holder_type: null|string, bank_name: null|string, country: null|string, fingerprint: null|string, last4: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass, acss_debit?: object{bank_name: null|string, fingerprint: null|string, institution_number: null|string, last4: null|string, mandate?: string, transit_number: null|string}&\Stripe\StripeObject&\stdClass, affirm?: object{transaction_id: null|string}&\Stripe\StripeObject&\stdClass, afterpay_clearpay?: object{order_id: null|string, reference: null|string}&\Stripe\StripeObject&\stdClass, alipay?: object{buyer_id?: string, fingerprint: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass, alma?: object{}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{funding?: object{card?: object{brand: null|string, country: null|string, exp_month: null|int, exp_year: null|int, funding: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass, type: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, au_becs_debit?: object{bsb_number: null|string, fingerprint: null|string, last4: null|string, mandate?: string}&\Stripe\StripeObject&\stdClass, bacs_debit?: object{fingerprint: null|string, last4: null|string, mandate: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass, bancontact?: object{bank_code: null|string, bank_name: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, blik?: object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass, boleto?: object{tax_id: string}&\Stripe\StripeObject&\stdClass, card?: object{amount_authorized: null|int, amount_requested?: null|int, authorization_code: null|string, brand: null|string, capture_before?: int, checks: null|object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass, country: null|string, decremental_authorization?: object{status: string}&\Stripe\StripeObject&\stdClass, description?: null|string, exp_month: int, exp_year: int, extended_authorization?: object{status: string}&\Stripe\StripeObject&\stdClass, fingerprint?: null|string, funding: null|string, iin?: null|string, incremental_authorization?: object{status: string}&\Stripe\StripeObject&\stdClass, installments: null|object{plan: null|object{count: null|int, interval: null|string, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, issuer?: null|string, last4: null|string, mandate: null|string, moto?: null|bool, multicapture?: object{status: string}&\Stripe\StripeObject&\stdClass, network: null|string, network_token?: null|object{used: bool}&\Stripe\StripeObject&\stdClass, overcapture?: object{maximum_amount_capturable: int, status: string}&\Stripe\StripeObject&\stdClass, partial_authorization?: object{status: string}&\Stripe\StripeObject&\stdClass, three_d_secure: null|object{authentication_flow: null|string, electronic_commerce_indicator: null|string, exemption_indicator: null|string, exemption_indicator_applied?: bool, result: null|string, result_reason: null|string, transaction_id: null|string, version: null|string}&\Stripe\StripeObject&\stdClass, wallet: null|object{amex_express_checkout?: object{}&\Stripe\StripeObject&\stdClass, apple_pay?: object{}&\Stripe\StripeObject&\stdClass, dynamic_last4: null|string, google_pay?: object{}&\Stripe\StripeObject&\stdClass, link?: object{}&\Stripe\StripeObject&\stdClass, masterpass?: object{billing_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, samsung_pay?: object{}&\Stripe\StripeObject&\stdClass, type: string, visa_checkout?: object{billing_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, card_present?: object{amount_authorized: null|int, brand: null|string, brand_product: null|string, capture_before?: int, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, incremental_authorization_supported: bool, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, offline: null|object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass, overcapture_supported: bool, preferred_locales: null|string[], read_method: null|string, receipt: null|object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass, wallet?: object{type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, cashapp?: object{buyer_id: null|string, cashtag: null|string}&\Stripe\StripeObject&\stdClass, customer_balance?: object{}&\Stripe\StripeObject&\stdClass, eps?: object{bank: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, fpx?: object{account_holder_type: null|string, bank: string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass, giropay?: object{bank_code: null|string, bank_name: null|string, bic: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, gopay?: object{}&\Stripe\StripeObject&\stdClass, grabpay?: object{transaction_id: null|string}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: object{account_number: string, bank: string, bank_code?: string, bank_name?: string, display_name?: string}&\Stripe\StripeObject&\stdClass, ideal?: object{bank: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, interac_present?: object{brand: null|string, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, preferred_locales: null|string[], read_method: null|string, receipt: null|object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, kakao_pay?: object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass, klarna?: object{payer_details: null|object{address: null|object{country: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payment_method_category: null|string, preferred_locale: null|string}&\Stripe\StripeObject&\stdClass, konbini?: object{store: null|object{chain: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, kr_card?: object{brand: null|string, buyer_id: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass, link?: object{country: null|string}&\Stripe\StripeObject&\stdClass, mb_way?: object{}&\Stripe\StripeObject&\stdClass, mobilepay?: object{card: null|object{brand: null|string, country: null|string, exp_month: null|int, exp_year: null|int, last4: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, multibanco?: object{entity: null|string, reference: null|string}&\Stripe\StripeObject&\stdClass, naver_pay?: object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass, oxxo?: object{number: null|string}&\Stripe\StripeObject&\stdClass, p24?: object{bank: null|string, reference: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, payco?: object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass, paynow?: object{reference: null|string}&\Stripe\StripeObject&\stdClass, paypal?: object{payer_email: null|string, payer_id: null|string, payer_name: null|string, seller_protection: null|object{dispute_categories: null|string[], status: string}&\Stripe\StripeObject&\stdClass, shipping?: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, transaction_id: null|string, verified_address?: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, verified_email?: null|string, verified_name?: null|string}&\Stripe\StripeObject&\stdClass, payto?: object{bsb_number: null|string, last4: null|string, mandate?: string, pay_id: null|string}&\Stripe\StripeObject&\stdClass, pix?: object{bank_transaction_id?: null|string}&\Stripe\StripeObject&\stdClass, promptpay?: object{reference: null|string}&\Stripe\StripeObject&\stdClass, qris?: object{}&\Stripe\StripeObject&\stdClass, rechnung?: object{}&\Stripe\StripeObject&\stdClass, revolut_pay?: object{funding?: object{card?: object{brand: null|string, country: null|string, exp_month: null|int, exp_year: null|int, funding: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass, type: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, samsung_pay?: object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass, sepa_credit_transfer?: object{bank_name: null|string, bic: null|string, iban: null|string}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{bank_code: null|string, branch_code: null|string, country: null|string, fingerprint: null|string, last4: null|string, mandate: null|string}&\Stripe\StripeObject&\stdClass, shopeepay?: object{}&\Stripe\StripeObject&\stdClass, sofort?: object{bank_code: null|string, bank_name: null|string, bic: null|string, country: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, stripe_account?: object{}&\Stripe\StripeObject&\stdClass, swish?: object{fingerprint: null|string, payment_reference: null|string, verified_phone_last4: null|string}&\Stripe\StripeObject&\stdClass, twint?: object{}&\Stripe\StripeObject&\stdClass, type: string, us_bank_account?: object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, payment_reference: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass, wechat?: object{}&\Stripe\StripeObject&\stdClass, wechat_pay?: object{fingerprint: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass, zip?: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_details Details about the payment method at the time of the transaction. - * @property null|object{session?: string}&\Stripe\StripeObject&\stdClass $radar_options Options to configure Radar. See Radar Session for more information. + * @property null|(object{ach_credit_transfer?: (object{account_number: null|string, bank_name: null|string, routing_number: null|string, swift_code: null|string}&\Stripe\StripeObject&\stdClass), ach_debit?: (object{account_holder_type: null|string, bank_name: null|string, country: null|string, fingerprint: null|string, last4: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass), acss_debit?: (object{bank_name: null|string, fingerprint: null|string, institution_number: null|string, last4: null|string, mandate?: string, transit_number: null|string}&\Stripe\StripeObject&\stdClass), affirm?: (object{transaction_id: null|string}&\Stripe\StripeObject&\stdClass), afterpay_clearpay?: (object{order_id: null|string, reference: null|string}&\Stripe\StripeObject&\stdClass), alipay?: (object{buyer_id?: string, fingerprint: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass), alma?: (object{}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{funding?: (object{card?: (object{brand: null|string, country: null|string, exp_month: null|int, exp_year: null|int, funding: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass), type: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), au_becs_debit?: (object{bsb_number: null|string, fingerprint: null|string, last4: null|string, mandate?: string}&\Stripe\StripeObject&\stdClass), bacs_debit?: (object{fingerprint: null|string, last4: null|string, mandate: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass), bancontact?: (object{bank_code: null|string, bank_name: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), blik?: (object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass), boleto?: (object{tax_id: string}&\Stripe\StripeObject&\stdClass), card?: (object{amount_authorized: null|int, amount_requested?: null|int, authorization_code: null|string, brand: null|string, capture_before?: int, checks: null|(object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass), country: null|string, decremental_authorization?: (object{status: string}&\Stripe\StripeObject&\stdClass), description?: null|string, exp_month: int, exp_year: int, extended_authorization?: (object{status: string}&\Stripe\StripeObject&\stdClass), fingerprint?: null|string, funding: null|string, iin?: null|string, incremental_authorization?: (object{status: string}&\Stripe\StripeObject&\stdClass), installments: null|(object{plan: null|(object{count: null|int, interval: null|string, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), issuer?: null|string, last4: null|string, mandate: null|string, moto?: null|bool, multicapture?: (object{status: string}&\Stripe\StripeObject&\stdClass), network: null|string, network_token?: null|(object{used: bool}&\Stripe\StripeObject&\stdClass), overcapture?: (object{maximum_amount_capturable: int, status: string}&\Stripe\StripeObject&\stdClass), partial_authorization?: (object{status: string}&\Stripe\StripeObject&\stdClass), three_d_secure: null|(object{authentication_flow: null|string, electronic_commerce_indicator: null|string, exemption_indicator: null|string, exemption_indicator_applied?: bool, result: null|string, result_reason: null|string, transaction_id: null|string, version: null|string}&\Stripe\StripeObject&\stdClass), wallet: null|(object{amex_express_checkout?: (object{}&\Stripe\StripeObject&\stdClass), apple_pay?: (object{}&\Stripe\StripeObject&\stdClass), dynamic_last4: null|string, google_pay?: (object{}&\Stripe\StripeObject&\stdClass), link?: (object{}&\Stripe\StripeObject&\stdClass), masterpass?: (object{billing_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), samsung_pay?: (object{}&\Stripe\StripeObject&\stdClass), type: string, visa_checkout?: (object{billing_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), card_present?: (object{amount_authorized: null|int, brand: null|string, brand_product: null|string, capture_before?: int, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, incremental_authorization_supported: bool, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, offline: null|(object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass), overcapture_supported: bool, preferred_locales: null|string[], read_method: null|string, receipt: null|(object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass), wallet?: (object{type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), cashapp?: (object{buyer_id: null|string, cashtag: null|string}&\Stripe\StripeObject&\stdClass), customer_balance?: (object{}&\Stripe\StripeObject&\stdClass), eps?: (object{bank: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), fpx?: (object{account_holder_type: null|string, bank: string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass), giropay?: (object{bank_code: null|string, bank_name: null|string, bic: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), gopay?: (object{}&\Stripe\StripeObject&\stdClass), grabpay?: (object{transaction_id: null|string}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: (object{account_number: string, bank: string, bank_code?: string, bank_name?: string, display_name?: string}&\Stripe\StripeObject&\stdClass), ideal?: (object{bank: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), interac_present?: (object{brand: null|string, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, preferred_locales: null|string[], read_method: null|string, receipt: null|(object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), kakao_pay?: (object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass), klarna?: (object{payer_details: null|(object{address: null|(object{country: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payment_method_category: null|string, preferred_locale: null|string}&\Stripe\StripeObject&\stdClass), konbini?: (object{store: null|(object{chain: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), kr_card?: (object{brand: null|string, buyer_id: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass), link?: (object{country: null|string}&\Stripe\StripeObject&\stdClass), mb_way?: (object{}&\Stripe\StripeObject&\stdClass), mobilepay?: (object{card: null|(object{brand: null|string, country: null|string, exp_month: null|int, exp_year: null|int, last4: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), multibanco?: (object{entity: null|string, reference: null|string}&\Stripe\StripeObject&\stdClass), naver_pay?: (object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass), oxxo?: (object{number: null|string}&\Stripe\StripeObject&\stdClass), p24?: (object{bank: null|string, reference: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), payco?: (object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass), paynow?: (object{reference: null|string}&\Stripe\StripeObject&\stdClass), paypal?: (object{payer_email: null|string, payer_id: null|string, payer_name: null|string, seller_protection: null|(object{dispute_categories: null|string[], status: string}&\Stripe\StripeObject&\stdClass), shipping?: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), transaction_id: null|string, verified_address?: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), verified_email?: null|string, verified_name?: null|string}&\Stripe\StripeObject&\stdClass), payto?: (object{bsb_number: null|string, last4: null|string, mandate?: string, pay_id: null|string}&\Stripe\StripeObject&\stdClass), pix?: (object{bank_transaction_id?: null|string}&\Stripe\StripeObject&\stdClass), promptpay?: (object{reference: null|string}&\Stripe\StripeObject&\stdClass), qris?: (object{}&\Stripe\StripeObject&\stdClass), rechnung?: (object{}&\Stripe\StripeObject&\stdClass), revolut_pay?: (object{funding?: (object{card?: (object{brand: null|string, country: null|string, exp_month: null|int, exp_year: null|int, funding: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass), type: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), samsung_pay?: (object{buyer_id: null|string}&\Stripe\StripeObject&\stdClass), sepa_credit_transfer?: (object{bank_name: null|string, bic: null|string, iban: null|string}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{bank_code: null|string, branch_code: null|string, country: null|string, fingerprint: null|string, last4: null|string, mandate: null|string}&\Stripe\StripeObject&\stdClass), shopeepay?: (object{}&\Stripe\StripeObject&\stdClass), sofort?: (object{bank_code: null|string, bank_name: null|string, bic: null|string, country: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), stripe_account?: (object{}&\Stripe\StripeObject&\stdClass), swish?: (object{fingerprint: null|string, payment_reference: null|string, verified_phone_last4: null|string}&\Stripe\StripeObject&\stdClass), twint?: (object{}&\Stripe\StripeObject&\stdClass), type: string, us_bank_account?: (object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, payment_reference: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass), wechat?: (object{}&\Stripe\StripeObject&\stdClass), wechat_pay?: (object{fingerprint: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass), zip?: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payment_method_details Details about the payment method at the time of the transaction. + * @property null|(object{session?: string}&\Stripe\StripeObject&\stdClass) $radar_options Options to configure Radar. See Radar Session for more information. * @property null|string $receipt_email This is the email address that the receipt for this charge was sent to. * @property null|string $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 null|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 null|Collection<\Stripe\Refund> $refunds A list of refunds that have been applied to the charge. + * @property null|\Stripe\Collection<\Stripe\Refund> $refunds A list of refunds that have been applied to the charge. * @property null|string|\Stripe\Review $review ID of the review associated with this charge if one exists. - * @property null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $shipping Shipping information for the charge. + * @property null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $shipping Shipping information for the charge. * @property null|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $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 null|string|\Stripe\Transfer $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 null|string $statement_descriptor

For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

For a card charge, this value is ignored unless you don't specify a statement_descriptor_suffix, in which case this value is used as the suffix.

* @property null|string $statement_descriptor_suffix Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. * @property string $status The status of the payment is either succeeded, pending, or failed. * @property null|string|\Stripe\Transfer $transfer ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter). - * @property null|object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass $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 null|(object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass) $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 null|string $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details. */ class Charge extends ApiResource @@ -76,7 +76,7 @@ class Charge extends ApiResource * payment instead. Confirmation of the PaymentIntent creates the * Charge object used to request payment. * - * @param null|array{amount?: int, application_fee?: int, application_fee_amount?: int, capture?: bool, currency?: string, customer?: string, description?: string, destination?: array{account: string, amount?: int}, expand?: string[], metadata?: null|StripeObject, on_behalf_of?: string, radar_options?: array{session?: string}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, source?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}, transfer_group?: string} $params + * @param null|array{amount?: int, application_fee?: int, application_fee_amount?: int, capture?: bool, currency?: string, customer?: string, description?: string, destination?: array{account: string, amount?: int}, expand?: string[], metadata?: null|\Stripe\StripeObject, on_behalf_of?: string, radar_options?: array{session?: string}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, source?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}, transfer_group?: string} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -140,7 +140,7 @@ public static function retrieve($id, $opts = null) * parameters not provided will be left unchanged. * * @param string $id the ID of the resource to update - * @param null|array{customer?: string, description?: string, expand?: string[], fraud_details?: array{user_report: null|string}, metadata?: null|StripeObject, payment_details?: array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, transfer_group?: string} $params + * @param null|array{customer?: string, description?: string, expand?: string[], fraud_details?: array{user_report: null|string}, metadata?: null|\Stripe\StripeObject, payment_details?: array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, transfer_group?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Checkout/Session.php b/lib/Checkout/Session.php index ab266c71f..4cad3663e 100644 --- a/lib/Checkout/Session.php +++ b/lib/Checkout/Session.php @@ -22,60 +22,60 @@ * * @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|object{enabled: bool}&\Stripe\StripeObject&\stdClass $adaptive_pricing Settings for price localization with Adaptive Pricing. - * @property null|object{recovery: null|object{allow_promotion_codes: bool, enabled: bool, expires_at: null|int, url: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $after_expiration When set, provides configuration for actions to take if this Checkout Session expires. + * @property null|(object{enabled: bool}&\Stripe\StripeObject&\stdClass) $adaptive_pricing Settings for price localization with Adaptive Pricing. + * @property null|(object{recovery: null|(object{allow_promotion_codes: bool, enabled: bool, expires_at: null|int, url: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $after_expiration When set, provides configuration for actions to take if this Checkout Session expires. * @property null|bool $allow_promotion_codes Enables user redeemable promotion codes. * @property null|int $amount_subtotal Total of all items before discounts or taxes are applied. * @property null|int $amount_total Total of all items after discounts and taxes are applied. - * @property object{enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass, status: null|string}&\Stripe\StripeObject&\stdClass $automatic_tax + * @property (object{enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass), status: null|string}&\Stripe\StripeObject&\stdClass) $automatic_tax * @property null|string $billing_address_collection Describes whether Checkout should collect the customer's billing address. Defaults to auto. * @property null|string $cancel_url If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. * @property null|string $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 null|string $client_secret The client secret of the Session. Use this with initCheckout on your front end. - * @property null|object{business_name: null|string, email: null|string, phone: null|string, shipping_details: null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass, tax_ids: null|(object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $collected_information Information about the customer collected within the Checkout Session. - * @property null|object{promotions: null|string, terms_of_service: null|string}&\Stripe\StripeObject&\stdClass $consent Results of consent_collection for this session. - * @property null|object{payment_method_reuse_agreement: null|object{position: string}&\Stripe\StripeObject&\stdClass, promotions: null|string, terms_of_service: null|string}&\Stripe\StripeObject&\stdClass $consent_collection When set, provides configuration for the Checkout Session to gather active consent from customers. + * @property null|(object{business_name: null|string, email: null|string, phone: null|string, shipping_details: null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass), tax_ids: null|((object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $collected_information Information about the customer collected within the Checkout Session. + * @property null|(object{promotions: null|string, terms_of_service: null|string}&\Stripe\StripeObject&\stdClass) $consent Results of consent_collection for this session. + * @property null|(object{payment_method_reuse_agreement: null|(object{position: string}&\Stripe\StripeObject&\stdClass), promotions: null|string, terms_of_service: null|string}&\Stripe\StripeObject&\stdClass) $consent_collection When set, provides configuration for the Checkout Session to gather active consent from customers. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. - * @property null|object{amount_subtotal: int, amount_total: int, fx_rate: string, source_currency: string}&\Stripe\StripeObject&\stdClass $currency_conversion Currency conversion details for Adaptive Pricing sessions - * @property (object{dropdown?: object{default_value: null|string, options: object{label: string, value: string}&\Stripe\StripeObject&\stdClass[], value: null|string}&\Stripe\StripeObject&\stdClass, key: string, label: object{custom: null|string, type: string}&\Stripe\StripeObject&\stdClass, numeric?: object{default_value: null|string, maximum_length: null|int, minimum_length: null|int, value: null|string}&\Stripe\StripeObject&\stdClass, optional: bool, text?: object{default_value: null|string, maximum_length: null|int, minimum_length: null|int, value: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass)[] $custom_fields Collect additional information from your customer using custom fields. Up to 3 fields are supported. - * @property object{after_submit: null|object{message: string}&\Stripe\StripeObject&\stdClass, shipping_address: null|object{message: string}&\Stripe\StripeObject&\stdClass, submit: null|object{message: string}&\Stripe\StripeObject&\stdClass, terms_of_service_acceptance: null|object{message: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $custom_text + * @property null|(object{amount_subtotal: int, amount_total: int, fx_rate: string, source_currency: string}&\Stripe\StripeObject&\stdClass) $currency_conversion Currency conversion details for Adaptive Pricing sessions + * @property ((object{dropdown?: (object{default_value: null|string, options: (object{label: string, value: string}&\Stripe\StripeObject&\stdClass)[], value: null|string}&\Stripe\StripeObject&\stdClass), key: string, label: (object{custom: null|string, type: string}&\Stripe\StripeObject&\stdClass), numeric?: (object{default_value: null|string, maximum_length: null|int, minimum_length: null|int, value: null|string}&\Stripe\StripeObject&\stdClass), optional: bool, text?: (object{default_value: null|string, maximum_length: null|int, minimum_length: null|int, value: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass))[] $custom_fields Collect additional information from your customer using custom fields. Up to 3 fields are supported. + * @property (object{after_submit: null|(object{message: string}&\Stripe\StripeObject&\stdClass), shipping_address: null|(object{message: string}&\Stripe\StripeObject&\stdClass), submit: null|(object{message: string}&\Stripe\StripeObject&\stdClass), terms_of_service_acceptance: null|(object{message: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $custom_text * @property null|string|\Stripe\Customer $customer The ID of the customer for this Session. For Checkout Sessions in subscription mode or Checkout Sessions with customer_creation set as always in payment mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created. * @property null|string $customer_creation Configure whether a Checkout Session creates a Customer when the Checkout Session completes. - * @property null|object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string, tax_exempt: null|string, tax_ids: null|(object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $customer_details The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in setup mode. + * @property null|(object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string, tax_exempt: null|string, tax_ids: null|((object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $customer_details The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in setup mode. * @property null|string $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 the payment flow is complete, use the customer attribute. * @property int $expires_at The timestamp at which the Checkout Session will expire. * @property null|string|\Stripe\Invoice $invoice ID of the invoice created by the Checkout Session, if it exists. - * @property null|object{enabled: bool, invoice_data: object{account_tax_ids: null|(string|\Stripe\TaxId)[], custom_fields: null|object{name: string, value: string}&\Stripe\StripeObject&\stdClass[], description: null|string, footer: null|string, issuer: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass, metadata: null|StripeObject, rendering_options: null|object{amount_tax_display: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $invoice_creation Details on the state of invoice creation for the Checkout Session. + * @property null|(object{enabled: bool, invoice_data: (object{account_tax_ids: null|(string|\Stripe\TaxId)[], custom_fields: null|(object{name: string, value: string}&\Stripe\StripeObject&\stdClass)[], description: null|string, footer: null|string, issuer: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass), metadata: null|\Stripe\StripeObject, rendering_options: null|(object{amount_tax_display: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $invoice_creation Details on the state of invoice creation for the Checkout Session. * @property null|\Stripe\Collection<\Stripe\LineItem> $line_items The line items 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 null|string $locale The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used. - * @property null|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|\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 $mode The mode of the Checkout Session. * @property null|string|\Stripe\PaymentIntent $payment_intent The ID of the PaymentIntent for Checkout Sessions in payment mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, expire the Checkout Session instead. * @property null|string|\Stripe\PaymentLink $payment_link The ID of the Payment Link that created this Session. * @property null|string $payment_method_collection Configure whether a Checkout Session should collect a payment method. Defaults to always. - * @property null|object{id: string, parent: null|string}&\Stripe\StripeObject&\stdClass $payment_method_configuration_details Information about the payment method configuration used for this Checkout session if using dynamic payment methods. - * @property null|object{acss_debit?: object{currency?: string, mandate_options?: object{custom_mandate_url?: string, default_for?: string[], interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass, affirm?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, afterpay_clearpay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, alipay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, au_becs_debit?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, bacs_debit?: object{mandate_options?: object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, bancontact?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, boleto?: object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, card?: object{installments?: object{enabled?: bool}&\Stripe\StripeObject&\stdClass, request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_three_d_secure: string, setup_future_usage?: string, statement_descriptor_suffix_kana?: string, statement_descriptor_suffix_kanji?: string}&\Stripe\StripeObject&\stdClass, cashapp?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, customer_balance?: object{bank_transfer?: object{eu_bank_transfer?: object{country: string}&\Stripe\StripeObject&\stdClass, requested_address_types?: string[], type: null|string}&\Stripe\StripeObject&\stdClass, funding_type: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, eps?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, fpx?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, giropay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, grabpay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, ideal?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, kakao_pay?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, klarna?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, konbini?: object{expires_after_days: null|int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, kr_card?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, link?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, mobilepay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, multibanco?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, naver_pay?: object{capture_method?: string}&\Stripe\StripeObject&\stdClass, oxxo?: object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, p24?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, payco?: object{capture_method?: string}&\Stripe\StripeObject&\stdClass, paynow?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, paypal?: object{capture_method?: string, preferred_locale: null|string, reference: null|string, setup_future_usage?: string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass, payto?: object{mandate_options?: object{amount: null|int, amount_type: null|string, end_date: null|string, payment_schedule: null|string, payments_per_period: null|int, purpose: null|string, start_date: null|string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, pix?: object{expires_after_seconds: null|int}&\Stripe\StripeObject&\stdClass, revolut_pay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, samsung_pay?: object{capture_method?: string}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{mandate_options?: object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, sofort?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, swish?: object{reference: null|string}&\Stripe\StripeObject&\stdClass, us_bank_account?: object{financial_connections?: object{filters?: object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass, manual_entry?: object{mode?: string}&\Stripe\StripeObject&\stdClass, permissions?: string[], prefetch: null|string[], return_url?: string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_options Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. + * @property null|(object{id: string, parent: null|string}&\Stripe\StripeObject&\stdClass) $payment_method_configuration_details Information about the payment method configuration used for this Checkout session if using dynamic payment methods. + * @property null|(object{acss_debit?: (object{currency?: string, mandate_options?: (object{custom_mandate_url?: string, default_for?: string[], interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass), affirm?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), afterpay_clearpay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), alipay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), au_becs_debit?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), bacs_debit?: (object{mandate_options?: (object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), bancontact?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), boleto?: (object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), card?: (object{installments?: (object{enabled?: bool}&\Stripe\StripeObject&\stdClass), request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_three_d_secure: string, setup_future_usage?: string, statement_descriptor_suffix_kana?: string, statement_descriptor_suffix_kanji?: string}&\Stripe\StripeObject&\stdClass), cashapp?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), customer_balance?: (object{bank_transfer?: (object{eu_bank_transfer?: (object{country: string}&\Stripe\StripeObject&\stdClass), requested_address_types?: string[], type: null|string}&\Stripe\StripeObject&\stdClass), funding_type: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), eps?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), fpx?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), giropay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), grabpay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), ideal?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), kakao_pay?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), klarna?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), konbini?: (object{expires_after_days: null|int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), kr_card?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), link?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), mobilepay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), multibanco?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), naver_pay?: (object{capture_method?: string}&\Stripe\StripeObject&\stdClass), oxxo?: (object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), p24?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), payco?: (object{capture_method?: string}&\Stripe\StripeObject&\stdClass), paynow?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), paypal?: (object{capture_method?: string, preferred_locale: null|string, reference: null|string, setup_future_usage?: string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass), payto?: (object{mandate_options?: (object{amount: null|int, amount_type: null|string, end_date: null|string, payment_schedule: null|string, payments_per_period: null|int, purpose: null|string, start_date: null|string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), pix?: (object{expires_after_seconds: null|int}&\Stripe\StripeObject&\stdClass), revolut_pay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), samsung_pay?: (object{capture_method?: string}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{mandate_options?: (object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), sofort?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), swish?: (object{reference: null|string}&\Stripe\StripeObject&\stdClass), us_bank_account?: (object{financial_connections?: (object{filters?: (object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass), manual_entry?: (object{mode?: string}&\Stripe\StripeObject&\stdClass), permissions?: string[], prefetch: null|string[], return_url?: string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payment_method_options Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. * @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_status The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer's order. - * @property null|object{update: null|object{line_items?: null|string, shipping_details: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $permissions

This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.

For specific permissions, please refer to their dedicated subsections, such as permissions.update.shipping_details.

- * @property null|object{enabled: bool}&\Stripe\StripeObject&\stdClass $phone_number_collection + * @property null|(object{update: null|(object{line_items?: null|string, shipping_details: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $permissions

This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.

For specific permissions, please refer to their dedicated subsections, such as permissions.update.shipping_details.

+ * @property null|(object{enabled: bool}&\Stripe\StripeObject&\stdClass) $phone_number_collection * @property null|string $recovered_from The ID of the original expired Checkout Session that triggered the recovery flow. * @property null|string $redirect_on_completion This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always. * @property null|string $return_url Applies to Checkout Sessions with ui_mode: embedded or ui_mode: custom. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. - * @property null|object{allow_redisplay_filters: null|string[], payment_method_remove: null|string, payment_method_save: null|string}&\Stripe\StripeObject&\stdClass $saved_payment_method_options Controls saved payment method settings for the session. Only available in payment and subscription mode. + * @property null|(object{allow_redisplay_filters: null|string[], payment_method_remove: null|string, payment_method_save: null|string}&\Stripe\StripeObject&\stdClass) $saved_payment_method_options Controls saved payment method settings for the session. Only available in payment and subscription mode. * @property null|string|\Stripe\SetupIntent $setup_intent The ID of the SetupIntent for Checkout Sessions in setup mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, expire the Checkout Session instead. - * @property null|object{allowed_countries: string[]}&\Stripe\StripeObject&\stdClass $shipping_address_collection When set, provides configuration for Checkout to collect a shipping address from a customer. - * @property null|object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $shipping_cost The details of the customer cost of shipping, including the customer chosen ShippingRate. - * @property null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $shipping_details Shipping information for this Checkout Session. - * @property (object{shipping_amount: int, shipping_rate: string|\Stripe\ShippingRate}&\Stripe\StripeObject&\stdClass)[] $shipping_options The shipping rate options applied to this Session. + * @property null|(object{allowed_countries: string[]}&\Stripe\StripeObject&\stdClass) $shipping_address_collection When set, provides configuration for Checkout to collect a shipping address from a customer. + * @property null|(object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $shipping_cost The details of the customer cost of shipping, including the customer chosen ShippingRate. + * @property null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $shipping_details Shipping information for this Checkout Session. + * @property ((object{shipping_amount: int, shipping_rate: string|\Stripe\ShippingRate}&\Stripe\StripeObject&\stdClass))[] $shipping_options The shipping rate options applied to this Session. * @property null|string $status The status of the Checkout Session, one of open, complete, or expired. * @property null|string $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. If blank or auto, pay is used. * @property null|string|\Stripe\Subscription $subscription The ID of the subscription for Checkout Sessions in subscription mode. * @property null|string $success_url The URL the customer will be directed to after the payment or subscription creation is successful. - * @property null|object{enabled: bool, required: string}&\Stripe\StripeObject&\stdClass $tax_id_collection - * @property null|object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: object{discounts: object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass[], taxes: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $total_details Tax and discount details for the computed total amount. + * @property null|(object{enabled: bool, required: string}&\Stripe\StripeObject&\stdClass) $tax_id_collection + * @property null|(object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: (object{discounts: (object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass)[], taxes: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $total_details Tax and discount details for the computed total amount. * @property null|string $ui_mode The UI mode of the Session. Defaults to hosted. * @property null|string $url The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using Custom Domains, the URL will use your subdomain. Otherwise, it’ll use checkout.stripe.com. This value is only present when the session is active. */ @@ -182,7 +182,7 @@ public static function retrieve($id, $opts = null) * Updates a Session object. * * @param string $id the ID of the resource to update - * @param null|array{collected_information?: array{shipping_details?: array{address: array{city?: string, country: string, line1: string, line2?: string, postal_code?: string, state?: string}, name: string}}, expand?: string[], line_items?: (array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id?: string, metadata?: null|StripeObject, price?: string, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|StripeObject, shipping_options?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[]} $params + * @param null|array{collected_information?: array{shipping_details?: array{address: array{city?: string, country: string, line1: string, line2?: string, postal_code?: string, state?: string}, name: string}}, expand?: string[], line_items?: (array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id?: string, metadata?: null|\Stripe\StripeObject, price?: string, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|\Stripe\StripeObject, shipping_options?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[]} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Climate/Order.php b/lib/Climate/Order.php index 036bd6576..24309ff45 100644 --- a/lib/Climate/Order.php +++ b/lib/Climate/Order.php @@ -13,7 +13,7 @@ * @property int $amount_fees Total amount of Frontier's service fees in the currency's smallest unit. * @property int $amount_subtotal Total amount of the carbon removal in the currency's smallest unit. * @property int $amount_total Total amount of the order including fees in the currency's smallest unit. - * @property null|object{public_name: string}&\Stripe\StripeObject&\stdClass $beneficiary + * @property null|(object{public_name: string}&\Stripe\StripeObject&\stdClass) $beneficiary * @property null|int $canceled_at Time at which the order was canceled. Measured in seconds since the Unix epoch. * @property null|string $cancellation_reason Reason for the cancellation of this order. * @property null|string $certificate For delivered orders, a URL to a delivery certificate for the order. @@ -22,7 +22,7 @@ * @property string $currency Three-letter ISO currency code, in lowercase, representing the currency for this order. * @property null|int $delayed_at Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. * @property null|int $delivered_at Time at which the order was delivered. Measured in seconds since the Unix epoch. - * @property (object{delivered_at: int, location: null|object{city: null|string, country: string, latitude: null|float, longitude: null|float, region: null|string}&\Stripe\StripeObject&\stdClass, metric_tons: string, registry_url: null|string, supplier: \Stripe\Climate\Supplier}&\Stripe\StripeObject&\stdClass)[] $delivery_details Details about the delivery of carbon removal for this order. + * @property ((object{delivered_at: int, location: null|(object{city: null|string, country: string, latitude: null|float, longitude: null|float, region: null|string}&\Stripe\StripeObject&\stdClass), metric_tons: string, registry_url: null|string, supplier: \Stripe\Climate\Supplier}&\Stripe\StripeObject&\stdClass))[] $delivery_details Details about the delivery of carbon removal for this order. * @property int $expected_delivery_year The year this order is expected to be delivered. * @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. diff --git a/lib/Climate/Supplier.php b/lib/Climate/Supplier.php index f27c4d797..77db1585e 100644 --- a/lib/Climate/Supplier.php +++ b/lib/Climate/Supplier.php @@ -11,7 +11,7 @@ * @property string $object String representing the object’s type. Objects of the same type share the same value. * @property string $info_url Link to a webpage to learn more about the supplier. * @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 (object{city: null|string, country: string, latitude: null|float, longitude: null|float, region: null|string}&\Stripe\StripeObject&\stdClass)[] $locations The locations in which this supplier operates. + * @property ((object{city: null|string, country: string, latitude: null|float, longitude: null|float, region: null|string}&\Stripe\StripeObject&\stdClass))[] $locations The locations in which this supplier operates. * @property string $name Name of this carbon removal supplier. * @property string $removal_pathway The scientific pathway used for carbon removal. */ diff --git a/lib/ConfirmationToken.php b/lib/ConfirmationToken.php index b98dc1c41..df3d663f0 100644 --- a/lib/ConfirmationToken.php +++ b/lib/ConfirmationToken.php @@ -18,14 +18,14 @@ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|int $expires_at Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. * @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 null|object{customer_acceptance: object{online: null|object{ip_address: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $mandate_data Data used for generating a Mandate. + * @property null|(object{customer_acceptance: (object{online: null|(object{ip_address: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $mandate_data Data used for generating a Mandate. * @property null|string $payment_intent ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. - * @property null|object{card: null|object{cvc_token: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_options Payment-method-specific configuration for this ConfirmationToken. - * @property null|object{acss_debit?: object{bank_name: null|string, fingerprint: null|string, institution_number: null|string, last4: null|string, transit_number: null|string}&\Stripe\StripeObject&\stdClass, affirm?: object{}&\Stripe\StripeObject&\stdClass, afterpay_clearpay?: object{}&\Stripe\StripeObject&\stdClass, alipay?: object{}&\Stripe\StripeObject&\stdClass, allow_redisplay?: string, alma?: object{}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{}&\Stripe\StripeObject&\stdClass, au_becs_debit?: object{bsb_number: null|string, fingerprint: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass, bacs_debit?: object{fingerprint: null|string, last4: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass, bancontact?: object{}&\Stripe\StripeObject&\stdClass, billing_details: object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass, blik?: object{}&\Stripe\StripeObject&\stdClass, boleto?: object{tax_id: string}&\Stripe\StripeObject&\stdClass, card?: object{brand: string, checks: null|object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass, country: null|string, description?: null|string, display_brand: null|string, exp_month: int, exp_year: int, fingerprint?: null|string, funding: string, generated_from: null|object{charge: null|string, payment_method_details: null|object{card_present?: object{amount_authorized: null|int, brand: null|string, brand_product: null|string, capture_before?: int, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, incremental_authorization_supported: bool, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, offline: null|object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass, overcapture_supported: bool, preferred_locales: null|string[], read_method: null|string, receipt: null|object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass, wallet?: object{type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass, iin?: null|string, issuer?: null|string, last4: string, networks: null|object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass, three_d_secure_usage: null|object{supported: bool}&\Stripe\StripeObject&\stdClass, wallet: null|object{amex_express_checkout?: object{}&\Stripe\StripeObject&\stdClass, apple_pay?: object{}&\Stripe\StripeObject&\stdClass, dynamic_last4: null|string, google_pay?: object{}&\Stripe\StripeObject&\stdClass, link?: object{}&\Stripe\StripeObject&\stdClass, masterpass?: object{billing_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, samsung_pay?: object{}&\Stripe\StripeObject&\stdClass, type: string, visa_checkout?: object{billing_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, card_present?: object{brand: null|string, brand_product: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass, offline: null|object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass, preferred_locales: null|string[], read_method: null|string, wallet?: object{type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, cashapp?: object{buyer_id: null|string, cashtag: null|string}&\Stripe\StripeObject&\stdClass, customer: null|string|\Stripe\Customer, customer_balance?: object{}&\Stripe\StripeObject&\stdClass, eps?: object{bank: null|string}&\Stripe\StripeObject&\stdClass, fpx?: object{account_holder_type: null|string, bank: string}&\Stripe\StripeObject&\stdClass, giropay?: object{}&\Stripe\StripeObject&\stdClass, gopay?: object{}&\Stripe\StripeObject&\stdClass, grabpay?: object{}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: object{bank: null|string, bank_code: null|string, bank_name: null|string, display_name: null|string}&\Stripe\StripeObject&\stdClass, ideal?: object{bank: null|string, bic: null|string}&\Stripe\StripeObject&\stdClass, interac_present?: object{brand: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass, preferred_locales: null|string[], read_method: null|string}&\Stripe\StripeObject&\stdClass, kakao_pay?: object{}&\Stripe\StripeObject&\stdClass, klarna?: object{dob?: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, konbini?: object{}&\Stripe\StripeObject&\stdClass, kr_card?: object{brand: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass, link?: object{email: null|string, persistent_token?: string}&\Stripe\StripeObject&\stdClass, mb_way?: object{}&\Stripe\StripeObject&\stdClass, mobilepay?: object{}&\Stripe\StripeObject&\stdClass, multibanco?: object{}&\Stripe\StripeObject&\stdClass, naver_pay?: object{funding: string}&\Stripe\StripeObject&\stdClass, oxxo?: object{}&\Stripe\StripeObject&\stdClass, p24?: object{bank: null|string}&\Stripe\StripeObject&\stdClass, payco?: object{}&\Stripe\StripeObject&\stdClass, paynow?: object{}&\Stripe\StripeObject&\stdClass, paypal?: object{fingerprint?: null|string, payer_email: null|string, payer_id: null|string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass, payto?: object{bsb_number: null|string, last4: null|string, pay_id: null|string}&\Stripe\StripeObject&\stdClass, pix?: object{}&\Stripe\StripeObject&\stdClass, promptpay?: object{}&\Stripe\StripeObject&\stdClass, qris?: object{}&\Stripe\StripeObject&\stdClass, rechnung?: object{dob?: object{day: int, month: int, year: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, revolut_pay?: object{}&\Stripe\StripeObject&\stdClass, samsung_pay?: object{}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{bank_code: null|string, branch_code: null|string, country: null|string, fingerprint: null|string, generated_from: null|object{charge: null|string|\Stripe\Charge, setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass, last4: null|string}&\Stripe\StripeObject&\stdClass, shopeepay?: object{}&\Stripe\StripeObject&\stdClass, sofort?: object{country: null|string}&\Stripe\StripeObject&\stdClass, swish?: object{}&\Stripe\StripeObject&\stdClass, twint?: object{}&\Stripe\StripeObject&\stdClass, type: string, us_bank_account?: object{account_holder_type: null|string, account_number?: null|string, account_type: null|string, bank_name: null|string, financial_connections_account: null|string, fingerprint: null|string, last4: null|string, networks: null|object{preferred: null|string, supported: string[]}&\Stripe\StripeObject&\stdClass, routing_number: null|string, status_details: null|object{blocked?: object{network_code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, wechat_pay?: object{}&\Stripe\StripeObject&\stdClass, zip?: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_preview Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. + * @property null|(object{card: null|(object{cvc_token: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payment_method_options Payment-method-specific configuration for this ConfirmationToken. + * @property null|(object{acss_debit?: (object{bank_name: null|string, fingerprint: null|string, institution_number: null|string, last4: null|string, transit_number: null|string}&\Stripe\StripeObject&\stdClass), affirm?: (object{}&\Stripe\StripeObject&\stdClass), afterpay_clearpay?: (object{}&\Stripe\StripeObject&\stdClass), alipay?: (object{}&\Stripe\StripeObject&\stdClass), allow_redisplay?: string, alma?: (object{}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{}&\Stripe\StripeObject&\stdClass), au_becs_debit?: (object{bsb_number: null|string, fingerprint: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass), bacs_debit?: (object{fingerprint: null|string, last4: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass), bancontact?: (object{}&\Stripe\StripeObject&\stdClass), billing_details: (object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass), blik?: (object{}&\Stripe\StripeObject&\stdClass), boleto?: (object{tax_id: string}&\Stripe\StripeObject&\stdClass), card?: (object{brand: string, checks: null|(object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass), country: null|string, description?: null|string, display_brand: null|string, exp_month: int, exp_year: int, fingerprint?: null|string, funding: string, generated_from: null|(object{charge: null|string, payment_method_details: null|(object{card_present?: (object{amount_authorized: null|int, brand: null|string, brand_product: null|string, capture_before?: int, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, incremental_authorization_supported: bool, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, offline: null|(object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass), overcapture_supported: bool, preferred_locales: null|string[], read_method: null|string, receipt: null|(object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass), wallet?: (object{type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass), iin?: null|string, issuer?: null|string, last4: string, networks: null|(object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass), three_d_secure_usage: null|(object{supported: bool}&\Stripe\StripeObject&\stdClass), wallet: null|(object{amex_express_checkout?: (object{}&\Stripe\StripeObject&\stdClass), apple_pay?: (object{}&\Stripe\StripeObject&\stdClass), dynamic_last4: null|string, google_pay?: (object{}&\Stripe\StripeObject&\stdClass), link?: (object{}&\Stripe\StripeObject&\stdClass), masterpass?: (object{billing_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), samsung_pay?: (object{}&\Stripe\StripeObject&\stdClass), type: string, visa_checkout?: (object{billing_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), card_present?: (object{brand: null|string, brand_product: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|(object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass), offline: null|(object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass), preferred_locales: null|string[], read_method: null|string, wallet?: (object{type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), cashapp?: (object{buyer_id: null|string, cashtag: null|string}&\Stripe\StripeObject&\stdClass), customer: null|string|\Stripe\Customer, customer_balance?: (object{}&\Stripe\StripeObject&\stdClass), eps?: (object{bank: null|string}&\Stripe\StripeObject&\stdClass), fpx?: (object{account_holder_type: null|string, bank: string}&\Stripe\StripeObject&\stdClass), giropay?: (object{}&\Stripe\StripeObject&\stdClass), gopay?: (object{}&\Stripe\StripeObject&\stdClass), grabpay?: (object{}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: (object{bank: null|string, bank_code: null|string, bank_name: null|string, display_name: null|string}&\Stripe\StripeObject&\stdClass), ideal?: (object{bank: null|string, bic: null|string}&\Stripe\StripeObject&\stdClass), interac_present?: (object{brand: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|(object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass), preferred_locales: null|string[], read_method: null|string}&\Stripe\StripeObject&\stdClass), kakao_pay?: (object{}&\Stripe\StripeObject&\stdClass), klarna?: (object{dob?: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), konbini?: (object{}&\Stripe\StripeObject&\stdClass), kr_card?: (object{brand: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass), link?: (object{email: null|string, persistent_token?: string}&\Stripe\StripeObject&\stdClass), mb_way?: (object{}&\Stripe\StripeObject&\stdClass), mobilepay?: (object{}&\Stripe\StripeObject&\stdClass), multibanco?: (object{}&\Stripe\StripeObject&\stdClass), naver_pay?: (object{funding: string}&\Stripe\StripeObject&\stdClass), oxxo?: (object{}&\Stripe\StripeObject&\stdClass), p24?: (object{bank: null|string}&\Stripe\StripeObject&\stdClass), payco?: (object{}&\Stripe\StripeObject&\stdClass), paynow?: (object{}&\Stripe\StripeObject&\stdClass), paypal?: (object{fingerprint?: null|string, payer_email: null|string, payer_id: null|string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass), payto?: (object{bsb_number: null|string, last4: null|string, pay_id: null|string}&\Stripe\StripeObject&\stdClass), pix?: (object{}&\Stripe\StripeObject&\stdClass), promptpay?: (object{}&\Stripe\StripeObject&\stdClass), qris?: (object{}&\Stripe\StripeObject&\stdClass), rechnung?: (object{dob?: (object{day: int, month: int, year: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), revolut_pay?: (object{}&\Stripe\StripeObject&\stdClass), samsung_pay?: (object{}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{bank_code: null|string, branch_code: null|string, country: null|string, fingerprint: null|string, generated_from: null|(object{charge: null|string|\Stripe\Charge, setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass), last4: null|string}&\Stripe\StripeObject&\stdClass), shopeepay?: (object{}&\Stripe\StripeObject&\stdClass), sofort?: (object{country: null|string}&\Stripe\StripeObject&\stdClass), swish?: (object{}&\Stripe\StripeObject&\stdClass), twint?: (object{}&\Stripe\StripeObject&\stdClass), type: string, us_bank_account?: (object{account_holder_type: null|string, account_number?: null|string, account_type: null|string, bank_name: null|string, financial_connections_account: null|string, fingerprint: null|string, last4: null|string, networks: null|(object{preferred: null|string, supported: string[]}&\Stripe\StripeObject&\stdClass), routing_number: null|string, status_details: null|(object{blocked?: (object{network_code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), wechat_pay?: (object{}&\Stripe\StripeObject&\stdClass), zip?: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payment_method_preview Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. * @property null|string $return_url Return URL used to confirm the Intent. * @property null|string $setup_future_usage

Indicates that you intend to make future payments with this ConfirmationToken's payment method.

The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.

* @property null|string $setup_intent ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. - * @property null|object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, name: string, phone: null|string}&\Stripe\StripeObject&\stdClass $shipping Shipping information collected on this ConfirmationToken. + * @property null|(object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), name: string, phone: null|string}&\Stripe\StripeObject&\stdClass) $shipping Shipping information collected on this ConfirmationToken. * @property bool $use_stripe_sdk Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to true on ConfirmationToken. */ class ConfirmationToken extends ApiResource diff --git a/lib/CountrySpec.php b/lib/CountrySpec.php index 341cd7669..343bd3ad9 100644 --- a/lib/CountrySpec.php +++ b/lib/CountrySpec.php @@ -19,7 +19,7 @@ * @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. The stripe payment method refers to charging through your platform. * @property string[] $supported_transfer_countries Countries that can accept transfers from the specified country. - * @property object{company: object{additional: string[], minimum: string[]}&\Stripe\StripeObject&\stdClass, individual: object{additional: string[], minimum: string[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $verification_fields + * @property (object{company: (object{additional: string[], minimum: string[]}&\Stripe\StripeObject&\stdClass), individual: (object{additional: string[], minimum: string[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $verification_fields */ class CountrySpec extends ApiResource { diff --git a/lib/Coupon.php b/lib/Coupon.php index f093c150e..b2b9b54f4 100644 --- a/lib/Coupon.php +++ b/lib/Coupon.php @@ -12,7 +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|int $amount_off Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. - * @property null|object{products: string[]}&\Stripe\StripeObject&\stdClass $applies_to + * @property null|(object{products: string[]}&\Stripe\StripeObject&\stdClass) $applies_to * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $currency If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. * @property null|\Stripe\StripeObject $currency_options Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency. @@ -20,7 +20,7 @@ * @property null|int $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 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|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|\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 $ (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. @@ -54,7 +54,7 @@ class Coupon extends ApiResource * a coupon with an amount_off of 200 is applied to * it. * - * @param null|array{amount_off?: int, applies_to?: array{products?: string[]}, currency?: string, currency_options?: \Stripe\StripeObject, duration?: string, duration_in_months?: int, expand?: string[], id?: string, max_redemptions?: int, metadata?: null|StripeObject, name?: string, percent_off?: float, redeem_by?: int} $params + * @param null|array{amount_off?: int, applies_to?: array{products?: string[]}, currency?: string, currency_options?: \Stripe\StripeObject, duration?: string, duration_in_months?: int, expand?: string[], id?: string, max_redemptions?: int, metadata?: null|\Stripe\StripeObject, name?: string, percent_off?: float, redeem_by?: int} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -80,7 +80,7 @@ public static function create($params = null, $options = null) * have already applied the coupon; it means that new customers can’t redeem the * coupon. You can also delete coupons via the API. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -139,7 +139,7 @@ public static function retrieve($id, $opts = null) * amount_off) are, by design, not editable. * * @param string $id the ID of the resource to update - * @param null|array{currency_options?: \Stripe\StripeObject, expand?: string[], metadata?: null|StripeObject, name?: string} $params + * @param null|array{currency_options?: \Stripe\StripeObject, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/CreditNote.php b/lib/CreditNote.php index 7f0b126e0..d719da884 100644 --- a/lib/CreditNote.php +++ b/lib/CreditNote.php @@ -18,27 +18,27 @@ * @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 cents (or local equivalent) representing the total amount of discount that was credited. - * @property (object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass)[] $discount_amounts The aggregate amounts calculated per discount for all line items. + * @property ((object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass))[] $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. * @property \Stripe\Collection<\Stripe\CreditNoteLineItem> $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 null|string $memo Customer-facing text that appears on the credit note PDF. - * @property null|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|\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 null|int $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 null|int $post_payment_amount * @property null|int $pre_payment_amount - * @property null|(object{amount: int, credit_balance_transaction?: string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, type: string}&\Stripe\StripeObject&\stdClass)[] $pretax_credit_amounts The pretax credit amounts (ex: discount, credit grants, etc) for all line items. + * @property null|((object{amount: int, credit_balance_transaction?: string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, type: string}&\Stripe\StripeObject&\stdClass))[] $pretax_credit_amounts The pretax credit amounts (ex: discount, credit grants, etc) for all line items. * @property null|string $reason Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory * @property null|string|\Stripe\Refund $refund Refund related to this credit note. - * @property null|(object{amount_refunded: int, refund: string|\Stripe\Refund}&\Stripe\StripeObject&\stdClass)[] $refunds Refunds related to this credit note. - * @property null|object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $shipping_cost The details of the cost of shipping, including the ShippingRate applied to the invoice. + * @property null|((object{amount_refunded: int, refund: string|\Stripe\Refund}&\Stripe\StripeObject&\stdClass))[] $refunds Refunds related to this credit note. + * @property null|(object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $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 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 (object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[] $tax_amounts The aggregate amounts calculated per tax rate for all line items. + * @property ((object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[] $tax_amounts The aggregate amounts calculated per tax rate for all line items. * @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. diff --git a/lib/CreditNoteLineItem.php b/lib/CreditNoteLineItem.php index 818a3856a..e47edff8c 100644 --- a/lib/CreditNoteLineItem.php +++ b/lib/CreditNoteLineItem.php @@ -13,12 +13,12 @@ * @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 cents (or local equivalent) representing the discount being credited for this line item. - * @property (object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass)[] $discount_amounts The amount of discount calculated per discount for this line item + * @property ((object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass))[] $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. - * @property null|(object{amount: int, credit_balance_transaction?: string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, type: string}&\Stripe\StripeObject&\stdClass)[] $pretax_credit_amounts The pretax credit amounts (ex: discount, credit grants, etc) for this line item. + * @property null|((object{amount: int, credit_balance_transaction?: string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, type: string}&\Stripe\StripeObject&\stdClass))[] $pretax_credit_amounts The pretax credit amounts (ex: discount, credit grants, etc) for this line item. * @property null|int $quantity The number of units of product being credited. - * @property (object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[] $tax_amounts The amount of tax calculated per tax rate for this line item + * @property ((object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[] $tax_amounts The amount of tax calculated per tax rate for this line item * @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item. * @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. diff --git a/lib/Customer.php b/lib/Customer.php index 548e93514..513ef9b6d 100644 --- a/lib/Customer.php +++ b/lib/Customer.php @@ -10,7 +10,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|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass $address The customer's address. + * @property null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass) $address The customer's address. * @property null|int $balance The current balance, if any, that's 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's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. * @property null|\Stripe\CashBalance $cash_balance The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The settings[reconciliation_mode] field describes if these funds apply to these payment intents manually or automatically. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. @@ -22,17 +22,17 @@ * @property null|string $email The customer's email address. * @property null|\Stripe\StripeObject $invoice_credit_balance The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. * @property null|string $invoice_prefix The prefix for the customer used to generate unique invoice numbers. - * @property object{custom_fields: null|object{name: string, value: string}&\Stripe\StripeObject&\stdClass[], default_payment_method: null|string|\Stripe\PaymentMethod, footer: null|string, rendering_options: null|object{amount_tax_display: null|string, template: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $invoice_settings + * @property (object{custom_fields: null|(object{name: string, value: string}&\Stripe\StripeObject&\stdClass)[], default_payment_method: null|string|\Stripe\PaymentMethod, footer: null|string, rendering_options: null|(object{amount_tax_display: null|string, template: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $invoice_settings * @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 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 The customer's full name or business name. * @property null|int $next_invoice_sequence The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. * @property null|string $phone The customer's phone number. * @property null|string[] $preferred_locales The customer's preferred locales (languages), ordered by preference. - * @property null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $shipping Mailing and shipping address for the customer. Appears on invoices emailed to this customer. + * @property null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $shipping Mailing and shipping address for the customer. Appears on invoices emailed to this customer. * @property null|\Stripe\Collection<\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source> $sources The customer's payment sources, if any. * @property null|\Stripe\Collection<\Stripe\Subscription> $subscriptions The customer's current subscriptions, if any. - * @property object{automatic_tax: string, ip_address: null|string, location: null|object{country: string, source: string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $tax + * @property (object{automatic_tax: string, ip_address: null|string, location: null|(object{country: string, source: string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $tax * @property null|string $tax_exempt Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge". * @property null|\Stripe\Collection<\Stripe\TaxId> $tax_ids The customer's tax IDs. * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock that this customer belongs to. @@ -51,7 +51,7 @@ class Customer extends ApiResource /** * Creates a new customer object. * - * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|StripeObject, name?: string, next_invoice_sequence?: int, payment_method?: string, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, tax_id_data?: array{type: string, value: string}[], test_clock?: string, validate?: bool} $params + * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|\Stripe\StripeObject, name?: string, next_invoice_sequence?: int, payment_method?: string, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, tax_id_data?: array{type: string, value: string}[], test_clock?: string, validate?: bool} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -74,7 +74,7 @@ public static function create($params = null, $options = null) * Permanently deletes a customer. It cannot be undone. Also immediately cancels * any active subscriptions on the customer. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -145,7 +145,7 @@ public static function retrieve($id, $opts = null) * This request accepts mostly the same arguments as the customer creation call. * * @param string $id the ID of the resource to update - * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, default_source?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|StripeObject, name?: string, next_invoice_sequence?: int, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, validate?: bool} $params + * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, default_source?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|\Stripe\StripeObject, name?: string, next_invoice_sequence?: int, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, validate?: bool} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/CustomerBalanceTransaction.php b/lib/CustomerBalanceTransaction.php index a2393ae6d..37473d9f3 100644 --- a/lib/CustomerBalanceTransaction.php +++ b/lib/CustomerBalanceTransaction.php @@ -23,7 +23,7 @@ * @property int $ending_balance The customer's balance after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. * @property null|string|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction. * @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 null|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|\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 Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, or unapplied_from_invoice. See the Customer Balance page to learn more about transaction types. */ class CustomerBalanceTransaction extends ApiResource diff --git a/lib/CustomerCashBalanceTransaction.php b/lib/CustomerCashBalanceTransaction.php index 06527a9a5..e382d221f 100644 --- a/lib/CustomerCashBalanceTransaction.php +++ b/lib/CustomerCashBalanceTransaction.php @@ -12,19 +12,19 @@ * * @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|object{balance_transaction: string|\Stripe\BalanceTransaction, linked_transaction: string|\Stripe\CustomerCashBalanceTransaction}&\Stripe\StripeObject&\stdClass $adjusted_for_overdraft - * @property null|object{payment_intent: string|\Stripe\PaymentIntent}&\Stripe\StripeObject&\stdClass $applied_to_payment + * @property null|(object{balance_transaction: string|\Stripe\BalanceTransaction, linked_transaction: string|\Stripe\CustomerCashBalanceTransaction}&\Stripe\StripeObject&\stdClass) $adjusted_for_overdraft + * @property null|(object{payment_intent: string|\Stripe\PaymentIntent}&\Stripe\StripeObject&\stdClass) $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. * @property string|\Stripe\Customer $customer The customer whose available cash balance changed as a result of this transaction. * @property int $ending_balance The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit. - * @property object{bank_transfer: object{eu_bank_transfer?: object{bic: null|string, iban_last4: null|string, sender_name: null|string}&\Stripe\StripeObject&\stdClass, gb_bank_transfer?: object{account_number_last4: null|string, sender_name: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass, jp_bank_transfer?: object{sender_bank: null|string, sender_branch: null|string, sender_name: null|string}&\Stripe\StripeObject&\stdClass, reference: null|string, type: string, us_bank_transfer?: object{network?: string, sender_name: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $funded + * @property (object{bank_transfer: (object{eu_bank_transfer?: (object{bic: null|string, iban_last4: null|string, sender_name: null|string}&\Stripe\StripeObject&\stdClass), gb_bank_transfer?: (object{account_number_last4: null|string, sender_name: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass), jp_bank_transfer?: (object{sender_bank: null|string, sender_branch: null|string, sender_name: null|string}&\Stripe\StripeObject&\stdClass), reference: null|string, type: string, us_bank_transfer?: (object{network?: string, sender_name: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $funded * @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 $net_amount The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. - * @property null|object{refund: string|\Stripe\Refund}&\Stripe\StripeObject&\stdClass $refunded_from_payment - * @property null|object{balance_transaction: string|\Stripe\BalanceTransaction}&\Stripe\StripeObject&\stdClass $transferred_to_balance + * @property null|(object{refund: string|\Stripe\Refund}&\Stripe\StripeObject&\stdClass) $refunded_from_payment + * @property null|(object{balance_transaction: string|\Stripe\BalanceTransaction}&\Stripe\StripeObject&\stdClass) $transferred_to_balance * @property string $type The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types. - * @property null|object{payment_intent: string|\Stripe\PaymentIntent}&\Stripe\StripeObject&\stdClass $unapplied_from_payment + * @property null|(object{payment_intent: string|\Stripe\PaymentIntent}&\Stripe\StripeObject&\stdClass) $unapplied_from_payment */ class CustomerCashBalanceTransaction extends ApiResource { diff --git a/lib/CustomerSession.php b/lib/CustomerSession.php index 475e3058b..9ce5ac80a 100644 --- a/lib/CustomerSession.php +++ b/lib/CustomerSession.php @@ -14,7 +14,7 @@ * * @property string $object String representing the object's type. Objects of the same type share the same value. * @property string $client_secret

The client secret of this Customer Session. Used on the client to set up secure access to the given customer.

The client secret can be used to provide access to customer from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.

- * @property object{buy_button: object{enabled: bool}&\Stripe\StripeObject&\stdClass, payment_element: object{enabled: bool, features: null|object{payment_method_allow_redisplay_filters: string[], payment_method_redisplay: string, payment_method_redisplay_limit: null|int, payment_method_remove: string, payment_method_save: string, payment_method_save_usage: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, pricing_table: object{enabled: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $components Configuration for the components supported by this Customer Session. + * @property (object{buy_button: (object{enabled: bool}&\Stripe\StripeObject&\stdClass), payment_element: (object{enabled: bool, features: null|(object{payment_method_allow_redisplay_filters: string[], payment_method_redisplay: string, payment_method_redisplay_limit: null|int, payment_method_remove: string, payment_method_save: string, payment_method_save_usage: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), pricing_table: (object{enabled: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $components Configuration for the components supported by this Customer Session. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property string|\Stripe\Customer $customer The Customer the Customer Session was created for. * @property int $expires_at The timestamp at which this Customer Session will expire. diff --git a/lib/Dispute.php b/lib/Dispute.php index f822633b9..586d4c2e9 100644 --- a/lib/Dispute.php +++ b/lib/Dispute.php @@ -19,14 +19,14 @@ * @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[] $enhanced_eligibility_types List of eligibility types that are included in enhanced_evidence. - * @property object{access_activity_log: null|string, billing_address: null|string, cancellation_policy: null|string|\Stripe\File, cancellation_policy_disclosure: null|string, cancellation_rebuttal: null|string, customer_communication: null|string|\Stripe\File, customer_email_address: null|string, customer_name: null|string, customer_purchase_ip: null|string, customer_signature: null|string|\Stripe\File, duplicate_charge_documentation: null|string|\Stripe\File, duplicate_charge_explanation: null|string, duplicate_charge_id: null|string, enhanced_evidence: object{visa_compelling_evidence_3?: object{disputed_transaction: null|object{customer_account_id: null|string, customer_device_fingerprint: null|string, customer_device_id: null|string, customer_email_address: null|string, customer_purchase_ip: null|string, merchandise_or_services: null|string, product_description: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, prior_undisputed_transactions: (object{charge: string, customer_account_id: null|string, customer_device_fingerprint: null|string, customer_device_id: null|string, customer_email_address: null|string, customer_purchase_ip: null|string, product_description: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, product_description: null|string, receipt: null|string|\Stripe\File, refund_policy: null|string|\Stripe\File, refund_policy_disclosure: null|string, refund_refusal_explanation: null|string, service_date: null|string, service_documentation: null|string|\Stripe\File, shipping_address: null|string, shipping_carrier: null|string, shipping_date: null|string, shipping_documentation: null|string|\Stripe\File, shipping_tracking_number: null|string, uncategorized_file: null|string|\Stripe\File, uncategorized_text: null|string}&\Stripe\StripeObject&\stdClass $evidence - * @property object{due_by: null|int, enhanced_eligibility: object{visa_compelling_evidence_3?: object{required_actions: string[], status: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, has_evidence: bool, past_due: bool, submission_count: int}&\Stripe\StripeObject&\stdClass $evidence_details + * @property (object{access_activity_log: null|string, billing_address: null|string, cancellation_policy: null|string|\Stripe\File, cancellation_policy_disclosure: null|string, cancellation_rebuttal: null|string, customer_communication: null|string|\Stripe\File, customer_email_address: null|string, customer_name: null|string, customer_purchase_ip: null|string, customer_signature: null|string|\Stripe\File, duplicate_charge_documentation: null|string|\Stripe\File, duplicate_charge_explanation: null|string, duplicate_charge_id: null|string, enhanced_evidence: (object{visa_compelling_evidence_3?: (object{disputed_transaction: null|(object{customer_account_id: null|string, customer_device_fingerprint: null|string, customer_device_id: null|string, customer_email_address: null|string, customer_purchase_ip: null|string, merchandise_or_services: null|string, product_description: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), prior_undisputed_transactions: ((object{charge: string, customer_account_id: null|string, customer_device_fingerprint: null|string, customer_device_id: null|string, customer_email_address: null|string, customer_purchase_ip: null|string, product_description: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), product_description: null|string, receipt: null|string|\Stripe\File, refund_policy: null|string|\Stripe\File, refund_policy_disclosure: null|string, refund_refusal_explanation: null|string, service_date: null|string, service_documentation: null|string|\Stripe\File, shipping_address: null|string, shipping_carrier: null|string, shipping_date: null|string, shipping_documentation: null|string|\Stripe\File, shipping_tracking_number: null|string, uncategorized_file: null|string|\Stripe\File, uncategorized_text: null|string}&\Stripe\StripeObject&\stdClass) $evidence + * @property (object{due_by: null|int, enhanced_eligibility: (object{visa_compelling_evidence_3?: (object{required_actions: string[], status: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), has_evidence: bool, past_due: bool, submission_count: int}&\Stripe\StripeObject&\stdClass) $evidence_details * @property bool $is_charge_refundable If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are 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 null|string $network_reason_code Network-dependent reason code for the dispute. * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that's disputed. - * @property object{amazon_pay?: object{dispute_type: null|string}&\Stripe\StripeObject&\stdClass, card?: object{brand: string, case_type: string, network_reason_code: null|string}&\Stripe\StripeObject&\stdClass, klarna?: object{reason_code: null|string}&\Stripe\StripeObject&\stdClass, paypal?: object{case_id: null|string, reason_code: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $payment_method_details + * @property (object{amazon_pay?: (object{dispute_type: null|string}&\Stripe\StripeObject&\stdClass), card?: (object{brand: string, case_type: string, network_reason_code: null|string}&\Stripe\StripeObject&\stdClass), klarna?: (object{reason_code: null|string}&\Stripe\StripeObject&\stdClass), paypal?: (object{case_id: null|string, reason_code: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $payment_method_details * @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. Learn 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, won, or lost. */ @@ -107,7 +107,7 @@ public static function retrieve($id, $opts = null) * see our guide to dispute types. * * @param string $id the ID of the resource to update - * @param null|array{evidence?: array{access_activity_log?: string, billing_address?: string, cancellation_policy?: string, cancellation_policy_disclosure?: string, cancellation_rebuttal?: string, customer_communication?: string, customer_email_address?: string, customer_name?: string, customer_purchase_ip?: string, customer_signature?: string, duplicate_charge_documentation?: string, duplicate_charge_explanation?: string, duplicate_charge_id?: string, enhanced_evidence?: null|array{visa_compelling_evidence_3?: array{disputed_transaction?: array{customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, merchandise_or_services?: string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}}, prior_undisputed_transactions?: (array{charge: string, customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}})[]}}, product_description?: string, receipt?: string, refund_policy?: string, refund_policy_disclosure?: string, refund_refusal_explanation?: string, service_date?: string, service_documentation?: string, shipping_address?: string, shipping_carrier?: string, shipping_date?: string, shipping_documentation?: string, shipping_tracking_number?: string, uncategorized_file?: string, uncategorized_text?: string}, expand?: string[], metadata?: null|StripeObject, submit?: bool} $params + * @param null|array{evidence?: array{access_activity_log?: string, billing_address?: string, cancellation_policy?: string, cancellation_policy_disclosure?: string, cancellation_rebuttal?: string, customer_communication?: string, customer_email_address?: string, customer_name?: string, customer_purchase_ip?: string, customer_signature?: string, duplicate_charge_documentation?: string, duplicate_charge_explanation?: string, duplicate_charge_id?: string, enhanced_evidence?: null|array{visa_compelling_evidence_3?: array{disputed_transaction?: array{customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, merchandise_or_services?: string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}}, prior_undisputed_transactions?: (array{charge: string, customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}})[]}}, product_description?: string, receipt?: string, refund_policy?: string, refund_policy_disclosure?: string, refund_refusal_explanation?: string, service_date?: string, service_documentation?: string, shipping_address?: string, shipping_carrier?: string, shipping_date?: string, shipping_documentation?: string, shipping_tracking_number?: string, uncategorized_file?: string, uncategorized_text?: string}, expand?: string[], metadata?: null|\Stripe\StripeObject, submit?: bool} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Entitlements/Feature.php b/lib/Entitlements/Feature.php index fb3d67e6a..f7212126b 100644 --- a/lib/Entitlements/Feature.php +++ b/lib/Entitlements/Feature.php @@ -84,7 +84,7 @@ public static function retrieve($id, $opts = null) * Update a feature’s metadata or permanently deactivate it. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject, name?: string} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Event.php b/lib/Event.php index b3bd35916..9d3ff1624 100644 --- a/lib/Event.php +++ b/lib/Event.php @@ -44,11 +44,11 @@ * @property null|string $account The connected account that originates the event. * @property null|string $api_version The Stripe API version used to render data. 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 object{object: \Stripe\StripeObject, previous_attributes?: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass $data + * @property (object{object: \Stripe\StripeObject, previous_attributes?: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass) $data * @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 haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify. - * @property null|object{automation_action?: object{stripe_send_webhook_custom_event?: object{custom_data: null|StripeObject}&\Stripe\StripeObject&\stdClass, trigger: string, type: string}&\Stripe\StripeObject&\stdClass, request?: object{id: null|string, idempotency_key: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $reason Information about the action that causes the event. Only present when the event is triggered by an API request or an Automation action. - * @property null|object{id: null|string, idempotency_key: null|string}&\Stripe\StripeObject&\stdClass $request Information on the API request that triggers the event. + * @property null|(object{automation_action?: (object{stripe_send_webhook_custom_event?: (object{custom_data: null|\Stripe\StripeObject}&\Stripe\StripeObject&\stdClass), trigger: string, type: string}&\Stripe\StripeObject&\stdClass), request?: (object{id: null|string, idempotency_key: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $reason Information about the action that causes the event. Only present when the event is triggered by an API request or an Automation action. + * @property null|(object{id: null|string, idempotency_key: null|string}&\Stripe\StripeObject&\stdClass) $request Information on the API request that triggers the event. * @property string $type Description of the event (for example, invoice.created or charge.refunded). */ class Event extends ApiResource diff --git a/lib/EventData/V1BillingMeterErrorReportTriggeredEventData.php b/lib/EventData/V1BillingMeterErrorReportTriggeredEventData.php index dbe0dbe92..d5dbac8d3 100644 --- a/lib/EventData/V1BillingMeterErrorReportTriggeredEventData.php +++ b/lib/EventData/V1BillingMeterErrorReportTriggeredEventData.php @@ -6,7 +6,7 @@ /** * @property string $developer_message_summary Extra field included in the event's data when fetched from /v2/events. - * @property object{error_count: int, error_types: object{code: string, error_count: int, sample_errors: object{error_message: string, request: object{identifier: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass $reason This contains information about why meter error happens. + * @property (object{error_count: int, error_types: (object{code: string, error_count: int, sample_errors: (object{error_message: string, request: (object{identifier: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass) $reason This contains information about why meter error happens. * @property int $validation_end The end of the window that is encapsulated by this summary. * @property int $validation_start The start of the window that is encapsulated by this summary. */ diff --git a/lib/EventData/V1BillingMeterNoMeterFoundEventData.php b/lib/EventData/V1BillingMeterNoMeterFoundEventData.php index 12458e886..27810e89d 100644 --- a/lib/EventData/V1BillingMeterNoMeterFoundEventData.php +++ b/lib/EventData/V1BillingMeterNoMeterFoundEventData.php @@ -6,7 +6,7 @@ /** * @property string $developer_message_summary Extra field included in the event's data when fetched from /v2/events. - * @property object{error_count: int, error_types: object{code: string, error_count: int, sample_errors: object{error_message: string, request: object{identifier: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass $reason This contains information about why meter error happens. + * @property (object{error_count: int, error_types: (object{code: string, error_count: int, sample_errors: (object{error_message: string, request: (object{identifier: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass) $reason This contains information about why meter error happens. * @property int $validation_end The end of the window that is encapsulated by this summary. * @property int $validation_start The start of the window that is encapsulated by this summary. */ diff --git a/lib/File.php b/lib/File.php index 46d5451e6..66d86ea11 100644 --- a/lib/File.php +++ b/lib/File.php @@ -18,7 +18,7 @@ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|int $expires_at The file expires and isn't available at this time in epoch seconds. * @property null|string $filename The suitable name for saving the file to a filesystem. - * @property null|Collection<\Stripe\FileLink> $links A list of file links that point at this file. + * @property null|\Stripe\Collection<\Stripe\FileLink> $links A list of file links that point at this file. * @property string $purpose The purpose of the uploaded file. * @property int $size The size of the file object in bytes. * @property null|string $title A suitable title for the document. diff --git a/lib/FileLink.php b/lib/FileLink.php index c8bb20d39..8f51609ed 100644 --- a/lib/FileLink.php +++ b/lib/FileLink.php @@ -28,7 +28,7 @@ class FileLink extends ApiResource /** * Creates a new file link object. * - * @param null|array{expand?: string[], expires_at?: int, file: string, metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], expires_at?: int, file: string, metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -87,7 +87,7 @@ public static function retrieve($id, $opts = null) * Updates an existing file link object. Expired links can no longer be updated. * * @param string $id the ID of the resource to update - * @param null|array{expand?: string[], expires_at?: null|int|array, metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], expires_at?: null|int|array, metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/FinancialConnections/Account.php b/lib/FinancialConnections/Account.php index 152e05a26..6f2b42dc7 100644 --- a/lib/FinancialConnections/Account.php +++ b/lib/FinancialConnections/Account.php @@ -9,24 +9,24 @@ * * @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|object{account?: string|\Stripe\Account, customer?: string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass $account_holder The account holder that this account belongs to. - * @property null|object{as_of: int, cash?: object{available: null|StripeObject}&\Stripe\StripeObject&\stdClass, credit?: object{used: null|StripeObject}&\Stripe\StripeObject&\stdClass, current: \Stripe\StripeObject, type: string}&\Stripe\StripeObject&\stdClass $balance The most recent information about the account's balance. - * @property null|object{last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass $balance_refresh The state of the most recent attempt to refresh the account balance. + * @property null|(object{account?: string|\Stripe\Account, customer?: string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass) $account_holder The account holder that this account belongs to. + * @property null|(object{as_of: int, cash?: (object{available: null|\Stripe\StripeObject}&\Stripe\StripeObject&\stdClass), credit?: (object{used: null|\Stripe\StripeObject}&\Stripe\StripeObject&\stdClass), current: \Stripe\StripeObject, type: string}&\Stripe\StripeObject&\stdClass) $balance The most recent information about the account's balance. + * @property null|(object{last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass) $balance_refresh The state of the most recent attempt to refresh the account balance. * @property string $category The type of the account. Account category is further divided in subcategory. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $display_name A human-readable name that has been assigned to this account, either by the account holder or by the institution. - * @property null|object{last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass $inferred_balances_refresh The state of the most recent attempt to refresh the account's inferred balance history. + * @property null|(object{last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass) $inferred_balances_refresh The state of the most recent attempt to refresh the account's inferred balance history. * @property string $institution_name The name of the institution that holds this account. * @property null|string $last4 The last 4 digits of the account number. If present, this will be 4 numeric characters. * @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 null|string|\Stripe\FinancialConnections\AccountOwnership $ownership The most recent information about the account's owners. - * @property null|object{last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass $ownership_refresh The state of the most recent attempt to refresh the account owners. + * @property null|(object{last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass) $ownership_refresh The state of the most recent attempt to refresh the account owners. * @property null|string[] $permissions The list of permissions granted by this account. * @property string $status The status of the link to the account. * @property string $subcategory

If category is cash, one of:

- checking - savings - other

If category is credit, one of:

- mortgage - line_of_credit - credit_card - other

If category is investment or other, this will be other.

* @property null|string[] $subscriptions The list of data refresh subscriptions requested on this account. * @property string[] $supported_payment_method_types The PaymentMethod type(s) that can be created from this account. - * @property null|object{id: string, last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass $transaction_refresh The state of the most recent attempt to refresh the account transactions. + * @property null|(object{id: string, last_attempted_at: int, next_refresh_available_at: null|int, status: string}&\Stripe\StripeObject&\stdClass) $transaction_refresh The state of the most recent attempt to refresh the account transactions. */ class Account extends \Stripe\ApiResource { diff --git a/lib/FinancialConnections/Institution.php b/lib/FinancialConnections/Institution.php index 5781c30a6..9deb4bb9d 100644 --- a/lib/FinancialConnections/Institution.php +++ b/lib/FinancialConnections/Institution.php @@ -9,7 +9,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 object{balances: object{supported: bool}&\Stripe\StripeObject&\stdClass, ownership: object{supported: bool}&\Stripe\StripeObject&\stdClass, payment_method: object{supported: bool}&\Stripe\StripeObject&\stdClass, transactions: object{supported: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $features + * @property (object{balances: (object{supported: bool}&\Stripe\StripeObject&\stdClass), ownership: (object{supported: bool}&\Stripe\StripeObject&\stdClass), payment_method: (object{supported: bool}&\Stripe\StripeObject&\stdClass), transactions: (object{supported: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $features * @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 $name The name of this institution. * @property string[] $routing_numbers A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions. diff --git a/lib/FinancialConnections/Session.php b/lib/FinancialConnections/Session.php index 7fc29f0c8..e2240bbd9 100644 --- a/lib/FinancialConnections/Session.php +++ b/lib/FinancialConnections/Session.php @@ -9,18 +9,18 @@ * * @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|object{account?: string|\Stripe\Account, customer?: string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass $account_holder The account holder for whom accounts are collected in this session. + * @property null|(object{account?: string|\Stripe\Account, customer?: string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass) $account_holder The account holder for whom accounts are collected in this session. * @property \Stripe\Collection<\Stripe\FinancialConnections\Account> $accounts The accounts that were collected as part of this Session. * @property string $client_secret A value that will be passed to the client to launch the authentication flow. - * @property object{account_subcategories: null|string[], countries: null|string[], institution?: string}&\Stripe\StripeObject&\stdClass $filters - * @property null|object{accounts: int}&\Stripe\StripeObject&\stdClass $limits + * @property (object{account_subcategories: null|string[], countries: null|string[], institution?: string}&\Stripe\StripeObject&\stdClass) $filters + * @property null|(object{accounts: int}&\Stripe\StripeObject&\stdClass) $limits * @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 null|object{}&\Stripe\StripeObject&\stdClass $manual_entry + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $manual_entry * @property string[] $permissions Permissions requested for accounts collected during this session. * @property null|string[] $prefetch Data features requested to be retrieved upon account creation. * @property null|string $return_url For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. * @property null|string $status The current state of the session. - * @property null|object{cancelled?: object{reason: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $status_details + * @property null|(object{cancelled?: (object{reason: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $status_details */ class Session extends \Stripe\ApiResource { diff --git a/lib/FinancialConnections/Transaction.php b/lib/FinancialConnections/Transaction.php index 801f70a13..81904b200 100644 --- a/lib/FinancialConnections/Transaction.php +++ b/lib/FinancialConnections/Transaction.php @@ -15,7 +15,7 @@ * @property string $description The description of this transaction. * @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 $status The status of the transaction. - * @property object{posted_at: null|int, void_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{posted_at: null|int, void_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property int $transacted_at Time at which the transaction was transacted. Measured in seconds since the Unix epoch. * @property string $transaction_refresh The token of the transaction refresh that last updated or created this transaction. * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch. diff --git a/lib/Forwarding/Request.php b/lib/Forwarding/Request.php index 734625c05..bb5c1b70d 100644 --- a/lib/Forwarding/Request.php +++ b/lib/Forwarding/Request.php @@ -26,12 +26,12 @@ * @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 $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode. - * @property null|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|\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 $payment_method The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. * @property string[] $replacements The field kinds to be replaced in the forwarded request. - * @property null|object{destination_duration: int, destination_ip_address: string}&\Stripe\StripeObject&\stdClass $request_context Context about the request from Stripe's servers to the destination endpoint. - * @property null|object{body: string, headers: object{name: string, value: string}&\Stripe\StripeObject&\stdClass[], http_method: string}&\Stripe\StripeObject&\stdClass $request_details The request that was sent to the destination endpoint. We redact any sensitive fields. - * @property null|object{body: string, headers: object{name: string, value: string}&\Stripe\StripeObject&\stdClass[], status: int}&\Stripe\StripeObject&\stdClass $response_details The response that the destination endpoint returned to us. We redact any sensitive fields. + * @property null|(object{destination_duration: int, destination_ip_address: string}&\Stripe\StripeObject&\stdClass) $request_context Context about the request from Stripe's servers to the destination endpoint. + * @property null|(object{body: string, headers: (object{name: string, value: string}&\Stripe\StripeObject&\stdClass)[], http_method: string}&\Stripe\StripeObject&\stdClass) $request_details The request that was sent to the destination endpoint. We redact any sensitive fields. + * @property null|(object{body: string, headers: (object{name: string, value: string}&\Stripe\StripeObject&\stdClass)[], status: int}&\Stripe\StripeObject&\stdClass) $response_details The response that the destination endpoint returned to us. We redact any sensitive fields. * @property null|string $url The destination URL for the forwarded request. Must be supported by the config. */ class Request extends \Stripe\ApiResource diff --git a/lib/FundingInstructions.php b/lib/FundingInstructions.php index 69f16f0cb..43cdbbf80 100644 --- a/lib/FundingInstructions.php +++ b/lib/FundingInstructions.php @@ -12,7 +12,7 @@ * Related guide: Customer balance funding instructions. * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property object{country: string, financial_addresses: (object{aba?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, account_number: string, account_type: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_name: string, routing_number: string}&\Stripe\StripeObject&\stdClass, iban?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bic: string, country: string, iban: string}&\Stripe\StripeObject&\stdClass, sort_code?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, account_number: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, sort_code: string}&\Stripe\StripeObject&\stdClass, spei?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_code: string, bank_name: string, clabe: string}&\Stripe\StripeObject&\stdClass, supported_networks?: string[], swift?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, account_number: string, account_type: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_name: string, swift_code: string}&\Stripe\StripeObject&\stdClass, type: string, zengin?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: null|string, account_number: null|string, account_type: null|string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_code: null|string, bank_name: null|string, branch_code: null|string, branch_name: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[], type: string}&\Stripe\StripeObject&\stdClass $bank_transfer + * @property (object{country: string, financial_addresses: ((object{aba?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, account_number: string, account_type: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_name: string, routing_number: string}&\Stripe\StripeObject&\stdClass), iban?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bic: string, country: string, iban: string}&\Stripe\StripeObject&\stdClass), sort_code?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, account_number: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), sort_code: string}&\Stripe\StripeObject&\stdClass), spei?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_code: string, bank_name: string, clabe: string}&\Stripe\StripeObject&\stdClass), supported_networks?: string[], swift?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, account_number: string, account_type: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_name: string, swift_code: string}&\Stripe\StripeObject&\stdClass), type: string, zengin?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: null|string, account_number: null|string, account_type: null|string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_code: null|string, bank_name: null|string, branch_code: null|string, branch_name: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[], type: string}&\Stripe\StripeObject&\stdClass) $bank_transfer * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property string $funding_type The funding_type of the returned instructions * @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. diff --git a/lib/GiftCards/Card.php b/lib/GiftCards/Card.php index 312e911e4..79a48b600 100644 --- a/lib/GiftCards/Card.php +++ b/lib/GiftCards/Card.php @@ -15,9 +15,9 @@ * @property int $amount_held The amount of funds marked as held. * @property null|string $code Code used to redeem this gift card. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|object{checkout?: object{checkout_session: string, line_item: null|string}&\Stripe\StripeObject&\stdClass, order?: object{line_item: null|string, order: string}&\Stripe\StripeObject&\stdClass, payment?: object{payment_intent: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $created_by The related Stripe objects that created this gift card. + * @property null|(object{checkout?: (object{checkout_session: string, line_item: null|string}&\Stripe\StripeObject&\stdClass), order?: (object{line_item: null|string, order: string}&\Stripe\StripeObject&\stdClass), payment?: (object{payment_intent: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $created_by The related Stripe objects that created this gift card. * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. - * @property null|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|\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|\Stripe\Collection<\Stripe\GiftCards\Transaction> $transactions Transactions on this gift card. */ class Card extends \Stripe\ApiResource @@ -88,7 +88,7 @@ public static function retrieve($id, $opts = null) * Update a gift card. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/GiftCards/Transaction.php b/lib/GiftCards/Transaction.php index bc64fb5be..49166ab87 100644 --- a/lib/GiftCards/Transaction.php +++ b/lib/GiftCards/Transaction.php @@ -17,11 +17,11 @@ * @property null|int $amount The amount of this transaction. A positive value indicates that funds were added to the gift card. A negative value indicates that funds were removed from the gift card. * @property null|int $confirmed_at Time at which the transaction was confirmed. Measured in seconds since the Unix epoch. * @property null|int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|object{checkout?: object{checkout_session: string, line_item: null|string}&\Stripe\StripeObject&\stdClass, order?: object{line_item: null|string, order: string}&\Stripe\StripeObject&\stdClass, payment?: object{payment_intent: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $created_by The related Stripe objects that created this gift card transaction. + * @property null|(object{checkout?: (object{checkout_session: string, line_item: null|string}&\Stripe\StripeObject&\stdClass), order?: (object{line_item: null|string, order: string}&\Stripe\StripeObject&\stdClass), payment?: (object{payment_intent: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $created_by The related Stripe objects that created this gift card transaction. * @property null|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|string $gift_card The gift card that this transaction occurred on - * @property null|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|\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 $status Status of this transaction, one of held, confirmed, or canceled. * @property null|string $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details. */ @@ -98,7 +98,7 @@ public static function retrieve($id, $opts = null) * Update a gift card transaction. * * @param string $id the ID of the resource to update - * @param null|array{description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Identity/VerificationReport.php b/lib/Identity/VerificationReport.php index 4dfed0031..1ef307bcd 100644 --- a/lib/Identity/VerificationReport.php +++ b/lib/Identity/VerificationReport.php @@ -21,13 +21,13 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property null|string $client_reference_id A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, dob?: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass, error: null|object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass, expiration_date?: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass, files: null|string[], first_name: null|string, issued_date: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass, issuing_country: null|string, last_name: null|string, number?: null|string, status: string, type: null|string}&\Stripe\StripeObject&\stdClass $document Result from a document check - * @property object{email: null|string, error: null|object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass, status: string}&\Stripe\StripeObject&\stdClass $email Result from a email check - * @property object{dob?: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass, error: null|object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass, first_name: null|string, id_number?: null|string, id_number_type: null|string, last_name: null|string, status: string}&\Stripe\StripeObject&\stdClass $id_number Result from an id_number check + * @property (object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), dob?: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass), error: null|(object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass), expiration_date?: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass), files: null|string[], first_name: null|string, issued_date: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass), issuing_country: null|string, last_name: null|string, number?: null|string, status: string, type: null|string}&\Stripe\StripeObject&\stdClass) $document Result from a document check + * @property (object{email: null|string, error: null|(object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass), status: string}&\Stripe\StripeObject&\stdClass) $email Result from a email check + * @property (object{dob?: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass), error: null|(object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass), first_name: null|string, id_number?: null|string, id_number_type: null|string, last_name: null|string, status: string}&\Stripe\StripeObject&\stdClass) $id_number Result from an id_number check * @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 null|object{document?: object{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}&\Stripe\StripeObject&\stdClass, id_number?: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $options - * @property object{error: null|object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass, phone: null|string, status: string}&\Stripe\StripeObject&\stdClass $phone Result from a phone check - * @property object{document: null|string, error: null|object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass, selfie: null|string, status: string}&\Stripe\StripeObject&\stdClass $selfie Result from a selfie check + * @property null|(object{document?: (object{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}&\Stripe\StripeObject&\stdClass), id_number?: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $options + * @property (object{error: null|(object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass), phone: null|string, status: string}&\Stripe\StripeObject&\stdClass) $phone Result from a phone check + * @property (object{document: null|string, error: null|(object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass), selfie: null|string, status: string}&\Stripe\StripeObject&\stdClass) $selfie Result from a selfie check * @property string $type Type of report. * @property null|string $verification_flow The configuration token of a verification flow from the dashboard. * @property null|string $verification_session ID of the VerificationSession that created this report. diff --git a/lib/Identity/VerificationSession.php b/lib/Identity/VerificationSession.php index 8e1335858..14d333966 100644 --- a/lib/Identity/VerificationSession.php +++ b/lib/Identity/VerificationSession.php @@ -22,19 +22,19 @@ * @property null|string $client_reference_id A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. * @property null|string $client_secret The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass $last_error If present, this property tells you the last error encountered when processing the verification. + * @property null|(object{code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass) $last_error If present, this property tells you the last error encountered when processing the verification. * @property null|string|\Stripe\Identity\VerificationReport $last_verification_report ID of the most recent VerificationReport. Learn more about accessing detailed verification results. * @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 null|object{document?: object{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}&\Stripe\StripeObject&\stdClass, email?: object{require_verification?: bool}&\Stripe\StripeObject&\stdClass, id_number?: object{}&\Stripe\StripeObject&\stdClass, phone?: object{require_verification?: bool}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $options A set of options for the session’s verification checks. - * @property null|object{email?: string, phone?: string}&\Stripe\StripeObject&\stdClass $provided_details Details provided about the user being verified. These details may be shown to the user. - * @property null|object{status: string}&\Stripe\StripeObject&\stdClass $redaction Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. + * @property null|(object{document?: (object{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}&\Stripe\StripeObject&\stdClass), email?: (object{require_verification?: bool}&\Stripe\StripeObject&\stdClass), id_number?: (object{}&\Stripe\StripeObject&\stdClass), phone?: (object{require_verification?: bool}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $options A set of options for the session’s verification checks. + * @property null|(object{email?: string, phone?: string}&\Stripe\StripeObject&\stdClass) $provided_details Details provided about the user being verified. These details may be shown to the user. + * @property null|(object{status: string}&\Stripe\StripeObject&\stdClass) $redaction Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. * @property null|string $related_customer Token referencing a Customer resource. * @property string $status Status of this VerificationSession. Learn more about the lifecycle of sessions. * @property string $type The type of verification check to be performed. * @property null|string $url The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe. * @property null|string $verification_flow The configuration token of a verification flow from the dashboard. - * @property null|object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, dob?: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass, email: null|string, first_name: null|string, id_number?: null|string, id_number_type: null|string, last_name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $verified_outputs The user’s verified data. + * @property null|(object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), dob?: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass), email: null|string, first_name: null|string, id_number?: null|string, id_number_type: null|string, last_name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $verified_outputs The user’s verified data. */ class VerificationSession extends \Stripe\ApiResource { diff --git a/lib/Invoice.php b/lib/Invoice.php index 653b77ae2..608ab7869 100644 --- a/lib/Invoice.php +++ b/lib/Invoice.php @@ -48,28 +48,28 @@ * @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|(object{amount: int, amount_paid: int, amount_remaining: int, days_until_due: null|int, description: null|string, due_date: null|int, paid_at: null|int, status: string}&\Stripe\StripeObject&\stdClass)[] $amounts_due List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically. + * @property null|((object{amount: int, amount_paid: int, amount_remaining: int, days_until_due: null|int, description: null|string, due_date: null|int, paid_at: null|int, status: string}&\Stripe\StripeObject&\stdClass))[] $amounts_due List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically. * @property null|string|\Stripe\Application $application ID of the Connect Application that created the invoice. * @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. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. * @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. - * @property object{disabled_reason: null|string, enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass, status: null|string}&\Stripe\StripeObject&\stdClass $automatic_tax + * @property (object{disabled_reason: null|string, enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass), status: null|string}&\Stripe\StripeObject&\stdClass) $automatic_tax * @property null|int $automatically_finalizes_at The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized. * @property null|string $billing_reason

Indicates the reason why the invoice was created.

* manual: Unrelated to a subscription, for example, created via the invoice editor. * subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * subscription_create: A new subscription was created. * subscription_cycle: A subscription advanced into a new period. * subscription_threshold: A subscription reached a billing threshold. * subscription_update: A subscription was updated. * upcoming: Reserved for simulated invoices, per the upcoming invoice endpoint.

* @property null|string|\Stripe\Charge $charge ID of the latest charge generated for this invoice, if any. * @property string $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 null|object{name: string, value: string}&\Stripe\StripeObject&\stdClass[] $custom_fields Custom fields displayed on the invoice. + * @property null|(object{name: string, value: string}&\Stripe\StripeObject&\stdClass)[] $custom_fields Custom fields displayed on the invoice. * @property null|string|\Stripe\Customer $customer The ID of the customer who will be billed. - * @property null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass $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 null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass) $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 null|string $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 null|string $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 null|string $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 null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $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 null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $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 null|string $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 null|(object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass)[] $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 null|((object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass))[] $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 null|(string|\Stripe\Margin)[] $default_margins The margins applied to the invoice. Can be overridden by line item margins. Use expand[]=default_margins to expand each margin. * @property null|string|\Stripe\PaymentMethod $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 null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $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. @@ -81,22 +81,22 @@ * @property null|int $effective_at The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. * @property null|int $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 null|string $footer Footer displayed on the invoice. - * @property null|object{action: string, invoice: string|\Stripe\Invoice}&\Stripe\StripeObject&\stdClass $from_invoice Details of the invoice that was cloned. See the revision documentation for more details. + * @property null|(object{action: string, invoice: string|\Stripe\Invoice}&\Stripe\StripeObject&\stdClass) $from_invoice Details of the invoice that was cloned. See the revision documentation for more details. * @property null|string $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 null|string $invoice_pdf The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. - * @property object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass $issuer - * @property null|object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass $last_finalization_error The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. + * @property (object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass) $issuer + * @property null|(object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass) $last_finalization_error The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. * @property null|string|\Stripe\Invoice $latest_revision The ID of the most recent non-draft revision of this invoice * @property \Stripe\Collection<\Stripe\InvoiceLineItem> $lines The individual line items that make up the invoice. lines is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order. * @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 null|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|\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|int $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 null|string $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 null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details. * @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 bool $paid_out_of_band Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. * @property null|string|\Stripe\PaymentIntent $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 object{default_mandate: null|string, payment_method_options: null|object{acss_debit: null|object{mandate_options?: object{transaction_type: null|string}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass, bancontact: null|object{preferred_language: string}&\Stripe\StripeObject&\stdClass, card: null|object{installments?: object{enabled: null|bool}&\Stripe\StripeObject&\stdClass, request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass, customer_balance: null|object{bank_transfer?: object{eu_bank_transfer?: object{country: string}&\Stripe\StripeObject&\stdClass, type: null|string}&\Stripe\StripeObject&\stdClass, funding_type: null|string}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: null|object{}&\Stripe\StripeObject&\stdClass, konbini: null|object{}&\Stripe\StripeObject&\stdClass, sepa_debit: null|object{}&\Stripe\StripeObject&\stdClass, us_bank_account: null|object{financial_connections?: object{filters?: object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass, permissions?: string[], prefetch: null|string[]}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payment_method_types: null|string[]}&\Stripe\StripeObject&\stdClass $payment_settings + * @property (object{default_mandate: null|string, payment_method_options: null|(object{acss_debit: null|(object{mandate_options?: (object{transaction_type: null|string}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass), bancontact: null|(object{preferred_language: string}&\Stripe\StripeObject&\stdClass), card: null|(object{installments?: (object{enabled: null|bool}&\Stripe\StripeObject&\stdClass), request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass), customer_balance: null|(object{bank_transfer?: (object{eu_bank_transfer?: (object{country: string}&\Stripe\StripeObject&\stdClass), type: null|string}&\Stripe\StripeObject&\stdClass), funding_type: null|string}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: null|(object{}&\Stripe\StripeObject&\stdClass), konbini: null|(object{}&\Stripe\StripeObject&\stdClass), sepa_debit: null|(object{}&\Stripe\StripeObject&\stdClass), us_bank_account: null|(object{financial_connections?: (object{filters?: (object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass), permissions?: string[], prefetch: null|string[]}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payment_method_types: null|string[]}&\Stripe\StripeObject&\stdClass) $payment_settings * @property null|\Stripe\Collection<\Stripe\InvoicePayment> $payments Payments for this invoice * @property int $period_end End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price. * @property int $period_start Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price. @@ -104,28 +104,28 @@ * @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|object{amount_tax_display: null|string, pdf: null|object{page_size: null|string}&\Stripe\StripeObject&\stdClass, template: null|string, template_version: null|int}&\Stripe\StripeObject&\stdClass $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|object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $shipping_cost The details of the cost of shipping, including the ShippingRate applied on the invoice. - * @property null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $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. + * @property null|(object{amount_tax_display: null|string, pdf: null|(object{page_size: null|string}&\Stripe\StripeObject&\stdClass), template: null|string, template_version: null|int}&\Stripe\StripeObject&\stdClass) $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|(object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $shipping_cost The details of the cost of shipping, including the ShippingRate applied on the invoice. + * @property null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $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. * @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. For revision invoices, this also includes any customer balance that was applied to the original invoice. * @property null|string $statement_descriptor Extra information about an invoice for the customer's credit card statement. * @property null|string $status The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more - * @property object{finalized_at: null|int, marked_uncollectible_at: null|int, paid_at: null|int, voided_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{finalized_at: null|int, marked_uncollectible_at: null|int, paid_at: null|int, voided_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property null|string|\Stripe\Subscription $subscription The subscription that this invoice was prepared for, if any. - * @property null|object{metadata: null|StripeObject, pause_collection?: null|object{behavior: string, resumes_at: null|int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $subscription_details Details about the subscription that created this invoice. + * @property null|(object{metadata: null|\Stripe\StripeObject, pause_collection?: null|(object{behavior: string, resumes_at: null|int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $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 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 object{amount_gte: null|int, item_reasons: object{line_item_ids: string[], usage_gte: int}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass $threshold_reason + * @property (object{amount_gte: null|int, item_reasons: (object{line_item_ids: string[], usage_gte: int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass) $threshold_reason * @property int $total Total after discounts and taxes. - * @property null|(object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass)[] $total_discount_amounts The aggregate amounts calculated per discount across all line items. + * @property null|((object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass))[] $total_discount_amounts The aggregate amounts calculated per discount across all line items. * @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 null|(object{amount: int, margin: string|\Stripe\Margin}&\Stripe\StripeObject&\stdClass)[] $total_margin_amounts The aggregate amounts calculated per margin across all line items. - * @property null|(object{amount: int, credit_balance_transaction?: null|string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, margin?: string|\Stripe\Margin, type: string}&\Stripe\StripeObject&\stdClass)[] $total_pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. - * @property (object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items. - * @property null|object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass $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|((object{amount: int, margin: string|\Stripe\Margin}&\Stripe\StripeObject&\stdClass))[] $total_margin_amounts The aggregate amounts calculated per margin across all line items. + * @property null|((object{amount: int, credit_balance_transaction?: null|string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, margin?: string|\Stripe\Margin, type: string}&\Stripe\StripeObject&\stdClass))[] $total_pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. + * @property ((object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items. + * @property null|(object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass) $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. */ class Invoice extends ApiResource @@ -164,7 +164,7 @@ class Invoice extends ApiResource * allows you to pay or send * the invoice to your customers. * - * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, currency?: string, custom_fields?: null|array{name: string, value: string}[], customer?: string, days_until_due?: int, default_margins?: string[], default_payment_method?: string, default_source?: string, default_tax_rates?: string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: int, expand?: string[], footer?: string, from_invoice?: array{action: string, invoice: string}, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, number?: string, on_behalf_of?: string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, pending_invoice_items_behavior?: string, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, subscription?: string, transfer_data?: array{amount?: int, destination: string}} $params + * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, currency?: string, custom_fields?: null|array{name: string, value: string}[], customer?: string, days_until_due?: int, default_margins?: string[], default_payment_method?: string, default_source?: string, default_tax_rates?: string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: int, expand?: string[], footer?: string, from_invoice?: array{action: string, invoice: string}, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, number?: string, on_behalf_of?: string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, pending_invoice_items_behavior?: string, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, subscription?: string, transfer_data?: array{amount?: int, destination: string}} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -189,7 +189,7 @@ public static function create($params = null, $options = null) * has been finalized or if an invoice is for a subscription, it must be voided. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -256,7 +256,7 @@ public static function retrieve($id, $opts = null) * invoices, pass auto_advance=false. * * @param string $id the ID of the resource to update - * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, custom_fields?: null|array{name: string, value: string}[], days_until_due?: int, default_margins?: null|string[], default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: null|int, expand?: string[], footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, number?: null|string, on_behalf_of?: null|string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, transfer_data?: null|array{amount?: int, destination: string}} $params + * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, custom_fields?: null|array{name: string, value: string}[], days_until_due?: int, default_margins?: null|string[], default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: null|int, expand?: string[], footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, number?: null|string, on_behalf_of?: null|string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, transfer_data?: null|array{amount?: int, destination: string}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/InvoiceItem.php b/lib/InvoiceItem.php index ef808d5bf..52efb5299 100644 --- a/lib/InvoiceItem.php +++ b/lib/InvoiceItem.php @@ -29,8 +29,8 @@ * @property null|string|\Stripe\Invoice $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 null|(string|\Stripe\Margin)[] $margins The margins which apply to the invoice item. When set, the default_margins on the invoice do not apply to this invoice item. - * @property null|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 object{end: int, start: int}&\Stripe\StripeObject&\stdClass $period + * @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 (object{end: int, start: int}&\Stripe\StripeObject&\stdClass) $period * @property null|\Stripe\Plan $plan If the invoice item is a proration, the plan of the subscription that the proration was computed for. * @property null|\Stripe\Price $price The price of the invoice item. * @property bool $proration Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. @@ -53,7 +53,7 @@ class InvoiceItem extends ApiResource * no invoice is specified, the item will be on the next invoice created for the * customer specified. * - * @param null|array{amount?: int, currency?: string, customer: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice?: string, margins?: string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, subscription?: string, tax_behavior?: string, tax_code?: null|string, tax_rates?: string[], unit_amount?: int, unit_amount_decimal?: string} $params + * @param null|array{amount?: int, currency?: string, customer: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice?: string, margins?: string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, subscription?: string, tax_behavior?: string, tax_code?: null|string, tax_rates?: string[], unit_amount?: int, unit_amount_decimal?: string} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -77,7 +77,7 @@ public static function create($params = null, $options = null) * only possible when they’re not attached to invoices, or if it’s attached to a * draft invoice. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -138,7 +138,7 @@ public static function retrieve($id, $opts = null) * closed. * * @param string $id the ID of the resource to update - * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string} $params + * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/InvoiceLineItem.php b/lib/InvoiceLineItem.php index 6c558e5c0..0ed4b82e5 100644 --- a/lib/InvoiceLineItem.php +++ b/lib/InvoiceLineItem.php @@ -15,25 +15,25 @@ * @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|(object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass)[] $discount_amounts The amount of discount calculated per discount for this line item. + * @property null|((object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass))[] $discount_amounts The amount of discount calculated per discount for this line item. * @property bool $discountable If true, discounts will apply to this line item. Always false for prorations. * @property (string|\Stripe\Discount)[] $discounts The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount. * @property null|string $invoice The ID of the invoice that contains this line item. * @property null|string|\Stripe\InvoiceItem $invoice_item The ID of the invoice item associated with this line item 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 null|(object{amount: int, margin: string|\Stripe\Margin}&\Stripe\StripeObject&\stdClass)[] $margin_amounts The amount of margin calculated per margin for this line item. + * @property null|((object{amount: int, margin: string|\Stripe\Margin}&\Stripe\StripeObject&\stdClass))[] $margin_amounts The amount of margin calculated per margin for this line item. * @property null|(string|\Stripe\Margin)[] $margins The margins applied to the line item. When set, the default_margins on the invoice do not apply to the line item. Use expand[]=margins to expand each margin. * @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. Note that for line items with type=subscription, metadata reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. - * @property object{end: int, start: int}&\Stripe\StripeObject&\stdClass $period + * @property (object{end: int, start: int}&\Stripe\StripeObject&\stdClass) $period * @property null|\Stripe\Plan $plan The plan of the subscription, if the line item is a subscription or a proration. - * @property null|(object{amount: int, credit_balance_transaction?: null|string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, margin?: string|\Stripe\Margin, type: string}&\Stripe\StripeObject&\stdClass)[] $pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. + * @property null|((object{amount: int, credit_balance_transaction?: null|string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, margin?: string|\Stripe\Margin, type: string}&\Stripe\StripeObject&\stdClass))[] $pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. * @property null|\Stripe\Price $price The price of the line item. * @property bool $proration Whether this is a proration. - * @property null|object{credited_items: null|object{invoice: string, invoice_line_items: string[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $proration_details Additional details for proration line items + * @property null|(object{credited_items: null|(object{invoice: string, invoice_line_items: string[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $proration_details Additional details for proration line items * @property null|int $quantity The quantity of the subscription, if the line item is a subscription or a proration. * @property null|string|\Stripe\Subscription $subscription The subscription that the invoice item pertains to, if any. * @property null|string|\Stripe\SubscriptionItem $subscription_item The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. - * @property (object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[] $tax_amounts The amount of tax calculated per tax rate for this line item + * @property ((object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[] $tax_amounts The amount of tax calculated per tax rate for this line item * @property \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 cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. @@ -53,7 +53,7 @@ class InvoiceLineItem extends ApiResource * before the invoice is finalized. * * @param string $id the ID of the resource to update - * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]} $params + * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/InvoicePayment.php b/lib/InvoicePayment.php index 00f729826..3c89e11ba 100644 --- a/lib/InvoicePayment.php +++ b/lib/InvoicePayment.php @@ -17,9 +17,9 @@ * @property string|\Stripe\Invoice $invoice The invoice that was paid. * @property null|bool $is_default Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s amount_remaining. The PaymentIntent associated with the default payment can’t be edited or canceled directly. * @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 object{charge?: string|\Stripe\Charge, payment_intent?: string|\Stripe\PaymentIntent, payment_record?: string|\Stripe\PaymentRecord, type: string}&\Stripe\StripeObject&\stdClass $payment + * @property (object{charge?: string|\Stripe\Charge, payment_intent?: string|\Stripe\PaymentIntent, payment_record?: string|\Stripe\PaymentRecord, type: string}&\Stripe\StripeObject&\stdClass) $payment * @property string $status The status of the payment, one of open, paid, or canceled. - * @property object{canceled_at: null|int, paid_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{canceled_at: null|int, paid_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions */ class InvoicePayment extends ApiResource { diff --git a/lib/InvoiceRenderingTemplate.php b/lib/InvoiceRenderingTemplate.php index 61056e65e..e6d6fda5a 100644 --- a/lib/InvoiceRenderingTemplate.php +++ b/lib/InvoiceRenderingTemplate.php @@ -12,7 +12,7 @@ * @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 $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode. - * @property null|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|\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 $nickname A brief description of the template, hidden from customers * @property string $status The status of the template, one of active or archived. * @property int $version Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering diff --git a/lib/Issuing/Authorization.php b/lib/Issuing/Authorization.php index 11947b7b0..ed9975442 100644 --- a/lib/Issuing/Authorization.php +++ b/lib/Issuing/Authorization.php @@ -14,7 +14,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 The total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. amount should be the same as merchant_amount, unless currency and merchant_currency are different. - * @property null|object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit. + * @property null|(object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass) $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit. * @property bool $approved Whether the authorization has been approved. * @property string $authorization_method How the card details were provided. * @property \Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this authorization. @@ -22,22 +22,22 @@ * @property null|string|\Stripe\Issuing\Cardholder $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 string $currency The currency of the cardholder. This currency can be different from the currency presented at authorization and the merchant_currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency. - * @property null|object{cardholder_prompt_data: null|object{alphanumeric_id: null|string, driver_id: null|string, odometer: null|int, unspecified_id: null|string, user_id: null|string, vehicle_number: null|string}&\Stripe\StripeObject&\stdClass, purchase_type: null|string, reported_breakdown: null|object{fuel: null|object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass, non_fuel: null|object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass, tax: null|object{local_amount_decimal: null|string, national_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, service_type: null|string}&\Stripe\StripeObject&\stdClass $fleet Fleet-specific information for authorizations using Fleet cards. - * @property null|(object{channel: string, status: string, undeliverable_reason: null|string}&\Stripe\StripeObject&\stdClass)[] $fraud_challenges Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. - * @property null|object{industry_product_code: null|string, quantity_decimal: null|string, type: null|string, unit: null|string, unit_cost_decimal: null|string}&\Stripe\StripeObject&\stdClass $fuel Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. + * @property null|(object{cardholder_prompt_data: null|(object{alphanumeric_id: null|string, driver_id: null|string, odometer: null|int, unspecified_id: null|string, user_id: null|string, vehicle_number: null|string}&\Stripe\StripeObject&\stdClass), purchase_type: null|string, reported_breakdown: null|(object{fuel: null|(object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass), non_fuel: null|(object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass), tax: null|(object{local_amount_decimal: null|string, national_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), service_type: null|string}&\Stripe\StripeObject&\stdClass) $fleet Fleet-specific information for authorizations using Fleet cards. + * @property null|((object{channel: string, status: string, undeliverable_reason: null|string}&\Stripe\StripeObject&\stdClass))[] $fraud_challenges Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. + * @property null|(object{industry_product_code: null|string, quantity_decimal: null|string, type: null|string, unit: null|string, unit_cost_decimal: null|string}&\Stripe\StripeObject&\stdClass) $fuel Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. * @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 total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit. merchant_amount should be the same as amount, unless merchant_currency and currency are different. * @property string $merchant_currency The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency. - * @property object{category: string, category_code: string, city: null|string, country: null|string, name: null|string, network_id: string, postal_code: null|string, state: null|string, terminal_id: null|string, url: null|string}&\Stripe\StripeObject&\stdClass $merchant_data + * @property (object{category: string, category_code: string, city: null|string, country: null|string, name: null|string, network_id: string, postal_code: null|string, state: null|string, terminal_id: null|string, url: null|string}&\Stripe\StripeObject&\stdClass) $merchant_data * @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 null|object{acquiring_institution_id: null|string, system_trace_audit_number: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass $network_data Details about the authorization, such as identifiers, set by the card network. - * @property null|object{amount: int, amount_details: null|object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass, currency: string, is_amount_controllable: bool, merchant_amount: int, merchant_currency: string, network_risk_score: null|int}&\Stripe\StripeObject&\stdClass $pending_request The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook. - * @property (object{amount: int, amount_details: null|object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass, approved: bool, authorization_code: null|string, created: int, currency: string, merchant_amount: int, merchant_currency: string, network_risk_score: null|int, reason: string, reason_message: null|string, requested_at: null|int}&\Stripe\StripeObject&\stdClass)[] $request_history History of every time a pending_request authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. + * @property null|(object{acquiring_institution_id: null|string, system_trace_audit_number: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass) $network_data Details about the authorization, such as identifiers, set by the card network. + * @property null|(object{amount: int, amount_details: null|(object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass), currency: string, is_amount_controllable: bool, merchant_amount: int, merchant_currency: string, network_risk_score: null|int}&\Stripe\StripeObject&\stdClass) $pending_request The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook. + * @property ((object{amount: int, amount_details: null|(object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass), approved: bool, authorization_code: null|string, created: int, currency: string, merchant_amount: int, merchant_currency: string, network_risk_score: null|int, reason: string, reason_message: null|string, requested_at: null|int}&\Stripe\StripeObject&\stdClass))[] $request_history History of every time a pending_request authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. * @property string $status The current status of the authorization in its lifecycle. * @property null|string|\Stripe\Issuing\Token $token Token object used for this authorization. If a network token was not used for this authorization, this field will be null. * @property \Stripe\Issuing\Transaction[] $transactions List of transactions associated with this authorization. - * @property null|object{received_credits: string[], received_debits: string[], transaction: null|string}&\Stripe\StripeObject&\stdClass $treasury Treasury details related to this authorization if it was created on a FinancialAccount. - * @property object{address_line1_check: string, address_postal_code_check: string, authentication_exemption: null|object{claimed_by: string, type: string}&\Stripe\StripeObject&\stdClass, cvc_check: string, expiry_check: string, postal_code: null|string, three_d_secure: null|object{result: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $verification_data + * @property null|(object{received_credits: string[], received_debits: string[], transaction: null|string}&\Stripe\StripeObject&\stdClass) $treasury Treasury details related to this authorization if it was created on a FinancialAccount. + * @property (object{address_line1_check: string, address_postal_code_check: string, authentication_exemption: null|(object{claimed_by: string, type: string}&\Stripe\StripeObject&\stdClass), cvc_check: string, expiry_check: string, postal_code: null|string, three_d_secure: null|(object{result: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $verification_data * @property null|bool $verified_by_fraud_challenge Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. * @property null|string $wallet The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. Will populate as null when no digital wallet was utilized. */ @@ -101,7 +101,7 @@ public static function retrieve($id, $opts = null) * unchanged. * * @param string $id the ID of the resource to update - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Issuing/Card.php b/lib/Issuing/Card.php index 63d294011..1b3f8f35b 100644 --- a/lib/Issuing/Card.php +++ b/lib/Issuing/Card.php @@ -26,11 +26,11 @@ * @property null|string|\Stripe\Issuing\Card $replaced_by The latest card that replaces this card, if any. * @property null|string|\Stripe\Issuing\Card $replacement_for The card this card replaces, if any. * @property null|string $replacement_reason The reason why the previous card needed to be replaced. - * @property null|object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, address_validation: null|object{mode: string, normalized_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, result: null|string}&\Stripe\StripeObject&\stdClass, carrier: null|string, customs: null|object{eori_number: null|string}&\Stripe\StripeObject&\stdClass, eta: null|int, name: string, phone_number: null|string, require_signature: null|bool, service: string, status: null|string, tracking_number: null|string, tracking_url: null|string, type: string}&\Stripe\StripeObject&\stdClass $shipping Where and how the card will be shipped. - * @property object{allowed_categories: null|string[], allowed_merchant_countries: null|string[], blocked_categories: null|string[], blocked_merchant_countries: null|string[], spending_limits: null|(object{amount: int, categories: null|string[], interval: string}&\Stripe\StripeObject&\stdClass)[], spending_limits_currency: null|string}&\Stripe\StripeObject&\stdClass $spending_controls + * @property null|(object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), address_validation: null|(object{mode: string, normalized_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), result: null|string}&\Stripe\StripeObject&\stdClass), carrier: null|string, customs: null|(object{eori_number: null|string}&\Stripe\StripeObject&\stdClass), eta: null|int, name: string, phone_number: null|string, require_signature: null|bool, service: string, status: null|string, tracking_number: null|string, tracking_url: null|string, type: string}&\Stripe\StripeObject&\stdClass) $shipping Where and how the card will be shipped. + * @property (object{allowed_categories: null|string[], allowed_merchant_countries: null|string[], blocked_categories: null|string[], blocked_merchant_countries: null|string[], spending_limits: null|((object{amount: int, categories: null|string[], interval: string}&\Stripe\StripeObject&\stdClass))[], spending_limits_currency: null|string}&\Stripe\StripeObject&\stdClass) $spending_controls * @property string $status Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive. * @property string $type The type of the card. - * @property null|object{apple_pay: object{eligible: bool, ineligible_reason: null|string}&\Stripe\StripeObject&\stdClass, google_pay: object{eligible: bool, ineligible_reason: null|string}&\Stripe\StripeObject&\stdClass, primary_account_identifier: null|string}&\Stripe\StripeObject&\stdClass $wallets Information relating to digital wallets (like Apple Pay and Google Pay). + * @property null|(object{apple_pay: (object{eligible: bool, ineligible_reason: null|string}&\Stripe\StripeObject&\stdClass), google_pay: (object{eligible: bool, ineligible_reason: null|string}&\Stripe\StripeObject&\stdClass), primary_account_identifier: null|string}&\Stripe\StripeObject&\stdClass) $wallets Information relating to digital wallets (like Apple Pay and Google Pay). */ class Card extends \Stripe\ApiResource { @@ -119,7 +119,7 @@ public static function retrieve($id, $opts = null) * the parameters passed. Any parameters not provided will be left unchanged. * * @param string $id the ID of the resource to update - * @param null|array{cancellation_reason?: string, expand?: string[], metadata?: null|StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string} $params + * @param null|array{cancellation_reason?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Issuing/Cardholder.php b/lib/Issuing/Cardholder.php index 32cabb1bc..ebc9d1134 100644 --- a/lib/Issuing/Cardholder.php +++ b/lib/Issuing/Cardholder.php @@ -11,18 +11,18 @@ * * @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 object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $billing - * @property null|object{tax_id_provided: bool}&\Stripe\StripeObject&\stdClass $company Additional information about a company cardholder. + * @property (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $billing + * @property null|(object{tax_id_provided: bool}&\Stripe\StripeObject&\stdClass) $company Additional information about a company cardholder. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $email The cardholder's email address. - * @property null|object{card_issuing?: null|object{user_terms_acceptance: null|object{date: null|int, ip: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, dob: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass, first_name: null|string, last_name: null|string, verification: null|object{document: null|object{back: null|string|\Stripe\File, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $individual Additional information about an individual cardholder. + * @property null|(object{card_issuing?: null|(object{user_terms_acceptance: null|(object{date: null|int, ip: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), dob: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass), first_name: null|string, last_name: null|string, verification: null|(object{document: null|(object{back: null|string|\Stripe\File, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $individual Additional information about an individual 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 null|string $phone_number The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details. * @property null|string[] $preferred_locales The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder. - * @property object{disabled_reason: null|string, past_due: null|string[]}&\Stripe\StripeObject&\stdClass $requirements - * @property null|object{allowed_categories: null|string[], allowed_merchant_countries: null|string[], blocked_categories: null|string[], blocked_merchant_countries: null|string[], spending_limits: null|(object{amount: int, categories: null|string[], interval: string}&\Stripe\StripeObject&\stdClass)[], spending_limits_currency: null|string}&\Stripe\StripeObject&\stdClass $spending_controls Rules that control spending across this cardholder's cards. Refer to our documentation for more details. + * @property (object{disabled_reason: null|string, past_due: null|string[]}&\Stripe\StripeObject&\stdClass) $requirements + * @property null|(object{allowed_categories: null|string[], allowed_merchant_countries: null|string[], blocked_categories: null|string[], blocked_merchant_countries: null|string[], spending_limits: null|((object{amount: int, categories: null|string[], interval: string}&\Stripe\StripeObject&\stdClass))[], spending_limits_currency: null|string}&\Stripe\StripeObject&\stdClass) $spending_controls Rules that control spending across this cardholder's cards. Refer to our documentation for more details. * @property string $status Specifies whether to permit authorizations on this cardholder's cards. * @property string $type One of individual or company. See Choose a cardholder type for more details. */ diff --git a/lib/Issuing/CreditUnderwritingRecord.php b/lib/Issuing/CreditUnderwritingRecord.php index 9c35c56e5..0315001cc 100644 --- a/lib/Issuing/CreditUnderwritingRecord.php +++ b/lib/Issuing/CreditUnderwritingRecord.php @@ -11,17 +11,17 @@ * * @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|object{application_method: string, purpose: string, submitted_at: int}&\Stripe\StripeObject&\stdClass $application For decisions triggered by an application, details about the submission. + * @property null|(object{application_method: string, purpose: string, submitted_at: int}&\Stripe\StripeObject&\stdClass) $application For decisions triggered by an application, details about the submission. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property string $created_from The event that triggered the underwriting. - * @property object{email: string, name: string}&\Stripe\StripeObject&\stdClass $credit_user + * @property (object{email: string, name: string}&\Stripe\StripeObject&\stdClass) $credit_user * @property null|int $decided_at Date when a decision was made. - * @property null|object{application_rejected: null|object{reason_other_explanation: null|string, reasons: string[]}&\Stripe\StripeObject&\stdClass, credit_limit_approved: null|object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass, credit_limit_decreased: null|object{amount: int, currency: string, reason_other_explanation: null|string, reasons: string[]}&\Stripe\StripeObject&\stdClass, credit_line_closed: null|object{reason_other_explanation: null|string, reasons: string[]}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $decision Details about the decision. + * @property null|(object{application_rejected: null|(object{reason_other_explanation: null|string, reasons: string[]}&\Stripe\StripeObject&\stdClass), credit_limit_approved: null|(object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass), credit_limit_decreased: null|(object{amount: int, currency: string, reason_other_explanation: null|string, reasons: string[]}&\Stripe\StripeObject&\stdClass), credit_line_closed: null|(object{reason_other_explanation: null|string, reasons: string[]}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $decision Details about the decision. * @property null|int $decision_deadline For underwriting initiated by an application, a decision must be taken 30 days after the submission. * @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 null|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|\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 $regulatory_reporting_file File containing regulatory reporting data for the decision. Required if you are subject to this reporting requirement. - * @property null|object{explanation: string, original_decision_type: string}&\Stripe\StripeObject&\stdClass $underwriting_exception If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance. + * @property null|(object{explanation: string, original_decision_type: string}&\Stripe\StripeObject&\stdClass) $underwriting_exception If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance. */ class CreditUnderwritingRecord extends \Stripe\ApiResource { diff --git a/lib/Issuing/Dispute.php b/lib/Issuing/Dispute.php index 5f066829e..c99d9ddec 100644 --- a/lib/Issuing/Dispute.php +++ b/lib/Issuing/Dispute.php @@ -15,13 +15,13 @@ * @property null|\Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with the dispute. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property string $currency The currency the transaction was made in. - * @property object{canceled?: object{additional_documentation: null|string|\Stripe\File, canceled_at: null|int, cancellation_policy_provided: null|bool, cancellation_reason: null|string, expected_at: null|int, explanation: null|string, product_description: null|string, product_type: null|string, return_status: null|string, returned_at: null|int}&\Stripe\StripeObject&\stdClass, duplicate?: object{additional_documentation: null|string|\Stripe\File, card_statement: null|string|\Stripe\File, cash_receipt: null|string|\Stripe\File, check_image: null|string|\Stripe\File, explanation: null|string, original_transaction: null|string}&\Stripe\StripeObject&\stdClass, fraudulent?: object{additional_documentation: null|string|\Stripe\File, explanation: null|string}&\Stripe\StripeObject&\stdClass, merchandise_not_as_described?: object{additional_documentation: null|string|\Stripe\File, explanation: null|string, received_at: null|int, return_description: null|string, return_status: null|string, returned_at: null|int}&\Stripe\StripeObject&\stdClass, no_valid_authorization?: object{additional_documentation: null|string|\Stripe\File, explanation: null|string}&\Stripe\StripeObject&\stdClass, not_received?: object{additional_documentation: null|string|\Stripe\File, expected_at: null|int, explanation: null|string, product_description: null|string, product_type: null|string}&\Stripe\StripeObject&\stdClass, other?: object{additional_documentation: null|string|\Stripe\File, explanation: null|string, product_description: null|string, product_type: null|string}&\Stripe\StripeObject&\stdClass, reason: string, service_not_as_described?: object{additional_documentation: null|string|\Stripe\File, canceled_at: null|int, cancellation_reason: null|string, explanation: null|string, received_at: null|int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $evidence + * @property (object{canceled?: (object{additional_documentation: null|string|\Stripe\File, canceled_at: null|int, cancellation_policy_provided: null|bool, cancellation_reason: null|string, expected_at: null|int, explanation: null|string, product_description: null|string, product_type: null|string, return_status: null|string, returned_at: null|int}&\Stripe\StripeObject&\stdClass), duplicate?: (object{additional_documentation: null|string|\Stripe\File, card_statement: null|string|\Stripe\File, cash_receipt: null|string|\Stripe\File, check_image: null|string|\Stripe\File, explanation: null|string, original_transaction: null|string}&\Stripe\StripeObject&\stdClass), fraudulent?: (object{additional_documentation: null|string|\Stripe\File, explanation: null|string}&\Stripe\StripeObject&\stdClass), merchandise_not_as_described?: (object{additional_documentation: null|string|\Stripe\File, explanation: null|string, received_at: null|int, return_description: null|string, return_status: null|string, returned_at: null|int}&\Stripe\StripeObject&\stdClass), no_valid_authorization?: (object{additional_documentation: null|string|\Stripe\File, explanation: null|string}&\Stripe\StripeObject&\stdClass), not_received?: (object{additional_documentation: null|string|\Stripe\File, expected_at: null|int, explanation: null|string, product_description: null|string, product_type: null|string}&\Stripe\StripeObject&\stdClass), other?: (object{additional_documentation: null|string|\Stripe\File, explanation: null|string, product_description: null|string, product_type: null|string}&\Stripe\StripeObject&\stdClass), reason: string, service_not_as_described?: (object{additional_documentation: null|string|\Stripe\File, canceled_at: null|int, cancellation_reason: null|string, explanation: null|string, received_at: null|int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $evidence * @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 null|string $loss_reason The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values. * @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 $status Current status of the dispute. * @property string|\Stripe\Issuing\Transaction $transaction The transaction being disputed. - * @property null|object{debit_reversal: null|string, received_debit: string}&\Stripe\StripeObject&\stdClass $treasury Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + * @property null|(object{debit_reversal: null|string, received_debit: string}&\Stripe\StripeObject&\stdClass) $treasury Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ class Dispute extends \Stripe\ApiResource { @@ -127,7 +127,7 @@ public static function retrieve($id, $opts = null) * empty string. * * @param string $id the ID of the resource to update - * @param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Issuing/PersonalizationDesign.php b/lib/Issuing/PersonalizationDesign.php index 39f384fc0..7426c8a39 100644 --- a/lib/Issuing/PersonalizationDesign.php +++ b/lib/Issuing/PersonalizationDesign.php @@ -10,15 +10,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 null|string|\Stripe\File $card_logo The file for the card logo to use with physical bundles that support card logos. Must have a purpose value of issuing_logo. - * @property null|object{footer_body: null|string, footer_title: null|string, header_body: null|string, header_title: null|string}&\Stripe\StripeObject&\stdClass $carrier_text Hash containing carrier text, for use with physical bundles that support carrier text. + * @property null|(object{footer_body: null|string, footer_title: null|string, header_body: null|string, header_title: null|string}&\Stripe\StripeObject&\stdClass) $carrier_text Hash containing carrier text, for use with physical bundles that support carrier text. * @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 null|string $lookup_key A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. * @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 null|string $name Friendly display name. * @property string|\Stripe\Issuing\PhysicalBundle $physical_bundle The physical bundle object belonging to this personalization design. - * @property object{is_default: bool, is_platform_default: null|bool}&\Stripe\StripeObject&\stdClass $preferences - * @property object{card_logo: null|string[], carrier_text: null|string[]}&\Stripe\StripeObject&\stdClass $rejection_reasons + * @property (object{is_default: bool, is_platform_default: null|bool}&\Stripe\StripeObject&\stdClass) $preferences + * @property (object{card_logo: null|string[], carrier_text: null|string[]}&\Stripe\StripeObject&\stdClass) $rejection_reasons * @property string $status Whether this personalization design can be used to create cards. */ class PersonalizationDesign extends \Stripe\ApiResource diff --git a/lib/Issuing/PhysicalBundle.php b/lib/Issuing/PhysicalBundle.php index b5d803342..5b31ef2f0 100644 --- a/lib/Issuing/PhysicalBundle.php +++ b/lib/Issuing/PhysicalBundle.php @@ -9,7 +9,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 object{card_logo: string, carrier_text: string, second_line: string}&\Stripe\StripeObject&\stdClass $features + * @property (object{card_logo: string, carrier_text: string, second_line: string}&\Stripe\StripeObject&\stdClass) $features * @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 $name Friendly display name. * @property string $status Whether this physical bundle can be used to create cards. diff --git a/lib/Issuing/Token.php b/lib/Issuing/Token.php index f6eba83c4..9c1d93d76 100644 --- a/lib/Issuing/Token.php +++ b/lib/Issuing/Token.php @@ -15,7 +15,7 @@ * @property null|string $last4 The last four digits of the token. * @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 $network The token service provider / card network associated with the token. - * @property null|object{device?: object{device_fingerprint?: string, ip_address?: string, location?: string, name?: string, phone_number?: string, type?: string}&\Stripe\StripeObject&\stdClass, mastercard?: object{card_reference_id?: string, token_reference_id: string, token_requestor_id: string, token_requestor_name?: string}&\Stripe\StripeObject&\stdClass, type: string, visa?: object{card_reference_id: string, token_reference_id: string, token_requestor_id: string, token_risk_score?: string}&\Stripe\StripeObject&\stdClass, wallet_provider?: object{account_id?: string, account_trust_score?: int, card_number_source?: string, cardholder_address?: object{line1: string, postal_code: string}&\Stripe\StripeObject&\stdClass, cardholder_name?: string, device_trust_score?: int, hashed_account_email_address?: string, reason_codes?: string[], suggested_decision?: string, suggested_decision_version?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $network_data + * @property null|(object{device?: (object{device_fingerprint?: string, ip_address?: string, location?: string, name?: string, phone_number?: string, type?: string}&\Stripe\StripeObject&\stdClass), mastercard?: (object{card_reference_id?: string, token_reference_id: string, token_requestor_id: string, token_requestor_name?: string}&\Stripe\StripeObject&\stdClass), type: string, visa?: (object{card_reference_id: string, token_reference_id: string, token_requestor_id: string, token_risk_score?: string}&\Stripe\StripeObject&\stdClass), wallet_provider?: (object{account_id?: string, account_trust_score?: int, card_number_source?: string, cardholder_address?: (object{line1: string, postal_code: string}&\Stripe\StripeObject&\stdClass), cardholder_name?: string, device_trust_score?: int, hashed_account_email_address?: string, reason_codes?: string[], suggested_decision?: string, suggested_decision_version?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $network_data * @property int $network_updated_at Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. * @property string $status The usage state of the token. * @property null|string $wallet_provider The digital wallet for this token, if one was used. diff --git a/lib/Issuing/Transaction.php b/lib/Issuing/Transaction.php index c09242e46..e8d214da4 100644 --- a/lib/Issuing/Transaction.php +++ b/lib/Issuing/Transaction.php @@ -14,7 +14,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 The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit. - * @property null|object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit. + * @property null|(object{atm_fee: null|int, cashback_amount: null|int}&\Stripe\StripeObject&\stdClass) $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit. * @property null|string|\Stripe\Issuing\Authorization $authorization The Authorization object that led to this transaction. * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction associated with this transaction. * @property string|\Stripe\Issuing\Card $card The card used to make this transaction. @@ -25,13 +25,13 @@ * @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 and in the smallest currency unit. 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 object{category: string, category_code: string, city: null|string, country: null|string, name: null|string, network_id: string, postal_code: null|string, state: null|string, terminal_id: null|string, url: null|string}&\Stripe\StripeObject&\stdClass $merchant_data + * @property (object{category: string, category_code: string, city: null|string, country: null|string, name: null|string, network_id: string, postal_code: null|string, state: null|string, terminal_id: null|string, url: null|string}&\Stripe\StripeObject&\stdClass) $merchant_data * @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 null|object{authorization_code: null|string, processing_date: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass $network_data Details about the transaction, such as processing dates, set by the card network. - * @property null|object{fleet: null|object{cardholder_prompt_data: null|object{driver_id: null|string, odometer: null|int, unspecified_id: null|string, user_id: null|string, vehicle_number: null|string}&\Stripe\StripeObject&\stdClass, purchase_type: null|string, reported_breakdown: null|object{fuel: null|object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass, non_fuel: null|object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass, tax: null|object{local_amount_decimal: null|string, national_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, service_type: null|string}&\Stripe\StripeObject&\stdClass, flight: null|object{departure_at: null|int, passenger_name: null|string, refundable: null|bool, segments: null|(object{arrival_airport_code: null|string, carrier: null|string, departure_airport_code: null|string, flight_number: null|string, service_class: null|string, stopover_allowed: null|bool}&\Stripe\StripeObject&\stdClass)[], travel_agency: null|string}&\Stripe\StripeObject&\stdClass, fuel: null|object{industry_product_code: null|string, quantity_decimal: null|string, type: string, unit: string, unit_cost_decimal: string}&\Stripe\StripeObject&\stdClass, lodging: null|object{check_in_at: null|int, nights: null|int}&\Stripe\StripeObject&\stdClass, receipt: null|(object{description: null|string, quantity: null|float, total: null|int, unit_cost: null|int}&\Stripe\StripeObject&\stdClass)[], reference: null|string}&\Stripe\StripeObject&\stdClass $purchase_details Additional purchase information that is optionally provided by the merchant. + * @property null|(object{authorization_code: null|string, processing_date: null|string, transaction_id: null|string}&\Stripe\StripeObject&\stdClass) $network_data Details about the transaction, such as processing dates, set by the card network. + * @property null|(object{fleet: null|(object{cardholder_prompt_data: null|(object{driver_id: null|string, odometer: null|int, unspecified_id: null|string, user_id: null|string, vehicle_number: null|string}&\Stripe\StripeObject&\stdClass), purchase_type: null|string, reported_breakdown: null|(object{fuel: null|(object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass), non_fuel: null|(object{gross_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass), tax: null|(object{local_amount_decimal: null|string, national_amount_decimal: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), service_type: null|string}&\Stripe\StripeObject&\stdClass), flight: null|(object{departure_at: null|int, passenger_name: null|string, refundable: null|bool, segments: null|((object{arrival_airport_code: null|string, carrier: null|string, departure_airport_code: null|string, flight_number: null|string, service_class: null|string, stopover_allowed: null|bool}&\Stripe\StripeObject&\stdClass))[], travel_agency: null|string}&\Stripe\StripeObject&\stdClass), fuel: null|(object{industry_product_code: null|string, quantity_decimal: null|string, type: string, unit: string, unit_cost_decimal: string}&\Stripe\StripeObject&\stdClass), lodging: null|(object{check_in_at: null|int, nights: null|int}&\Stripe\StripeObject&\stdClass), receipt: null|((object{description: null|string, quantity: null|float, total: null|int, unit_cost: null|int}&\Stripe\StripeObject&\stdClass))[], reference: null|string}&\Stripe\StripeObject&\stdClass) $purchase_details Additional purchase information that is optionally provided by the merchant. * @property null|string|\Stripe\Issuing\Settlement $settlement * @property null|string|\Stripe\Issuing\Token $token Token object used for this transaction. If a network token was not used for this transaction, this field will be null. - * @property null|object{received_credit: null|string, received_debit: null|string}&\Stripe\StripeObject&\stdClass $treasury Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + * @property null|(object{received_credit: null|string, received_debit: null|string}&\Stripe\StripeObject&\stdClass) $treasury Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts * @property string $type The nature of the transaction. * @property null|string $wallet The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. */ @@ -92,7 +92,7 @@ public static function retrieve($id, $opts = null) * unchanged. * * @param string $id the ID of the resource to update - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/LineItem.php b/lib/LineItem.php index adba78b2b..a8438ddc9 100644 --- a/lib/LineItem.php +++ b/lib/LineItem.php @@ -9,20 +9,20 @@ * * @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|object{enabled: bool, maximum: null|int, minimum: null|int}&\Stripe\StripeObject&\stdClass $adjustable_quantity + * @property null|(object{enabled: bool, maximum: null|int, minimum: null|int}&\Stripe\StripeObject&\stdClass) $adjustable_quantity * @property int $amount_discount Total discount amount applied. If no discounts were applied, defaults to 0. * @property int $amount_subtotal Total before any discounts or taxes are applied. * @property int $amount_tax Total tax amount applied. If no tax was applied, defaults to 0. * @property int $amount_total Total after discounts and taxes. * @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. Defaults to product name. - * @property null|object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass[] $discounts The discounts applied to the line item. - * @property object{description: null|string, images: string[], name: string}&\Stripe\StripeObject&\stdClass $display - * @property null|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|(object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass)[] $discounts The discounts applied to the line item. + * @property (object{description: null|string, images: string[], name: string}&\Stripe\StripeObject&\stdClass) $display + * @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|\Stripe\Price $price The price used to generate the line item. * @property null|string|\Stripe\Product $product

The ID of the product for this line item.

This will always be the same as price.product.

* @property null|int $quantity The quantity of products being purchased. - * @property (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[] $taxes The taxes applied to the line item. + * @property ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[] $taxes The taxes applied to the line item. */ class LineItem extends ApiResource { diff --git a/lib/Mandate.php b/lib/Mandate.php index 738ec31cf..f4776eca7 100644 --- a/lib/Mandate.php +++ b/lib/Mandate.php @@ -9,13 +9,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 object{accepted_at: null|int, offline?: object{}&\Stripe\StripeObject&\stdClass, online?: object{ip_address: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $customer_acceptance + * @property (object{accepted_at: null|int, offline?: (object{}&\Stripe\StripeObject&\stdClass), online?: (object{ip_address: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $customer_acceptance * @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 null|object{}&\Stripe\StripeObject&\stdClass $multi_use + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $multi_use * @property null|string $on_behalf_of The account (if any) that the mandate is intended for. * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method associated with this mandate. - * @property object{acss_debit?: object{default_for?: string[], interval_description: null|string, payment_schedule: string, transaction_type: string}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{}&\Stripe\StripeObject&\stdClass, au_becs_debit?: object{url: string}&\Stripe\StripeObject&\stdClass, bacs_debit?: object{network_status: string, reference: string, revocation_reason: null|string, url: string}&\Stripe\StripeObject&\stdClass, card?: object{}&\Stripe\StripeObject&\stdClass, cashapp?: object{}&\Stripe\StripeObject&\stdClass, kakao_pay?: object{}&\Stripe\StripeObject&\stdClass, kr_card?: object{}&\Stripe\StripeObject&\stdClass, link?: object{}&\Stripe\StripeObject&\stdClass, paypal?: object{billing_agreement_id: null|string, fingerprint?: null|string, payer_id: null|string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass, payto?: object{amount: null|int, amount_type: string, end_date: null|string, payment_schedule: string, payments_per_period: null|int, purpose: null|string, start_date: null|string}&\Stripe\StripeObject&\stdClass, revolut_pay?: object{}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{reference: string, url: string}&\Stripe\StripeObject&\stdClass, type: string, us_bank_account?: object{collection_method?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_details - * @property null|object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass $single_use + * @property (object{acss_debit?: (object{default_for?: string[], interval_description: null|string, payment_schedule: string, transaction_type: string}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{}&\Stripe\StripeObject&\stdClass), au_becs_debit?: (object{url: string}&\Stripe\StripeObject&\stdClass), bacs_debit?: (object{network_status: string, reference: string, revocation_reason: null|string, url: string}&\Stripe\StripeObject&\stdClass), card?: (object{}&\Stripe\StripeObject&\stdClass), cashapp?: (object{}&\Stripe\StripeObject&\stdClass), kakao_pay?: (object{}&\Stripe\StripeObject&\stdClass), kr_card?: (object{}&\Stripe\StripeObject&\stdClass), link?: (object{}&\Stripe\StripeObject&\stdClass), paypal?: (object{billing_agreement_id: null|string, fingerprint?: null|string, payer_id: null|string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass), payto?: (object{amount: null|int, amount_type: string, end_date: null|string, payment_schedule: string, payments_per_period: null|int, purpose: null|string, start_date: null|string}&\Stripe\StripeObject&\stdClass), revolut_pay?: (object{}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{reference: string, url: string}&\Stripe\StripeObject&\stdClass), type: string, us_bank_account?: (object{collection_method?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payment_method_details + * @property null|(object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass) $single_use * @property string $status The mandate status indicates whether or not you can use it to initiate a payment. * @property string $type The type of the mandate. */ diff --git a/lib/Margin.php b/lib/Margin.php index 6f53694a0..3748b5720 100644 --- a/lib/Margin.php +++ b/lib/Margin.php @@ -13,7 +13,7 @@ * @property bool $active Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to true. * @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 null|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|\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 margin that's displayed on, for example, invoices. * @property float $percent_off Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied. * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch. diff --git a/lib/Order.php b/lib/Order.php index 897e6f1c2..f94d238e5 100644 --- a/lib/Order.php +++ b/lib/Order.php @@ -17,11 +17,11 @@ * @property int $amount_subtotal Order cost before any discounts or taxes are applied. A positive integer representing the subtotal of the order in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). * @property int $amount_total Total order cost after discounts and taxes are applied. A positive integer representing the cost of the order in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or equivalent in charge currency. * @property null|string|\Stripe\Application $application ID of the Connect application that created the Order, if any. - * @property object{enabled: bool, status: null|string}&\Stripe\StripeObject&\stdClass $automatic_tax - * @property null|object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $billing_details Customer billing details associated with the order. + * @property (object{enabled: bool, status: null|string}&\Stripe\StripeObject&\stdClass) $automatic_tax + * @property null|(object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $billing_details Customer billing details associated with the order. * @property null|string $client_secret

The client secret of this Order. Used for client-side retrieval using a publishable key.

The client secret can be used to complete a payment for an Order 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 for creating and processing an order to learn about how client_secret should be handled.

* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property (object{amount: int, gift_card: null|object{card: string}&\Stripe\StripeObject&\stdClass, ineligible_line_items: null|string[], type: string}&\Stripe\StripeObject&\stdClass)[] $credits The credits applied to the Order. At most 10 credits can be applied to an Order. + * @property ((object{amount: int, gift_card: null|(object{card: string}&\Stripe\StripeObject&\stdClass), ineligible_line_items: null|string[], type: string}&\Stripe\StripeObject&\stdClass))[] $credits The credits applied to the Order. At most 10 credits can be applied to an Order. * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property null|string|\Stripe\Customer $customer The customer which this orders belongs to. * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. @@ -29,13 +29,13 @@ * @property null|string $ip_address A recent IP address of the purchaser used for tax reporting and tax location inference. * @property null|\Stripe\Collection<\Stripe\LineItem> $line_items A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. There is a maximum of 100 line 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 null|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 object{payment_intent: null|string|\Stripe\PaymentIntent, settings: null|object{application_fee_amount: null|int, automatic_payment_methods: null|object{enabled: bool}&\Stripe\StripeObject&\stdClass, payment_method_options: null|object{acss_debit?: object{mandate_options?: object{custom_mandate_url?: string, interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass, afterpay_clearpay?: object{capture_method?: string, reference: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, alipay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, bancontact?: object{preferred_language: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, card?: object{capture_method: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, customer_balance?: object{bank_transfer?: object{eu_bank_transfer?: object{country: string}&\Stripe\StripeObject&\stdClass, requested_address_types?: string[], type: null|string}&\Stripe\StripeObject&\stdClass, funding_type: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, ideal?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, klarna?: object{capture_method?: string, preferred_locale: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, link?: object{capture_method?: string, persistent_token: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, oxxo?: object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, p24?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, paypal?: object{capture_method?: string, line_items?: object{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: object{amount: int, behavior: string}&\Stripe\StripeObject&\stdClass, unit_amount: int}&\Stripe\StripeObject&\stdClass[], preferred_locale: null|string, reference: null|string, reference_id?: null|string, setup_future_usage?: string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{mandate_options?: object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, sofort?: object{preferred_language: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, wechat_pay?: object{app_id: null|string, client: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payment_method_types: null|string[], return_url: null|string, statement_descriptor: null|string, statement_descriptor_suffix: null|string, transfer_data: null|object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, status: null|string}&\Stripe\StripeObject&\stdClass $payment - * @property null|object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $shipping_cost The details of the customer cost of shipping, including the customer chosen ShippingRate. - * @property null|object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $shipping_details Customer shipping information associated with the order. + * @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 (object{payment_intent: null|string|\Stripe\PaymentIntent, settings: null|(object{application_fee_amount: null|int, automatic_payment_methods: null|(object{enabled: bool}&\Stripe\StripeObject&\stdClass), payment_method_options: null|(object{acss_debit?: (object{mandate_options?: (object{custom_mandate_url?: string, interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass), afterpay_clearpay?: (object{capture_method?: string, reference: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), alipay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), bancontact?: (object{preferred_language: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), card?: (object{capture_method: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), customer_balance?: (object{bank_transfer?: (object{eu_bank_transfer?: (object{country: string}&\Stripe\StripeObject&\stdClass), requested_address_types?: string[], type: null|string}&\Stripe\StripeObject&\stdClass), funding_type: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), ideal?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), klarna?: (object{capture_method?: string, preferred_locale: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), link?: (object{capture_method?: string, persistent_token: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), oxxo?: (object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), p24?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), paypal?: (object{capture_method?: string, line_items?: (object{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: (object{amount: int, behavior: string}&\Stripe\StripeObject&\stdClass), unit_amount: int}&\Stripe\StripeObject&\stdClass)[], preferred_locale: null|string, reference: null|string, reference_id?: null|string, setup_future_usage?: string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{mandate_options?: (object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), sofort?: (object{preferred_language: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), wechat_pay?: (object{app_id: null|string, client: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payment_method_types: null|string[], return_url: null|string, statement_descriptor: null|string, statement_descriptor_suffix: null|string, transfer_data: null|(object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), status: null|string}&\Stripe\StripeObject&\stdClass) $payment + * @property null|(object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $shipping_cost The details of the customer cost of shipping, including the customer chosen ShippingRate. + * @property null|(object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $shipping_details Customer shipping information associated with the order. * @property string $status The overall status of the order. - * @property object{tax_exempt: string, tax_ids: (object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $tax_details - * @property object{amount_credit?: int, amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: object{discounts: object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass[], taxes: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $total_details + * @property (object{tax_exempt: string, tax_ids: ((object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $tax_details + * @property (object{amount_credit?: int, amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: (object{discounts: (object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass)[], taxes: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $total_details */ class Order extends ApiResource { @@ -52,7 +52,7 @@ class Order extends ApiResource /** * Creates a new open order object. * - * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency: string, customer?: string, description?: string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: \Stripe\StripeObject, payment?: array{settings: array{application_fee_amount?: int, payment_method_options?: array{acss_debit?: array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: array{setup_future_usage?: null|string}, bancontact?: array{preferred_language?: string, setup_future_usage?: null|string}, card?: array{capture_method?: string, setup_future_usage?: string}, customer_balance?: array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: array{setup_future_usage?: null|string}, klarna?: array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: array{expires_after_days?: int, setup_future_usage?: string}, p24?: array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params + * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency: string, customer?: string, description?: string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|\Stripe\StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: \Stripe\StripeObject, payment?: array{settings: array{application_fee_amount?: int, payment_method_options?: array{acss_debit?: array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: array{setup_future_usage?: null|string}, bancontact?: array{preferred_language?: string, setup_future_usage?: null|string}, card?: array{capture_method?: string, setup_future_usage?: string}, customer_balance?: array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: array{setup_future_usage?: null|string}, klarna?: array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: array{expires_after_days?: int, setup_future_usage?: string}, p24?: array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -115,7 +115,7 @@ public static function retrieve($id, $opts = null) * parameters not provided will be left unchanged. * * @param string $id the ID of the resource to update - * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency?: string, customer?: string, description?: null|string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items?: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], id?: string, price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|StripeObject, payment?: array{settings: array{application_fee_amount?: null|int, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: null|array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, card?: null|array{capture_method?: string, setup_future_usage?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: null|string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: null|array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params + * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency?: string, customer?: string, description?: null|string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items?: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], id?: string, price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|\Stripe\StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|\Stripe\StripeObject, payment?: array{settings: array{application_fee_amount?: null|int, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: null|array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, card?: null|array{capture_method?: string, setup_future_usage?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: null|string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: null|array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/PaymentAttemptRecord.php b/lib/PaymentAttemptRecord.php index 65df33d70..888feb869 100644 --- a/lib/PaymentAttemptRecord.php +++ b/lib/PaymentAttemptRecord.php @@ -12,20 +12,20 @@ * * @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 object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_canceled A representation of an amount of money, consisting of an amount and a currency. - * @property object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_failed A representation of an amount of money, consisting of an amount and a currency. - * @property object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_guaranteed A representation of an amount of money, consisting of an amount and a currency. - * @property object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_requested A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_canceled A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_failed A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_guaranteed A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_requested A representation of an amount of money, consisting of an amount and a currency. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|object{customer: null|string, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $customer_details Customer information for this payment. + * @property null|(object{customer: null|string, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $customer_details Customer information for this payment. * @property null|string $customer_presence Indicates whether the customer was present in your checkout flow during this payment. * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. * @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 null|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|object{billing_details: null|object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass, custom: null|object{display_name: string, type: null|string}&\Stripe\StripeObject&\stdClass, payment_method: null|string, type: string}&\Stripe\StripeObject&\stdClass $payment_method_details Information about the Payment Method debited for this payment. + * @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|(object{billing_details: null|(object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass), custom: null|(object{display_name: string, type: null|string}&\Stripe\StripeObject&\stdClass), payment_method: null|string, type: string}&\Stripe\StripeObject&\stdClass) $payment_method_details Information about the Payment Method debited for this payment. * @property string $payment_record ID of the Payment Record this Payment Attempt Record belongs to. * @property null|string $payment_reference An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID. - * @property null|object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $shipping_details Shipping information for this payment. + * @property null|(object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $shipping_details Shipping information for this payment. */ class PaymentAttemptRecord extends ApiResource { diff --git a/lib/PaymentIntent.php b/lib/PaymentIntent.php index 337c5c6d2..5dc13e0ba 100644 --- a/lib/PaymentIntent.php +++ b/lib/PaymentIntent.php @@ -21,12 +21,12 @@ * @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 null|object{tip?: object{amount?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $amount_details + * @property null|(object{tip?: (object{amount?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $amount_details * @property int $amount_received Amount that this PaymentIntent collects. * @property null|string|\Stripe\Application $application ID of the Connect application that created the PaymentIntent. * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts. - * @property null|object{inputs?: object{tax?: object{calculation: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $async_workflows - * @property null|object{allow_redirects?: string, enabled: bool}&\Stripe\StripeObject&\stdClass $automatic_payment_methods Settings to configure compatible payment methods from the Stripe Dashboard + * @property null|(object{inputs?: (object{tax?: (object{calculation: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $async_workflows + * @property null|(object{allow_redirects?: string, enabled: bool}&\Stripe\StripeObject&\stdClass) $automatic_payment_methods Settings to configure compatible payment methods from the Stripe Dashboard * @property null|int $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 null|string $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. @@ -37,28 +37,28 @@ * @property null|string|\Stripe\Customer $customer

ID of the Customer this PaymentIntent belongs to, if one exists.

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If setup_future_usage is set and this PaymentIntent's payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.

* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. * @property null|string|\Stripe\Invoice $invoice ID of the invoice that created this PaymentIntent, if it exists. - * @property null|object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass $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 null|(object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass) $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 null|string|\Stripe\Charge $latest_charge ID of the latest Charge object created by this PaymentIntent. This property is null until PaymentIntent confirmation is attempted. * @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. Learn more about storing information in metadata. - * @property null|object{alipay_handle_redirect?: object{native_data: null|string, native_url: null|string, return_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass, boleto_display_details?: object{expires_at: null|int, hosted_voucher_url: null|string, number: null|string, pdf: null|string}&\Stripe\StripeObject&\stdClass, card_await_notification?: object{charge_attempt_at: null|int, customer_approval_required: null|bool}&\Stripe\StripeObject&\stdClass, cashapp_handle_redirect_or_display_qr_code?: object{hosted_instructions_url: string, mobile_auth_url: string, qr_code: object{expires_at: int, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, display_bank_transfer_instructions?: object{amount_remaining: null|int, currency: null|string, financial_addresses?: (object{aba?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, account_number: string, account_type: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_name: string, routing_number: string}&\Stripe\StripeObject&\stdClass, iban?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bic: string, country: string, iban: string}&\Stripe\StripeObject&\stdClass, sort_code?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, account_number: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, sort_code: string}&\Stripe\StripeObject&\stdClass, spei?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_code: string, bank_name: string, clabe: string}&\Stripe\StripeObject&\stdClass, supported_networks?: string[], swift?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: string, account_number: string, account_type: string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_name: string, swift_code: string}&\Stripe\StripeObject&\stdClass, type: string, zengin?: object{account_holder_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, account_holder_name: null|string, account_number: null|string, account_type: null|string, bank_address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, bank_code: null|string, bank_name: null|string, branch_code: null|string, branch_name: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[], hosted_instructions_url: null|string, reference: null|string, type: string}&\Stripe\StripeObject&\stdClass, konbini_display_details?: object{expires_at: int, hosted_voucher_url: null|string, stores: object{familymart: null|object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass, lawson: null|object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass, ministop: null|object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass, seicomart: null|object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, multibanco_display_details?: object{entity: null|string, expires_at: null|int, hosted_voucher_url: null|string, reference: null|string}&\Stripe\StripeObject&\stdClass, oxxo_display_details?: object{expires_after: null|int, hosted_voucher_url: null|string, number: null|string}&\Stripe\StripeObject&\stdClass, paynow_display_qr_code?: object{data: string, hosted_instructions_url: null|string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass, pix_display_qr_code?: object{data?: string, expires_at?: int, hosted_instructions_url?: string, image_url_png?: string, image_url_svg?: string}&\Stripe\StripeObject&\stdClass, promptpay_display_qr_code?: object{data: string, hosted_instructions_url: string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass, redirect_to_url?: object{return_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass, swish_handle_redirect_or_display_qr_code?: object{hosted_instructions_url: string, mobile_auth_url: string, qr_code: object{data: string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, type: string, use_stripe_sdk?: \Stripe\StripeObject, verify_with_microdeposits?: object{arrival_date: int, hosted_verification_url: string, microdeposit_type: null|string}&\Stripe\StripeObject&\stdClass, wechat_pay_display_qr_code?: object{data: string, hosted_instructions_url: string, image_data_url: string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass, wechat_pay_redirect_to_android_app?: object{app_id: string, nonce_str: string, package: string, partner_id: string, prepay_id: string, sign: string, timestamp: string}&\Stripe\StripeObject&\stdClass, wechat_pay_redirect_to_ios_app?: object{native_url: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $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 null|(object{alipay_handle_redirect?: (object{native_data: null|string, native_url: null|string, return_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass), boleto_display_details?: (object{expires_at: null|int, hosted_voucher_url: null|string, number: null|string, pdf: null|string}&\Stripe\StripeObject&\stdClass), card_await_notification?: (object{charge_attempt_at: null|int, customer_approval_required: null|bool}&\Stripe\StripeObject&\stdClass), cashapp_handle_redirect_or_display_qr_code?: (object{hosted_instructions_url: string, mobile_auth_url: string, qr_code: (object{expires_at: int, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), display_bank_transfer_instructions?: (object{amount_remaining: null|int, currency: null|string, financial_addresses?: ((object{aba?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, account_number: string, account_type: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_name: string, routing_number: string}&\Stripe\StripeObject&\stdClass), iban?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bic: string, country: string, iban: string}&\Stripe\StripeObject&\stdClass), sort_code?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, account_number: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), sort_code: string}&\Stripe\StripeObject&\stdClass), spei?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_code: string, bank_name: string, clabe: string}&\Stripe\StripeObject&\stdClass), supported_networks?: string[], swift?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: string, account_number: string, account_type: string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_name: string, swift_code: string}&\Stripe\StripeObject&\stdClass), type: string, zengin?: (object{account_holder_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), account_holder_name: null|string, account_number: null|string, account_type: null|string, bank_address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), bank_code: null|string, bank_name: null|string, branch_code: null|string, branch_name: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[], hosted_instructions_url: null|string, reference: null|string, type: string}&\Stripe\StripeObject&\stdClass), konbini_display_details?: (object{expires_at: int, hosted_voucher_url: null|string, stores: (object{familymart: null|(object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass), lawson: null|(object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass), ministop: null|(object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass), seicomart: null|(object{confirmation_number?: string, payment_code: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), multibanco_display_details?: (object{entity: null|string, expires_at: null|int, hosted_voucher_url: null|string, reference: null|string}&\Stripe\StripeObject&\stdClass), oxxo_display_details?: (object{expires_after: null|int, hosted_voucher_url: null|string, number: null|string}&\Stripe\StripeObject&\stdClass), paynow_display_qr_code?: (object{data: string, hosted_instructions_url: null|string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass), pix_display_qr_code?: (object{data?: string, expires_at?: int, hosted_instructions_url?: string, image_url_png?: string, image_url_svg?: string}&\Stripe\StripeObject&\stdClass), promptpay_display_qr_code?: (object{data: string, hosted_instructions_url: string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass), redirect_to_url?: (object{return_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass), swish_handle_redirect_or_display_qr_code?: (object{hosted_instructions_url: string, mobile_auth_url: string, qr_code: (object{data: string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), type: string, use_stripe_sdk?: \Stripe\StripeObject, verify_with_microdeposits?: (object{arrival_date: int, hosted_verification_url: string, microdeposit_type: null|string}&\Stripe\StripeObject&\stdClass), wechat_pay_display_qr_code?: (object{data: string, hosted_instructions_url: string, image_data_url: string, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass), wechat_pay_redirect_to_android_app?: (object{app_id: string, nonce_str: string, package: string, partner_id: string, prepay_id: string, sign: string, timestamp: string}&\Stripe\StripeObject&\stdClass), wechat_pay_redirect_to_ios_app?: (object{native_url: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $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 null|string|\Stripe\Account $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 object{car_rental?: object{affiliate?: object{name?: string}&\Stripe\StripeObject&\stdClass, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: object{mode?: string, recipient?: object{email?: string, name?: string, phone?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, drivers?: object{name?: string}&\Stripe\StripeObject&\stdClass[], extra_charges?: string[], no_show?: bool, pickup_address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, return_at: int, tax_exempt?: bool}&\Stripe\StripeObject&\stdClass, event_details?: object{access_controlled_venue?: bool, address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, affiliate?: object{name?: string}&\Stripe\StripeObject&\stdClass, company?: string, delivery?: object{mode?: string, recipient?: object{email?: string, name?: string, phone?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, ends_at?: int, genre?: string, name?: string, starts_at?: int}&\Stripe\StripeObject&\stdClass, subscription?: object{affiliate?: object{name?: string}&\Stripe\StripeObject&\stdClass, auto_renewal?: bool, billing_interval?: object{count?: int, interval?: string}&\Stripe\StripeObject&\stdClass, ends_at?: int, name?: string, starts_at?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_details + * @property (object{car_rental?: (object{affiliate?: (object{name?: string}&\Stripe\StripeObject&\stdClass), booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: (object{mode?: string, recipient?: (object{email?: string, name?: string, phone?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), drivers?: (object{name?: string}&\Stripe\StripeObject&\stdClass)[], extra_charges?: string[], no_show?: bool, pickup_address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), return_at: int, tax_exempt?: bool}&\Stripe\StripeObject&\stdClass), event_details?: (object{access_controlled_venue?: bool, address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), affiliate?: (object{name?: string}&\Stripe\StripeObject&\stdClass), company?: string, delivery?: (object{mode?: string, recipient?: (object{email?: string, name?: string, phone?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), ends_at?: int, genre?: string, name?: string, starts_at?: int}&\Stripe\StripeObject&\stdClass), subscription?: (object{affiliate?: (object{name?: string}&\Stripe\StripeObject&\stdClass), auto_renewal?: bool, billing_interval?: (object{count?: int, interval?: string}&\Stripe\StripeObject&\stdClass), ends_at?: int, name?: string, starts_at?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payment_details * @property null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used in this PaymentIntent. - * @property null|object{id: string, parent: null|string}&\Stripe\StripeObject&\stdClass $payment_method_configuration_details Information about the payment method configuration used for this PaymentIntent. - * @property null|object{acss_debit?: object{mandate_options?: object{custom_mandate_url?: string, interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass, affirm?: object{capture_method?: string, preferred_locale?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, afterpay_clearpay?: object{capture_method?: string, reference: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, alipay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, alma?: object{capture_method?: string}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, au_becs_debit?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, bacs_debit?: object{mandate_options?: object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, bancontact?: object{preferred_language: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, blik?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, boleto?: object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, card?: object{capture_method?: string, installments: null|object{available_plans: null|(object{count: null|int, interval: null|string, type: string}&\Stripe\StripeObject&\stdClass)[], enabled: bool, plan: null|object{count: null|int, interval: null|string, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, mandate_options: null|object{amount: int, amount_type: string, description: null|string, end_date: null|int, interval: string, interval_count: null|int, reference: string, start_date: int, supported_types: null|string[]}&\Stripe\StripeObject&\stdClass, network: null|string, request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_partial_authorization?: string, request_three_d_secure: null|string, require_cvc_recollection?: bool, setup_future_usage?: string, statement_descriptor_suffix_kana?: string, statement_descriptor_suffix_kanji?: string, statement_details?: object{address?: object{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}&\Stripe\StripeObject&\stdClass, phone?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, card_present?: object{request_extended_authorization: null|bool, request_incremental_authorization_support: null|bool, routing?: object{requested_priority: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, cashapp?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, customer_balance?: object{bank_transfer?: object{eu_bank_transfer?: object{country: string}&\Stripe\StripeObject&\stdClass, requested_address_types?: string[], type: null|string}&\Stripe\StripeObject&\stdClass, funding_type: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, eps?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, fpx?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, giropay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, gopay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, grabpay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: object{expires_after?: null|int, expires_at: null|int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, ideal?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, interac_present?: object{}&\Stripe\StripeObject&\stdClass, kakao_pay?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, klarna?: object{capture_method?: string, preferred_locale: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, konbini?: object{confirmation_number: null|string, expires_after_days: null|int, expires_at: null|int, product_description: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, kr_card?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, link?: object{capture_method?: string, persistent_token: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, mb_way?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, mobilepay?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, multibanco?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, naver_pay?: object{capture_method?: string}&\Stripe\StripeObject&\stdClass, oxxo?: object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, p24?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, payco?: object{capture_method?: string}&\Stripe\StripeObject&\stdClass, paynow?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, paypal?: object{capture_method?: string, line_items?: object{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: object{amount: int, behavior: string}&\Stripe\StripeObject&\stdClass, unit_amount: int}&\Stripe\StripeObject&\stdClass[], preferred_locale: null|string, reference: null|string, reference_id?: null|string, setup_future_usage?: string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass, payto?: object{mandate_options?: object{amount: null|int, amount_type: null|string, end_date: null|string, payment_schedule: null|string, payments_per_period: null|int, purpose: null|string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, pix?: object{expires_after_seconds: null|int, expires_at: null|int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, promptpay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, qris?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, rechnung?: object{}&\Stripe\StripeObject&\stdClass, revolut_pay?: object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, samsung_pay?: object{capture_method?: string}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{mandate_options?: object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, shopeepay?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, sofort?: object{preferred_language: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, swish?: object{reference: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, twint?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, us_bank_account?: object{financial_connections?: object{filters?: object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass, manual_entry?: object{mode?: string}&\Stripe\StripeObject&\stdClass, permissions?: string[], prefetch: null|string[], return_url?: string}&\Stripe\StripeObject&\stdClass, mandate_options?: object{collection_method?: string}&\Stripe\StripeObject&\stdClass, preferred_settlement_speed?: string, setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass, wechat_pay?: object{app_id: null|string, client: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass, zip?: object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_options Payment-method-specific configuration for this PaymentIntent. + * @property null|(object{id: string, parent: null|string}&\Stripe\StripeObject&\stdClass) $payment_method_configuration_details Information about the payment method configuration used for this PaymentIntent. + * @property null|(object{acss_debit?: (object{mandate_options?: (object{custom_mandate_url?: string, interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass), affirm?: (object{capture_method?: string, preferred_locale?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), afterpay_clearpay?: (object{capture_method?: string, reference: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), alipay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), alma?: (object{capture_method?: string}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), au_becs_debit?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), bacs_debit?: (object{mandate_options?: (object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), bancontact?: (object{preferred_language: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), blik?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), boleto?: (object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), card?: (object{capture_method?: string, installments: null|(object{available_plans: null|((object{count: null|int, interval: null|string, type: string}&\Stripe\StripeObject&\stdClass))[], enabled: bool, plan: null|(object{count: null|int, interval: null|string, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), mandate_options: null|(object{amount: int, amount_type: string, description: null|string, end_date: null|int, interval: string, interval_count: null|int, reference: string, start_date: int, supported_types: null|string[]}&\Stripe\StripeObject&\stdClass), network: null|string, request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_partial_authorization?: string, request_three_d_secure: null|string, require_cvc_recollection?: bool, setup_future_usage?: string, statement_descriptor_suffix_kana?: string, statement_descriptor_suffix_kanji?: string, statement_details?: (object{address?: (object{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}&\Stripe\StripeObject&\stdClass), phone?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), card_present?: (object{request_extended_authorization: null|bool, request_incremental_authorization_support: null|bool, routing?: (object{requested_priority: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), cashapp?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), customer_balance?: (object{bank_transfer?: (object{eu_bank_transfer?: (object{country: string}&\Stripe\StripeObject&\stdClass), requested_address_types?: string[], type: null|string}&\Stripe\StripeObject&\stdClass), funding_type: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), eps?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), fpx?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), giropay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), gopay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), grabpay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: (object{expires_after?: null|int, expires_at: null|int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), ideal?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), interac_present?: (object{}&\Stripe\StripeObject&\stdClass), kakao_pay?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), klarna?: (object{capture_method?: string, preferred_locale: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), konbini?: (object{confirmation_number: null|string, expires_after_days: null|int, expires_at: null|int, product_description: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), kr_card?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), link?: (object{capture_method?: string, persistent_token: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), mb_way?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), mobilepay?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), multibanco?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), naver_pay?: (object{capture_method?: string}&\Stripe\StripeObject&\stdClass), oxxo?: (object{expires_after_days: int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), p24?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), payco?: (object{capture_method?: string}&\Stripe\StripeObject&\stdClass), paynow?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), paypal?: (object{capture_method?: string, line_items?: (object{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: (object{amount: int, behavior: string}&\Stripe\StripeObject&\stdClass), unit_amount: int}&\Stripe\StripeObject&\stdClass)[], preferred_locale: null|string, reference: null|string, reference_id?: null|string, setup_future_usage?: string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass), payto?: (object{mandate_options?: (object{amount: null|int, amount_type: null|string, end_date: null|string, payment_schedule: null|string, payments_per_period: null|int, purpose: null|string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), pix?: (object{expires_after_seconds: null|int, expires_at: null|int, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), promptpay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), qris?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), rechnung?: (object{}&\Stripe\StripeObject&\stdClass), revolut_pay?: (object{capture_method?: string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), samsung_pay?: (object{capture_method?: string}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{mandate_options?: (object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass), setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), shopeepay?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), sofort?: (object{preferred_language: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), swish?: (object{reference: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), twint?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), us_bank_account?: (object{financial_connections?: (object{filters?: (object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass), manual_entry?: (object{mode?: string}&\Stripe\StripeObject&\stdClass), permissions?: string[], prefetch: null|string[], return_url?: string}&\Stripe\StripeObject&\stdClass), mandate_options?: (object{collection_method?: string}&\Stripe\StripeObject&\stdClass), preferred_settlement_speed?: string, setup_future_usage?: string, verification_method?: string}&\Stripe\StripeObject&\stdClass), wechat_pay?: (object{app_id: null|string, client: null|string, setup_future_usage?: string}&\Stripe\StripeObject&\stdClass), zip?: (object{setup_future_usage?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $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 null|object{card?: object{customer_notification?: object{approval_requested: null|bool, completes_at: null|int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $processing If present, this property tells you about the processing state of the payment. + * @property null|(object{card?: (object{customer_notification?: (object{approval_requested: null|bool, completes_at: null|int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $processing If present, this property tells you about the processing state of the payment. * @property null|string $receipt_email Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings. * @property null|string|\Stripe\Review $review ID of the review associated with this PaymentIntent, if any. * @property null|string $secret_key_confirmation Indicates whether confirmation for this PaymentIntent using a secret key is required or optional. * @property null|string $setup_future_usage

Indicates that you intend to make future payments with this PaymentIntent's payment method.

If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

- * @property null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $shipping Shipping information for this PaymentIntent. + * @property null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $shipping Shipping information for this PaymentIntent. * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $source This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied. * @property null|string $statement_descriptor

Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

* @property null|string $statement_descriptor_suffix Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement. * @property string $status Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status. - * @property null|object{amount?: int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass $transfer_data The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts. + * @property null|(object{amount?: int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass) $transfer_data The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts. * @property null|string $transfer_group A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts. */ class PaymentIntent extends ApiResource @@ -181,7 +181,7 @@ public static function retrieve($id, $opts = null) * href="/docs/api/payment_intents/confirm">confirm API instead. * * @param string $id the ID of the resource to update - * @param null|array{amount?: int, application_fee_amount?: null|int, async_workflows?: array{inputs?: array{tax?: array{calculation: null|string}}}, capture_method?: string, currency?: string, customer?: string, description?: string, expand?: string[], mandate_data?: array{customer_acceptance: array{online: array{ip_address?: string, user_agent?: string}, type: string}}, metadata?: null|StripeObject, payment_details?: null|array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, affirm?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, afterpay_clearpay?: null|array{capture_method?: null|string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, alma?: null|array{capture_method?: null|string}, amazon_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, au_becs_debit?: null|array{setup_future_usage?: null|string}, bacs_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, blik?: null|array{code?: string, setup_future_usage?: null|string}, boleto?: null|array{expires_after_days?: int, setup_future_usage?: null|string}, card?: null|array{capture_method?: null|string, cvc_token?: string, installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, mandate_options?: array{amount: int, amount_type: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_partial_authorization?: string, request_three_d_secure?: string, require_cvc_recollection?: bool, setup_future_usage?: null|string, statement_descriptor_suffix_kana?: null|string, statement_descriptor_suffix_kanji?: null|string, statement_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, phone?: string}, three_d_secure?: array{ares_trans_status?: string, cryptogram: string, electronic_commerce_indicator?: string, exemption_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id: string, version: string}}, card_present?: null|array{request_extended_authorization?: bool, request_incremental_authorization_support?: bool, routing?: array{requested_priority?: string}}, cashapp?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, eps?: null|array{setup_future_usage?: string}, fpx?: null|array{setup_future_usage?: string}, giropay?: null|array{setup_future_usage?: string}, gopay?: null|array{setup_future_usage?: string}, grabpay?: null|array{setup_future_usage?: string}, id_bank_transfer?: null|array{expires_after?: int, expires_at?: int, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, interac_present?: null|array{}, kakao_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, konbini?: null|array{confirmation_number?: null|string, expires_after_days?: null|int, expires_at?: null|int, product_description?: null|string, setup_future_usage?: string}, kr_card?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, mb_way?: null|array{setup_future_usage?: string}, mobilepay?: null|array{capture_method?: null|string, setup_future_usage?: string}, multibanco?: null|array{setup_future_usage?: string}, naver_pay?: null|array{capture_method?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, payco?: null|array{capture_method?: null|string}, paynow?: null|array{setup_future_usage?: string}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, payto?: null|array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string}, setup_future_usage?: null|string}, pix?: null|array{expires_after_seconds?: int, expires_at?: int, setup_future_usage?: string}, promptpay?: null|array{setup_future_usage?: string}, qris?: null|array{setup_future_usage?: string}, rechnung?: null|array{}, revolut_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, samsung_pay?: null|array{capture_method?: null|string}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, shopeepay?: null|array{setup_future_usage?: string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, swish?: null|array{reference?: null|string, setup_future_usage?: string}, twint?: null|array{setup_future_usage?: string}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, preferred_settlement_speed?: null|string, setup_future_usage?: null|string, verification_method?: string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}, zip?: null|array{setup_future_usage?: string}}, payment_method_types?: string[], receipt_email?: null|string, setup_future_usage?: null|string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int}, transfer_group?: string} $params + * @param null|array{amount?: int, application_fee_amount?: null|int, async_workflows?: array{inputs?: array{tax?: array{calculation: null|string}}}, capture_method?: string, currency?: string, customer?: string, description?: string, expand?: string[], mandate_data?: array{customer_acceptance: array{online: array{ip_address?: string, user_agent?: string}, type: string}}, metadata?: null|\Stripe\StripeObject, payment_details?: null|array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, affirm?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, afterpay_clearpay?: null|array{capture_method?: null|string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, alma?: null|array{capture_method?: null|string}, amazon_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, au_becs_debit?: null|array{setup_future_usage?: null|string}, bacs_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, blik?: null|array{code?: string, setup_future_usage?: null|string}, boleto?: null|array{expires_after_days?: int, setup_future_usage?: null|string}, card?: null|array{capture_method?: null|string, cvc_token?: string, installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, mandate_options?: array{amount: int, amount_type: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_partial_authorization?: string, request_three_d_secure?: string, require_cvc_recollection?: bool, setup_future_usage?: null|string, statement_descriptor_suffix_kana?: null|string, statement_descriptor_suffix_kanji?: null|string, statement_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, phone?: string}, three_d_secure?: array{ares_trans_status?: string, cryptogram: string, electronic_commerce_indicator?: string, exemption_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id: string, version: string}}, card_present?: null|array{request_extended_authorization?: bool, request_incremental_authorization_support?: bool, routing?: array{requested_priority?: string}}, cashapp?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, eps?: null|array{setup_future_usage?: string}, fpx?: null|array{setup_future_usage?: string}, giropay?: null|array{setup_future_usage?: string}, gopay?: null|array{setup_future_usage?: string}, grabpay?: null|array{setup_future_usage?: string}, id_bank_transfer?: null|array{expires_after?: int, expires_at?: int, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, interac_present?: null|array{}, kakao_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, konbini?: null|array{confirmation_number?: null|string, expires_after_days?: null|int, expires_at?: null|int, product_description?: null|string, setup_future_usage?: string}, kr_card?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, mb_way?: null|array{setup_future_usage?: string}, mobilepay?: null|array{capture_method?: null|string, setup_future_usage?: string}, multibanco?: null|array{setup_future_usage?: string}, naver_pay?: null|array{capture_method?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, payco?: null|array{capture_method?: null|string}, paynow?: null|array{setup_future_usage?: string}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, payto?: null|array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string}, setup_future_usage?: null|string}, pix?: null|array{expires_after_seconds?: int, expires_at?: int, setup_future_usage?: string}, promptpay?: null|array{setup_future_usage?: string}, qris?: null|array{setup_future_usage?: string}, rechnung?: null|array{}, revolut_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, samsung_pay?: null|array{capture_method?: null|string}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, shopeepay?: null|array{setup_future_usage?: string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, swish?: null|array{reference?: null|string, setup_future_usage?: string}, twint?: null|array{setup_future_usage?: string}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, preferred_settlement_speed?: null|string, setup_future_usage?: null|string, verification_method?: string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}, zip?: null|array{setup_future_usage?: string}}, payment_method_types?: string[], receipt_email?: null|string, setup_future_usage?: null|string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int}, transfer_group?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/PaymentLink.php b/lib/PaymentLink.php index 0f7fa5973..3a6a2ec0b 100644 --- a/lib/PaymentLink.php +++ b/lib/PaymentLink.php @@ -14,35 +14,35 @@ * @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 payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated. - * @property object{hosted_confirmation?: object{custom_message: null|string}&\Stripe\StripeObject&\stdClass, redirect?: object{url: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $after_completion + * @property (object{hosted_confirmation?: (object{custom_message: null|string}&\Stripe\StripeObject&\stdClass), redirect?: (object{url: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $after_completion * @property bool $allow_promotion_codes Whether user redeemable promotion codes are enabled. * @property null|string|\Stripe\Application $application The ID of the Connect application that created the Payment Link. * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. * @property null|float $application_fee_percent This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. - * @property object{enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $automatic_tax + * @property (object{enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $automatic_tax * @property string $billing_address_collection Configuration for collecting the customer's billing address. Defaults to auto. - * @property null|object{payment_method_reuse_agreement: null|object{position: string}&\Stripe\StripeObject&\stdClass, promotions: null|string, terms_of_service: null|string}&\Stripe\StripeObject&\stdClass $consent_collection When set, provides configuration to gather active consent from customers. + * @property null|(object{payment_method_reuse_agreement: null|(object{position: string}&\Stripe\StripeObject&\stdClass), promotions: null|string, terms_of_service: null|string}&\Stripe\StripeObject&\stdClass) $consent_collection When set, provides configuration to gather active consent from customers. * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. - * @property (object{dropdown?: object{options: object{label: string, value: string}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass, key: string, label: object{custom: null|string, type: string}&\Stripe\StripeObject&\stdClass, numeric?: object{maximum_length: null|int, minimum_length: null|int}&\Stripe\StripeObject&\stdClass, optional: bool, text?: object{maximum_length: null|int, minimum_length: null|int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass)[] $custom_fields Collect additional information from your customer using custom fields. Up to 3 fields are supported. - * @property object{after_submit: null|object{message: string}&\Stripe\StripeObject&\stdClass, shipping_address: null|object{message: string}&\Stripe\StripeObject&\stdClass, submit: null|object{message: string}&\Stripe\StripeObject&\stdClass, terms_of_service_acceptance: null|object{message: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $custom_text + * @property ((object{dropdown?: (object{options: (object{label: string, value: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass), key: string, label: (object{custom: null|string, type: string}&\Stripe\StripeObject&\stdClass), numeric?: (object{maximum_length: null|int, minimum_length: null|int}&\Stripe\StripeObject&\stdClass), optional: bool, text?: (object{maximum_length: null|int, minimum_length: null|int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass))[] $custom_fields Collect additional information from your customer using custom fields. Up to 3 fields are supported. + * @property (object{after_submit: null|(object{message: string}&\Stripe\StripeObject&\stdClass), shipping_address: null|(object{message: string}&\Stripe\StripeObject&\stdClass), submit: null|(object{message: string}&\Stripe\StripeObject&\stdClass), terms_of_service_acceptance: null|(object{message: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $custom_text * @property string $customer_creation Configuration for Customer creation during checkout. * @property null|string $inactive_message The custom message to be displayed to a customer when a payment link is no longer active. - * @property null|object{enabled: bool, invoice_data: null|object{account_tax_ids: null|(string|\Stripe\TaxId)[], custom_fields: null|object{name: string, value: string}&\Stripe\StripeObject&\stdClass[], description: null|string, footer: null|string, issuer: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass, metadata: null|StripeObject, rendering_options: null|object{amount_tax_display: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $invoice_creation Configuration for creating invoice for payment mode payment links. + * @property null|(object{enabled: bool, invoice_data: null|(object{account_tax_ids: null|(string|\Stripe\TaxId)[], custom_fields: null|(object{name: string, value: string}&\Stripe\StripeObject&\stdClass)[], description: null|string, footer: null|string, issuer: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass), metadata: null|\Stripe\StripeObject, rendering_options: null|(object{amount_tax_display: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $invoice_creation Configuration for creating invoice for payment mode payment links. * @property null|\Stripe\Collection<\Stripe\LineItem> $line_items The line items representing what is being sold. * @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 null|string|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the Connect documentation for details. - * @property null|object{capture_method: null|string, description: null|string, metadata: \Stripe\StripeObject, setup_future_usage: null|string, statement_descriptor: null|string, statement_descriptor_suffix: null|string, transfer_group: null|string}&\Stripe\StripeObject&\stdClass $payment_intent_data Indicates the parameters to be passed to PaymentIntent creation during checkout. + * @property null|(object{capture_method: null|string, description: null|string, metadata: \Stripe\StripeObject, setup_future_usage: null|string, statement_descriptor: null|string, statement_descriptor_suffix: null|string, transfer_group: null|string}&\Stripe\StripeObject&\stdClass) $payment_intent_data Indicates the parameters to be passed to PaymentIntent creation during checkout. * @property string $payment_method_collection Configuration for collecting a payment method during checkout. Defaults to always. * @property null|string[] $payment_method_types The list of payment method types that customers can use. When null, Stripe will dynamically show relevant payment methods you've enabled in your payment method settings. - * @property object{enabled: bool}&\Stripe\StripeObject&\stdClass $phone_number_collection - * @property null|object{completed_sessions: object{count: int, limit: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $restrictions Settings that restrict the usage of a payment link. - * @property null|object{allowed_countries: string[]}&\Stripe\StripeObject&\stdClass $shipping_address_collection Configuration for collecting the customer's shipping address. - * @property (object{shipping_amount: int, shipping_rate: string|\Stripe\ShippingRate}&\Stripe\StripeObject&\stdClass)[] $shipping_options The shipping rate options applied to the session. + * @property (object{enabled: bool}&\Stripe\StripeObject&\stdClass) $phone_number_collection + * @property null|(object{completed_sessions: (object{count: int, limit: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $restrictions Settings that restrict the usage of a payment link. + * @property null|(object{allowed_countries: string[]}&\Stripe\StripeObject&\stdClass) $shipping_address_collection Configuration for collecting the customer's shipping address. + * @property ((object{shipping_amount: int, shipping_rate: string|\Stripe\ShippingRate}&\Stripe\StripeObject&\stdClass))[] $shipping_options The shipping rate options applied to the session. * @property string $submit_type Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. - * @property null|object{description: null|string, invoice_settings: object{issuer: object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, metadata: \Stripe\StripeObject, trial_period_days: null|int, trial_settings: null|object{end_behavior: object{missing_payment_method: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $subscription_data When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data. - * @property object{enabled: bool, required: string}&\Stripe\StripeObject&\stdClass $tax_id_collection - * @property null|object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. + * @property null|(object{description: null|string, invoice_settings: (object{issuer: (object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), metadata: \Stripe\StripeObject, trial_period_days: null|int, trial_settings: null|(object{end_behavior: (object{missing_payment_method: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $subscription_data When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data. + * @property (object{enabled: bool, required: string}&\Stripe\StripeObject&\stdClass) $tax_id_collection + * @property null|(object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass) $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. * @property string $url The public URL that can be shared with customers. */ class PaymentLink extends ApiResource @@ -69,7 +69,7 @@ class PaymentLink extends ApiResource /** * Creates a payment link. * - * @param null|array{after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, application_fee_amount?: int, application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, consent_collection?: array{payment_method_reuse_agreement?: array{position: string}, promotions?: string, terms_of_service?: string}, currency?: string, custom_fields?: array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, price: string, quantity: int}[], metadata?: \Stripe\StripeObject, on_behalf_of?: string, payment_intent_data?: array{capture_method?: string, description?: string, metadata?: \Stripe\StripeObject, setup_future_usage?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_group?: string}, payment_method_collection?: string, payment_method_types?: string[], phone_number_collection?: array{enabled: bool}, restrictions?: array{completed_sessions: array{limit: int}}, shipping_address_collection?: array{allowed_countries: string[]}, shipping_options?: array{shipping_rate?: string}[], submit_type?: string, subscription_data?: array{description?: string, invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: \Stripe\StripeObject, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}, transfer_data?: array{amount?: int, destination: string}} $params + * @param null|array{after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, application_fee_amount?: int, application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, consent_collection?: array{payment_method_reuse_agreement?: array{position: string}, promotions?: string, terms_of_service?: string}, currency?: string, custom_fields?: array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, price: string, quantity: int}[], metadata?: \Stripe\StripeObject, on_behalf_of?: string, payment_intent_data?: array{capture_method?: string, description?: string, metadata?: \Stripe\StripeObject, setup_future_usage?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_group?: string}, payment_method_collection?: string, payment_method_types?: string[], phone_number_collection?: array{enabled: bool}, restrictions?: array{completed_sessions: array{limit: int}}, shipping_address_collection?: array{allowed_countries: string[]}, shipping_options?: array{shipping_rate?: string}[], submit_type?: string, subscription_data?: array{description?: string, invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: \Stripe\StripeObject, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}, transfer_data?: array{amount?: int, destination: string}} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -128,7 +128,7 @@ public static function retrieve($id, $opts = null) * Updates a payment link. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, custom_fields?: null|array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: null|string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id: string, quantity?: int}[], metadata?: \Stripe\StripeObject, payment_intent_data?: array{description?: null|string, metadata?: null|StripeObject, statement_descriptor?: null|string, statement_descriptor_suffix?: null|string, transfer_group?: null|string}, payment_method_collection?: string, payment_method_types?: null|string[], restrictions?: null|array{completed_sessions: array{limit: int}}, shipping_address_collection?: null|array{allowed_countries: string[]}, submit_type?: string, subscription_data?: array{invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: null|StripeObject, trial_period_days?: null|int, trial_settings?: null|array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}} $params + * @param null|array{active?: bool, after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, custom_fields?: null|array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: null|string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id: string, quantity?: int}[], metadata?: \Stripe\StripeObject, payment_intent_data?: array{description?: null|string, metadata?: null|\Stripe\StripeObject, statement_descriptor?: null|string, statement_descriptor_suffix?: null|string, transfer_group?: null|string}, payment_method_collection?: string, payment_method_types?: null|string[], restrictions?: null|array{completed_sessions: array{limit: int}}, shipping_address_collection?: null|array{allowed_countries: string[]}, submit_type?: string, subscription_data?: array{invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: null|\Stripe\StripeObject, trial_period_days?: null|int, trial_settings?: null|array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/PaymentMethod.php b/lib/PaymentMethod.php index 5497393e2..72ef10e16 100644 --- a/lib/PaymentMethod.php +++ b/lib/PaymentMethod.php @@ -13,66 +13,66 @@ * * @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 object{bank_name: null|string, fingerprint: null|string, institution_number: null|string, last4: null|string, transit_number: null|string}&\Stripe\StripeObject&\stdClass $acss_debit - * @property null|object{}&\Stripe\StripeObject&\stdClass $affirm - * @property null|object{}&\Stripe\StripeObject&\stdClass $afterpay_clearpay - * @property null|object{}&\Stripe\StripeObject&\stdClass $alipay + * @property (object{bank_name: null|string, fingerprint: null|string, institution_number: null|string, last4: null|string, transit_number: null|string}&\Stripe\StripeObject&\stdClass) $acss_debit + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $affirm + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $afterpay_clearpay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $alipay * @property null|string $allow_redisplay This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - * @property null|object{}&\Stripe\StripeObject&\stdClass $alma - * @property null|object{}&\Stripe\StripeObject&\stdClass $amazon_pay - * @property object{bsb_number: null|string, fingerprint: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass $au_becs_debit - * @property object{fingerprint: null|string, last4: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass $bacs_debit - * @property null|object{}&\Stripe\StripeObject&\stdClass $bancontact - * @property object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $billing_details - * @property null|object{}&\Stripe\StripeObject&\stdClass $blik - * @property null|object{tax_id: string}&\Stripe\StripeObject&\stdClass $boleto - * @property object{brand: string, checks: null|object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass, country: null|string, description?: null|string, display_brand: null|string, exp_month: int, exp_year: int, fingerprint?: null|string, funding: string, generated_from: null|object{charge: null|string, payment_method_details: null|object{card_present?: object{amount_authorized: null|int, brand: null|string, brand_product: null|string, capture_before?: int, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, incremental_authorization_supported: bool, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, offline: null|object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass, overcapture_supported: bool, preferred_locales: null|string[], read_method: null|string, receipt: null|object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass, wallet?: object{type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass, iin?: null|string, issuer?: null|string, last4: string, networks: null|object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass, three_d_secure_usage: null|object{supported: bool}&\Stripe\StripeObject&\stdClass, wallet: null|object{amex_express_checkout?: object{}&\Stripe\StripeObject&\stdClass, apple_pay?: object{}&\Stripe\StripeObject&\stdClass, dynamic_last4: null|string, google_pay?: object{}&\Stripe\StripeObject&\stdClass, link?: object{}&\Stripe\StripeObject&\stdClass, masterpass?: object{billing_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, samsung_pay?: object{}&\Stripe\StripeObject&\stdClass, type: string, visa_checkout?: object{billing_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, shipping_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $card - * @property object{brand: null|string, brand_product: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass, offline: null|object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass, preferred_locales: null|string[], read_method: null|string, wallet?: object{type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $card_present - * @property object{buyer_id: null|string, cashtag: null|string}&\Stripe\StripeObject&\stdClass $cashapp + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $alma + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $amazon_pay + * @property (object{bsb_number: null|string, fingerprint: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass) $au_becs_debit + * @property (object{fingerprint: null|string, last4: null|string, sort_code: null|string}&\Stripe\StripeObject&\stdClass) $bacs_debit + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $bancontact + * @property (object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $billing_details + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $blik + * @property null|(object{tax_id: string}&\Stripe\StripeObject&\stdClass) $boleto + * @property (object{brand: string, checks: null|(object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass), country: null|string, description?: null|string, display_brand: null|string, exp_month: int, exp_year: int, fingerprint?: null|string, funding: string, generated_from: null|(object{charge: null|string, payment_method_details: null|(object{card_present?: (object{amount_authorized: null|int, brand: null|string, brand_product: null|string, capture_before?: int, cardholder_name: null|string, country: null|string, description?: null|string, emv_auth_data: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, generated_card: null|string, iin?: null|string, incremental_authorization_supported: bool, issuer?: null|string, last4: null|string, network: null|string, network_transaction_id: null|string, offline: null|(object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass), overcapture_supported: bool, preferred_locales: null|string[], read_method: null|string, receipt: null|(object{account_type?: string, application_cryptogram: null|string, application_preferred_name: null|string, authorization_code: null|string, authorization_response_code: null|string, cardholder_verification_method: null|string, dedicated_file_name: null|string, terminal_verification_results: null|string, transaction_status_information: null|string}&\Stripe\StripeObject&\stdClass), wallet?: (object{type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass), iin?: null|string, issuer?: null|string, last4: string, networks: null|(object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass), three_d_secure_usage: null|(object{supported: bool}&\Stripe\StripeObject&\stdClass), wallet: null|(object{amex_express_checkout?: (object{}&\Stripe\StripeObject&\stdClass), apple_pay?: (object{}&\Stripe\StripeObject&\stdClass), dynamic_last4: null|string, google_pay?: (object{}&\Stripe\StripeObject&\stdClass), link?: (object{}&\Stripe\StripeObject&\stdClass), masterpass?: (object{billing_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), samsung_pay?: (object{}&\Stripe\StripeObject&\stdClass), type: string, visa_checkout?: (object{billing_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, shipping_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $card + * @property (object{brand: null|string, brand_product: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|(object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass), offline: null|(object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass), preferred_locales: null|string[], read_method: null|string, wallet?: (object{type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $card_present + * @property (object{buyer_id: null|string, cashtag: null|string}&\Stripe\StripeObject&\stdClass) $cashapp * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string|\Stripe\Customer $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 null|object{}&\Stripe\StripeObject&\stdClass $customer_balance - * @property object{bank: null|string}&\Stripe\StripeObject&\stdClass $eps - * @property object{account_holder_type: null|string, bank: string}&\Stripe\StripeObject&\stdClass $fpx - * @property null|object{}&\Stripe\StripeObject&\stdClass $giropay - * @property null|object{}&\Stripe\StripeObject&\stdClass $gopay - * @property null|object{}&\Stripe\StripeObject&\stdClass $grabpay - * @property object{bank: null|string, bank_code: null|string, bank_name: null|string, display_name: null|string}&\Stripe\StripeObject&\stdClass $id_bank_transfer - * @property object{bank: null|string, bic: null|string}&\Stripe\StripeObject&\stdClass $ideal - * @property object{brand: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass, preferred_locales: null|string[], read_method: null|string}&\Stripe\StripeObject&\stdClass $interac_present - * @property null|object{}&\Stripe\StripeObject&\stdClass $kakao_pay - * @property object{dob?: null|object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $klarna - * @property null|object{}&\Stripe\StripeObject&\stdClass $konbini - * @property object{brand: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass $kr_card - * @property object{email: null|string, persistent_token?: string}&\Stripe\StripeObject&\stdClass $link + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $customer_balance + * @property (object{bank: null|string}&\Stripe\StripeObject&\stdClass) $eps + * @property (object{account_holder_type: null|string, bank: string}&\Stripe\StripeObject&\stdClass) $fpx + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $giropay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $gopay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $grabpay + * @property (object{bank: null|string, bank_code: null|string, bank_name: null|string, display_name: null|string}&\Stripe\StripeObject&\stdClass) $id_bank_transfer + * @property (object{bank: null|string, bic: null|string}&\Stripe\StripeObject&\stdClass) $ideal + * @property (object{brand: null|string, cardholder_name: null|string, country: null|string, description?: null|string, exp_month: int, exp_year: int, fingerprint: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, networks: null|(object{available: string[], preferred: null|string}&\Stripe\StripeObject&\stdClass), preferred_locales: null|string[], read_method: null|string}&\Stripe\StripeObject&\stdClass) $interac_present + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $kakao_pay + * @property (object{dob?: null|(object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $klarna + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $konbini + * @property (object{brand: null|string, last4: null|string}&\Stripe\StripeObject&\stdClass) $kr_card + * @property (object{email: null|string, persistent_token?: string}&\Stripe\StripeObject&\stdClass) $link * @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 null|object{}&\Stripe\StripeObject&\stdClass $mb_way - * @property null|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|object{}&\Stripe\StripeObject&\stdClass $mobilepay - * @property null|object{}&\Stripe\StripeObject&\stdClass $multibanco - * @property null|object{funding: string}&\Stripe\StripeObject&\stdClass $naver_pay - * @property null|object{}&\Stripe\StripeObject&\stdClass $oxxo - * @property object{bank: null|string}&\Stripe\StripeObject&\stdClass $p24 - * @property null|object{}&\Stripe\StripeObject&\stdClass $payco - * @property null|object{}&\Stripe\StripeObject&\stdClass $paynow - * @property object{fingerprint?: null|string, payer_email: null|string, payer_id: null|string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass $paypal - * @property object{bsb_number: null|string, last4: null|string, pay_id: null|string}&\Stripe\StripeObject&\stdClass $payto - * @property null|object{}&\Stripe\StripeObject&\stdClass $pix - * @property null|object{}&\Stripe\StripeObject&\stdClass $promptpay - * @property null|object{}&\Stripe\StripeObject&\stdClass $qris - * @property null|object{session?: string}&\Stripe\StripeObject&\stdClass $radar_options Options to configure Radar. See Radar Session for more information. - * @property null|object{dob?: object{day: int, month: int, year: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $rechnung - * @property null|object{}&\Stripe\StripeObject&\stdClass $revolut_pay - * @property null|object{}&\Stripe\StripeObject&\stdClass $samsung_pay - * @property object{bank_code: null|string, branch_code: null|string, country: null|string, fingerprint: null|string, generated_from: null|object{charge: null|string|\Stripe\Charge, setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass, last4: null|string}&\Stripe\StripeObject&\stdClass $sepa_debit - * @property null|object{}&\Stripe\StripeObject&\stdClass $shopeepay - * @property object{country: null|string}&\Stripe\StripeObject&\stdClass $sofort - * @property null|object{}&\Stripe\StripeObject&\stdClass $swish - * @property null|object{}&\Stripe\StripeObject&\stdClass $twint + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $mb_way + * @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|(object{}&\Stripe\StripeObject&\stdClass) $mobilepay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $multibanco + * @property null|(object{funding: string}&\Stripe\StripeObject&\stdClass) $naver_pay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $oxxo + * @property (object{bank: null|string}&\Stripe\StripeObject&\stdClass) $p24 + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $payco + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $paynow + * @property (object{fingerprint?: null|string, payer_email: null|string, payer_id: null|string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass) $paypal + * @property (object{bsb_number: null|string, last4: null|string, pay_id: null|string}&\Stripe\StripeObject&\stdClass) $payto + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $pix + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $promptpay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $qris + * @property null|(object{session?: string}&\Stripe\StripeObject&\stdClass) $radar_options Options to configure Radar. See Radar Session for more information. + * @property null|(object{dob?: (object{day: int, month: int, year: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $rechnung + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $revolut_pay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $samsung_pay + * @property (object{bank_code: null|string, branch_code: null|string, country: null|string, fingerprint: null|string, generated_from: null|(object{charge: null|string|\Stripe\Charge, setup_attempt: null|string|\Stripe\SetupAttempt}&\Stripe\StripeObject&\stdClass), last4: null|string}&\Stripe\StripeObject&\stdClass) $sepa_debit + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $shopeepay + * @property (object{country: null|string}&\Stripe\StripeObject&\stdClass) $sofort + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $swish + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $twint * @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. - * @property object{account_holder_type: null|string, account_number?: null|string, account_type: null|string, bank_name: null|string, financial_connections_account: null|string, fingerprint: null|string, last4: null|string, networks: null|object{preferred: null|string, supported: string[]}&\Stripe\StripeObject&\stdClass, routing_number: null|string, status_details: null|object{blocked?: object{network_code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $us_bank_account - * @property null|object{}&\Stripe\StripeObject&\stdClass $wechat_pay - * @property null|object{}&\Stripe\StripeObject&\stdClass $zip + * @property (object{account_holder_type: null|string, account_number?: null|string, account_type: null|string, bank_name: null|string, financial_connections_account: null|string, fingerprint: null|string, last4: null|string, networks: null|(object{preferred: null|string, supported: string[]}&\Stripe\StripeObject&\stdClass), routing_number: null|string, status_details: null|(object{blocked?: (object{network_code: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $us_bank_account + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $wechat_pay + * @property null|(object{}&\Stripe\StripeObject&\stdClass) $zip */ class PaymentMethod extends ApiResource { @@ -214,7 +214,7 @@ public static function retrieve($id, $opts = null) * be updated. * * @param string $id the ID of the resource to update - * @param null|array{allow_redisplay?: string, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, card?: array{exp_month?: int, exp_year?: int, networks?: array{preferred?: null|string}}, expand?: string[], link?: array{}, metadata?: null|StripeObject, naver_pay?: array{funding?: string}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, us_bank_account?: array{account_holder_type?: string, account_type?: string}} $params + * @param null|array{allow_redisplay?: string, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, card?: array{exp_month?: int, exp_year?: int, networks?: array{preferred?: null|string}}, expand?: string[], link?: array{}, metadata?: null|\Stripe\StripeObject, naver_pay?: array{funding?: string}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, us_bank_account?: array{account_holder_type?: string, account_type?: string}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/PaymentMethodConfiguration.php b/lib/PaymentMethodConfiguration.php index 9fe12c41c..fcfb4faa9 100644 --- a/lib/PaymentMethodConfiguration.php +++ b/lib/PaymentMethodConfiguration.php @@ -22,58 +22,58 @@ * * @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 object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $acss_debit + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $acss_debit * @property bool $active Whether the configuration can be used for new payments. - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $affirm - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $afterpay_clearpay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $alipay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $alma - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $amazon_pay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $apple_pay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $affirm + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $afterpay_clearpay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $alipay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $alma + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $amazon_pay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $apple_pay * @property null|string $application For child configs, the Connect application associated with the configuration. - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $au_becs_debit - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $bacs_debit - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $bancontact - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $blik - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $boleto - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $card - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $cartes_bancaires - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $cashapp - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $customer_balance - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $eps - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $fpx - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $giropay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $google_pay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $gopay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $grabpay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $id_bank_transfer - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $ideal + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $au_becs_debit + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $bacs_debit + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $bancontact + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $blik + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $boleto + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $card + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $cartes_bancaires + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $cashapp + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $customer_balance + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $eps + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $fpx + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $giropay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $google_pay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $gopay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $grabpay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $id_bank_transfer + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $ideal * @property bool $is_default The default configuration is used whenever a payment method configuration is not specified. - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $jcb - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $klarna - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $konbini - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $link + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $jcb + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $klarna + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $konbini + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $link * @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 object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $mobilepay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $multibanco + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $mobilepay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $multibanco * @property string $name The configuration's name. - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $oxxo - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $p24 + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $oxxo + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $p24 * @property null|string $parent For child configs, the configuration's parent configuration. - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $paynow - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $paypal - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payto - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $promptpay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $qris - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $revolut_pay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $sepa_debit - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $shopeepay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $sofort - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $swish - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $twint - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $us_bank_account - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $wechat_pay - * @property object{available: bool, display_preference: object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $zip + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $paynow + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $paypal + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payto + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $promptpay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $qris + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $revolut_pay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $sepa_debit + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $shopeepay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $sofort + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $swish + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $twint + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $us_bank_account + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $wechat_pay + * @property (object{available: bool, display_preference: (object{overridable: null|bool, preference: string, value: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $zip */ class PaymentMethodConfiguration extends ApiResource { diff --git a/lib/PaymentMethodDomain.php b/lib/PaymentMethodDomain.php index 2ffe396fa..8d405b6be 100644 --- a/lib/PaymentMethodDomain.php +++ b/lib/PaymentMethodDomain.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 object{status: string, status_details?: object{error_message: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $amazon_pay Indicates the status of a specific payment method on a payment method domain. - * @property object{status: string, status_details?: object{error_message: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $apple_pay Indicates the status of a specific payment method on a payment method domain. + * @property (object{status: string, status_details?: (object{error_message: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $amazon_pay Indicates the status of a specific payment method on a payment method domain. + * @property (object{status: string, status_details?: (object{error_message: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $apple_pay Indicates the status of a specific payment method on a payment method domain. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property string $domain_name The domain name that this payment method domain object represents. * @property bool $enabled Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. - * @property object{status: string, status_details?: object{error_message: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $google_pay Indicates the status of a specific payment method on a payment method domain. - * @property object{status: string, status_details?: object{error_message: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $link Indicates the status of a specific payment method on a payment method domain. + * @property (object{status: string, status_details?: (object{error_message: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $google_pay Indicates the status of a specific payment method on a payment method domain. + * @property (object{status: string, status_details?: (object{error_message: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $link Indicates the status of a specific payment method on a payment method domain. * @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 object{status: string, status_details?: object{error_message: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $paypal Indicates the status of a specific payment method on a payment method domain. + * @property (object{status: string, status_details?: (object{error_message: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $paypal Indicates the status of a specific payment method on a payment method domain. */ class PaymentMethodDomain extends ApiResource { diff --git a/lib/PaymentRecord.php b/lib/PaymentRecord.php index b3476ee09..fab5b1a50 100644 --- a/lib/PaymentRecord.php +++ b/lib/PaymentRecord.php @@ -12,21 +12,21 @@ * * @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 object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_canceled A representation of an amount of money, consisting of an amount and a currency. - * @property object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_failed A representation of an amount of money, consisting of an amount and a currency. - * @property object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_guaranteed A representation of an amount of money, consisting of an amount and a currency. - * @property object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_refunded A representation of an amount of money, consisting of an amount and a currency. - * @property object{currency: string, value: int}&\Stripe\StripeObject&\stdClass $amount_requested A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_canceled A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_failed A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_guaranteed A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_refunded A representation of an amount of money, consisting of an amount and a currency. + * @property (object{currency: string, value: int}&\Stripe\StripeObject&\stdClass) $amount_requested A representation of an amount of money, consisting of an amount and a currency. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|object{customer: null|string, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $customer_details Customer information for this payment. + * @property null|(object{customer: null|string, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $customer_details Customer information for this payment. * @property null|string $customer_presence Indicates whether the customer was present in your checkout flow during this payment. * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. * @property string $latest_payment_attempt_record ID of the latest Payment Attempt Record attached to this Payment Record. * @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 null|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|object{billing_details: null|object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass, custom: null|object{display_name: string, type: null|string}&\Stripe\StripeObject&\stdClass, payment_method: null|string, type: string}&\Stripe\StripeObject&\stdClass $payment_method_details Information about the Payment Method debited for this payment. + * @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|(object{billing_details: null|(object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass), custom: null|(object{display_name: string, type: null|string}&\Stripe\StripeObject&\stdClass), payment_method: null|string, type: string}&\Stripe\StripeObject&\stdClass) $payment_method_details Information about the Payment Method debited for this payment. * @property null|string $payment_reference An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID. - * @property null|object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass $shipping_details Shipping information for this payment. + * @property null|(object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), name: null|string, phone: null|string}&\Stripe\StripeObject&\stdClass) $shipping_details Shipping information for this payment. */ class PaymentRecord extends ApiResource { diff --git a/lib/Payout.php b/lib/Payout.php index 0c18523fe..5953c89d5 100644 --- a/lib/Payout.php +++ b/lib/Payout.php @@ -30,7 +30,7 @@ * @property null|string $failure_code Error code that provides a reason for a payout failure, if available. View our list of failure codes. * @property null|string $failure_message Message that provides the reason for a 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 null|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|\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 supported for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts. * @property null|string|\Stripe\Payout $original_payout If the payout reverses another, this is the ID of the original payout. * @property string $reconciliation_status If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. @@ -38,7 +38,7 @@ * @property string $source_type The source balance this payout came from, which can be one of the following: card, fpx, or bank_account. * @property null|string $statement_descriptor Extra information about a payout that displays on the user's bank statement. * @property string $status Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it's submitted to the bank, when it becomes in_transit. The status changes to paid if the transaction succeeds, or to failed or canceled (within 5 business days). Some payouts that fail might initially show as paid, then change to failed. - * @property null|object{status: string, value: null|string}&\Stripe\StripeObject&\stdClass $trace_id A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. + * @property null|(object{status: string, value: null|string}&\Stripe\StripeObject&\stdClass) $trace_id A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. * @property string $type Can be bank_account or card. */ class Payout extends ApiResource @@ -141,7 +141,7 @@ public static function retrieve($id, $opts = null) * metadata as arguments. * * @param string $id the ID of the resource to update - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Person.php b/lib/Person.php index f1d228e48..f064a8ab0 100644 --- a/lib/Person.php +++ b/lib/Person.php @@ -14,18 +14,18 @@ * @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|string $account The account the person is associated with. - * @property object{account: null|object{date: null|int, ip: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $additional_tos_acceptances - * @property object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass $address - * @property null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass $address_kana The Kana variation of the person's address (Japan only). - * @property null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass $address_kanji The Kanji variation of the person's address (Japan only). + * @property (object{account: null|(object{date: null|int, ip: null|string, user_agent: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $additional_tos_acceptances + * @property (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass) $address + * @property null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass) $address_kana The Kana variation of the person's address (Japan only). + * @property null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string, town: null|string}&\Stripe\StripeObject&\stdClass) $address_kanji The Kanji variation of the person's address (Japan only). * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass $dob + * @property (object{day: null|int, month: null|int, year: null|int}&\Stripe\StripeObject&\stdClass) $dob * @property null|string $email The person's email address. * @property null|string $first_name The person's first name. * @property null|string $first_name_kana The Kana variation of the person's first name (Japan only). * @property null|string $first_name_kanji The Kanji variation of the person's first name (Japan only). * @property null|string[] $full_name_aliases A list of alternate names or aliases that the person is known by. - * @property null|object{alternatives: null|object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass[], currently_due: string[], errors: object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass $future_requirements Information about the upcoming new requirements for this person, including what information needs to be collected, and by when. + * @property null|(object{alternatives: null|(object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass)[], currently_due: string[], errors: (object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass) $future_requirements Information about the upcoming new requirements for this person, including what information needs to be collected, and by when. * @property null|string $gender The person's gender. * @property null|bool $id_number_provided Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided). * @property null|bool $id_number_secondary_provided Whether the person's id_number_secondary was provided. @@ -37,11 +37,11 @@ * @property null|string $nationality The country where the person is a national. * @property null|string $phone The person's phone number. * @property null|string $political_exposure Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - * @property object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass $registered_address - * @property object{authorizer: null|bool, director: null|bool, executive: null|bool, legal_guardian: null|bool, owner: null|bool, percent_ownership: null|float, representative: null|bool, title: null|string}&\Stripe\StripeObject&\stdClass $relationship - * @property null|object{alternatives: null|object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass[], currently_due: string[], errors: object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass $requirements Information about the requirements for this person, including what information needs to be collected, and by when. + * @property (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass) $registered_address + * @property (object{authorizer: null|bool, director: null|bool, executive: null|bool, legal_guardian: null|bool, owner: null|bool, percent_ownership: null|float, representative: null|bool, title: null|string}&\Stripe\StripeObject&\stdClass) $relationship + * @property null|(object{alternatives: null|(object{alternative_fields_due: string[], original_fields_due: string[]}&\Stripe\StripeObject&\stdClass)[], currently_due: string[], errors: (object{code: string, reason: string, requirement: string}&\Stripe\StripeObject&\stdClass)[], eventually_due: string[], past_due: string[], pending_verification: string[]}&\Stripe\StripeObject&\stdClass) $requirements Information about the requirements for this person, including what information needs to be collected, and by when. * @property null|bool $ssn_last_4_provided Whether the last four digits of the person's Social Security number have been provided (U.S. only). - * @property object{additional_document?: null|object{back: null|string|\Stripe\File, details: null|string, details_code: null|string, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass, details?: null|string, details_code?: null|string, document?: object{back: null|string|\Stripe\File, details: null|string, details_code: null|string, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass, status: string}&\Stripe\StripeObject&\stdClass $verification + * @property (object{additional_document?: null|(object{back: null|string|\Stripe\File, details: null|string, details_code: null|string, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass), details?: null|string, details_code?: null|string, document?: (object{back: null|string|\Stripe\File, details: null|string, details_code: null|string, front: null|string|\Stripe\File}&\Stripe\StripeObject&\stdClass), status: string}&\Stripe\StripeObject&\stdClass) $verification */ class Person extends ApiResource { diff --git a/lib/Plan.php b/lib/Plan.php index 3bea2e6e9..ae8fb599f 100644 --- a/lib/Plan.php +++ b/lib/Plan.php @@ -26,13 +26,13 @@ * @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 null|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|\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 $meter The meter tracking the usage of a metered price * @property null|string $nickname A brief description of the plan, hidden from customers. * @property null|string|\Stripe\Product $product The product whose pricing this plan determines. - * @property (object{flat_amount: null|int, flat_amount_decimal: null|string, unit_amount: null|int, unit_amount_decimal: null|string, up_to: null|int}&\Stripe\StripeObject&\stdClass)[] $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 ((object{flat_amount: null|int, flat_amount_decimal: null|string, unit_amount: null|int, unit_amount_decimal: null|string, up_to: null|int}&\Stripe\StripeObject&\stdClass))[] $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 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|object{divide_by: int, round: string}&\Stripe\StripeObject&\stdClass $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers. + * @property null|(object{divide_by: int, round: string}&\Stripe\StripeObject&\stdClass) $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers. * @property null|int $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 automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. */ @@ -66,7 +66,7 @@ class Plan extends ApiResource * API. It replaces the Plans API and is backwards compatible to simplify your * migration. * - * @param null|array{active?: bool, aggregate_usage?: string, amount?: int, amount_decimal?: string, billing_scheme?: string, currency: string, expand?: string[], id?: string, interval: string, interval_count?: int, metadata?: null|StripeObject, meter?: string, nickname?: string, product?: string|array, tiers?: (array{flat_amount?: int, flat_amount_decimal?: string, unit_amount?: int, unit_amount_decimal?: string, up_to: int|array})[], tiers_mode?: string, transform_usage?: array{divide_by: int, round: string}, trial_period_days?: int, usage_type?: string} $params + * @param null|array{active?: bool, aggregate_usage?: string, amount?: int, amount_decimal?: string, billing_scheme?: string, currency: string, expand?: string[], id?: string, interval: string, interval_count?: int, metadata?: null|\Stripe\StripeObject, meter?: string, nickname?: string, product?: string|array, tiers?: (array{flat_amount?: int, flat_amount_decimal?: string, unit_amount?: int, unit_amount_decimal?: string, up_to: int|array})[], tiers_mode?: string, transform_usage?: array{divide_by: int, round: string}, trial_period_days?: int, usage_type?: string} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -89,7 +89,7 @@ public static function create($params = null, $options = null) * Deleting plans means new subscribers can’t be added. Existing subscribers aren’t * affected. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -149,7 +149,7 @@ public static function retrieve($id, $opts = null) * plan’s ID, amount, currency, or billing cycle. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject, nickname?: string, product?: string, trial_period_days?: int} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, nickname?: string, product?: string, trial_period_days?: int} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Price.php b/lib/Price.php index c33a77fd1..cc0590566 100644 --- a/lib/Price.php +++ b/lib/Price.php @@ -19,18 +19,18 @@ * @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|\Stripe\StripeObject $currency_options Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency. - * @property null|object{maximum: null|int, minimum: null|int, preset: null|int}&\Stripe\StripeObject&\stdClass $custom_unit_amount When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. + * @property null|(object{maximum: null|int, minimum: null|int, preset: null|int}&\Stripe\StripeObject&\stdClass) $custom_unit_amount When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. * @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 null|string $lookup_key A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. * @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 null|object{behavior: string, effective_after: int, price: string}&\Stripe\StripeObject&\stdClass $migrate_to Subscriptions using this price will be migrated to use the new referenced price. + * @property null|(object{behavior: string, effective_after: int, price: string}&\Stripe\StripeObject&\stdClass) $migrate_to Subscriptions using this price will be migrated to use the new referenced price. * @property null|string $nickname A brief description of the price, hidden from customers. * @property string|\Stripe\Product $product The ID of the product this price is associated with. - * @property null|object{aggregate_usage: null|string, interval: string, interval_count: int, meter: null|string, trial_period_days: null|int, usage_type: string}&\Stripe\StripeObject&\stdClass $recurring The recurring components of a price such as interval and usage_type. + * @property null|(object{aggregate_usage: null|string, interval: string, interval_count: int, meter: null|string, trial_period_days: null|int, usage_type: string}&\Stripe\StripeObject&\stdClass) $recurring The recurring components of a price such as interval and usage_type. * @property null|string $tax_behavior Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. - * @property (object{flat_amount: null|int, flat_amount_decimal: null|string, unit_amount: null|int, unit_amount_decimal: null|string, up_to: null|int}&\Stripe\StripeObject&\stdClass)[] $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 ((object{flat_amount: null|int, flat_amount_decimal: null|string, unit_amount: null|int, unit_amount_decimal: null|string, up_to: null|int}&\Stripe\StripeObject&\stdClass))[] $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 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|object{divide_by: int, round: string}&\Stripe\StripeObject&\stdClass $transform_quantity Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers. + * @property null|(object{divide_by: int, round: string}&\Stripe\StripeObject&\stdClass) $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 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. @@ -120,7 +120,7 @@ public static function retrieve($id, $opts = null) * parameters not provided are left unchanged. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, currency_options?: null|StripeObject, expand?: string[], lookup_key?: string, metadata?: null|StripeObject, migrate_to?: null|array{behavior: string, effective_after?: int, price: string}, nickname?: string, tax_behavior?: string, transfer_lookup_key?: bool} $params + * @param null|array{active?: bool, currency_options?: null|\Stripe\StripeObject, expand?: string[], lookup_key?: string, metadata?: null|\Stripe\StripeObject, migrate_to?: null|array{behavior: string, effective_after?: int, price: string}, nickname?: string, tax_behavior?: string, transfer_lookup_key?: bool} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Product.php b/lib/Product.php index ad84aa6b5..e963cff83 100644 --- a/lib/Product.php +++ b/lib/Product.php @@ -22,11 +22,11 @@ * @property null|string $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. * @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 object{name?: string}&\Stripe\StripeObject&\stdClass[] $marketing_features A list of up to 15 marketing features for this product. These are displayed in pricing tables. + * @property (object{name?: string}&\Stripe\StripeObject&\stdClass)[] $marketing_features A list of up to 15 marketing features for this product. These are displayed in pricing tables. * @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. - * @property null|object{height: float, length: float, weight: float, width: float}&\Stripe\StripeObject&\stdClass $package_dimensions The dimensions of this product for shipping purposes. - * @property null|object{gift_card: null|object{fixed_amount: null|object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $provisioning Provisioning configuration for this product. + * @property null|(object{height: float, length: float, weight: float, width: float}&\Stripe\StripeObject&\stdClass) $package_dimensions The dimensions of this product for shipping purposes. + * @property null|(object{gift_card: null|(object{fixed_amount: null|(object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $provisioning Provisioning configuration for this product. * @property null|bool $shippable Whether this product is shipped (i.e., physical goods). * @property null|string $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. Only used for subscription payments. * @property null|string|\Stripe\TaxCode $tax_code A tax code ID. @@ -72,7 +72,7 @@ public static function create($params = null, $options = null) * associated with it. Additionally, deleting a product with type=good * is only possible if it has no SKUs associated with it. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -134,7 +134,7 @@ public static function retrieve($id, $opts = null) * parameters not provided will be left unchanged. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, default_price?: string, description?: null|string, expand?: string[], images?: null|string[], marketing_features?: null|array{name: string}[], metadata?: null|StripeObject, name?: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, statement_descriptor?: string, tax_code?: null|string, unit_label?: null|string, url?: null|string} $params + * @param null|array{active?: bool, default_price?: string, description?: null|string, expand?: string[], images?: null|string[], marketing_features?: null|array{name: string}[], metadata?: null|\Stripe\StripeObject, name?: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, statement_descriptor?: string, tax_code?: null|string, unit_label?: null|string, url?: null|string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/PromotionCode.php b/lib/PromotionCode.php index 5936e0e17..57d600038 100644 --- a/lib/PromotionCode.php +++ b/lib/PromotionCode.php @@ -18,8 +18,8 @@ * @property null|int $expires_at Date at which the promotion code can no longer be redeemed. * @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 null|int $max_redemptions Maximum number of times this promotion code can be redeemed. - * @property null|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 object{currency_options?: \Stripe\StripeObject, first_time_transaction: bool, minimum_amount: null|int, minimum_amount_currency: null|string}&\Stripe\StripeObject&\stdClass $restrictions + * @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 (object{currency_options?: \Stripe\StripeObject, first_time_transaction: bool, minimum_amount: null|int, minimum_amount_currency: null|string}&\Stripe\StripeObject&\stdClass) $restrictions * @property int $times_redeemed Number of times this promotion code has been used. */ class PromotionCode extends ApiResource @@ -95,7 +95,7 @@ public static function retrieve($id, $opts = null) * passed. Most fields are, by design, not editable. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject, restrictions?: array{currency_options?: \Stripe\StripeObject}} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, restrictions?: array{currency_options?: \Stripe\StripeObject}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Quote.php b/lib/Quote.php index 4a7997436..d9b354556 100644 --- a/lib/Quote.php +++ b/lib/Quote.php @@ -16,9 +16,9 @@ * @property null|string|\Stripe\Application $application ID of the Connect Application that created the quote. * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. * @property null|float $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 total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. - * @property object{enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass, status: null|string}&\Stripe\StripeObject&\stdClass $automatic_tax + * @property (object{enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass), status: null|string}&\Stripe\StripeObject&\stdClass) $automatic_tax * @property string $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active. Defaults to charge_automatically. - * @property object{last_reestimation_details?: null|object{failed: null|object{failure_code: null|string, message: null|string, reason: string}&\Stripe\StripeObject&\stdClass, status: string}&\Stripe\StripeObject&\stdClass, recurring: null|object{amount_subtotal: int, amount_total: int, interval: string, interval_count: int, total_details: object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: object{discounts: object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass[], taxes: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, updated_at?: null|int, upfront: object{amount_subtotal: int, amount_total: int, line_items?: \Stripe\Collection<\Stripe\LineItem>, total_details: object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: object{discounts: object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass[], taxes: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $computed + * @property (object{last_reestimation_details?: null|(object{failed: null|(object{failure_code: null|string, message: null|string, reason: string}&\Stripe\StripeObject&\stdClass), status: string}&\Stripe\StripeObject&\stdClass), recurring: null|(object{amount_subtotal: int, amount_total: int, interval: string, interval_count: int, total_details: (object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: (object{discounts: (object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass)[], taxes: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), updated_at?: null|int, upfront: (object{amount_subtotal: int, amount_total: int, line_items?: \Stripe\Collection<\Stripe\LineItem>, total_details: (object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: (object{discounts: (object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass)[], taxes: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $computed * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property null|string|\Stripe\Customer $customer The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. @@ -27,10 +27,10 @@ * @property (string|\Stripe\Discount)[] $discounts The discounts applied to this quote. * @property int $expires_at The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch. * @property null|string $footer A footer that will be displayed on the quote PDF. - * @property null|object{is_revision: bool, quote: string|\Stripe\Quote}&\Stripe\StripeObject&\stdClass $from_quote Details of the quote that was cloned. See the cloning documentation for more details. + * @property null|(object{is_revision: bool, quote: string|\Stripe\Quote}&\Stripe\StripeObject&\stdClass) $from_quote Details of the quote that was cloned. See the cloning documentation for more details. * @property null|string $header A header that will be displayed on the quote PDF. * @property null|string|\Stripe\Invoice $invoice The invoice that was created from this quote. - * @property object{days_until_due: null|int, issuer: object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $invoice_settings + * @property (object{days_until_due: null|int, issuer: (object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $invoice_settings * @property null|\Stripe\Collection<\Stripe\LineItem> $line_items A list of items the customer is being quoted for. * @property null|string[] $lines A list of quote lines on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted. * @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. @@ -38,16 +38,16 @@ * @property null|string $number A unique number that identifies this particular quote. This number is assigned once the quote is finalized. * @property null|string|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the Connect documentation for details. * @property string $status The status of the quote. - * @property null|object{canceled?: object{reason: null|string, transitioned_at: null|int}&\Stripe\StripeObject&\stdClass, stale?: object{expires_at: null|int, last_reason: null|object{line_invalid?: string, lines_invalid?: object{invalid_at: int, lines: string[]}&\Stripe\StripeObject&\stdClass[], marked_stale?: null|string, subscription_canceled?: string, subscription_changed?: object{previous_subscription: null|\Stripe\Subscription}&\Stripe\StripeObject&\stdClass, subscription_expired?: string, subscription_schedule_canceled?: string, subscription_schedule_changed?: object{previous_subscription_schedule: null|\Stripe\SubscriptionSchedule}&\Stripe\StripeObject&\stdClass, subscription_schedule_released?: string, type: null|string}&\Stripe\StripeObject&\stdClass, last_updated_at: null|int, transitioned_at: null|int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $status_details Details on when and why a quote has been marked as stale or canceled. - * @property object{accepted_at: null|int, canceled_at: null|int, finalized_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property null|(object{canceled?: (object{reason: null|string, transitioned_at: null|int}&\Stripe\StripeObject&\stdClass), stale?: (object{expires_at: null|int, last_reason: null|(object{line_invalid?: string, lines_invalid?: (object{invalid_at: int, lines: string[]}&\Stripe\StripeObject&\stdClass)[], marked_stale?: null|string, subscription_canceled?: string, subscription_changed?: (object{previous_subscription: null|\Stripe\Subscription}&\Stripe\StripeObject&\stdClass), subscription_expired?: string, subscription_schedule_canceled?: string, subscription_schedule_changed?: (object{previous_subscription_schedule: null|\Stripe\SubscriptionSchedule}&\Stripe\StripeObject&\stdClass), subscription_schedule_released?: string, type: null|string}&\Stripe\StripeObject&\stdClass), last_updated_at: null|int, transitioned_at: null|int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $status_details Details on when and why a quote has been marked as stale or canceled. + * @property (object{accepted_at: null|int, canceled_at: null|int, finalized_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property null|string|\Stripe\Subscription $subscription The subscription that was created or updated from this quote. - * @property object{bill_on_acceptance?: null|object{bill_from: null|object{computed: null|int, line_starts_at: null|object{id: string}&\Stripe\StripeObject&\stdClass, timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, bill_until: null|object{computed: null|int, duration: null|object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass, line_ends_at: null|object{id: string}&\Stripe\StripeObject&\stdClass, timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, billing_behavior?: string, billing_cycle_anchor?: null|string, description: null|string, effective_date: null|int, end_behavior?: null|string, from_subscription?: null|string|\Stripe\Subscription, metadata: null|StripeObject, prebilling?: null|object{iterations: int}&\Stripe\StripeObject&\stdClass, proration_behavior?: string, trial_period_days: null|int}&\Stripe\StripeObject&\stdClass $subscription_data - * @property null|(object{applies_to: object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass, bill_on_acceptance?: null|object{bill_from: null|object{computed: null|int, line_starts_at: null|object{id: string}&\Stripe\StripeObject&\stdClass, timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, bill_until: null|object{computed: null|int, duration: null|object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass, line_ends_at: null|object{id: string}&\Stripe\StripeObject&\stdClass, timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, billing_behavior?: string, customer: null|string, description: null|string, end_behavior?: null|string, proration_behavior?: null|string}&\Stripe\StripeObject&\stdClass)[] $subscription_data_overrides List representing overrides for subscription_data configurations for specific subscription schedules. + * @property (object{bill_on_acceptance?: null|(object{bill_from: null|(object{computed: null|int, line_starts_at: null|(object{id: string}&\Stripe\StripeObject&\stdClass), timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), bill_until: null|(object{computed: null|int, duration: null|(object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass), line_ends_at: null|(object{id: string}&\Stripe\StripeObject&\stdClass), timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), billing_behavior?: string, billing_cycle_anchor?: null|string, description: null|string, effective_date: null|int, end_behavior?: null|string, from_subscription?: null|string|\Stripe\Subscription, metadata: null|\Stripe\StripeObject, prebilling?: null|(object{iterations: int}&\Stripe\StripeObject&\stdClass), proration_behavior?: string, trial_period_days: null|int}&\Stripe\StripeObject&\stdClass) $subscription_data + * @property null|((object{applies_to: (object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass), bill_on_acceptance?: null|(object{bill_from: null|(object{computed: null|int, line_starts_at: null|(object{id: string}&\Stripe\StripeObject&\stdClass), timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), bill_until: null|(object{computed: null|int, duration: null|(object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass), line_ends_at: null|(object{id: string}&\Stripe\StripeObject&\stdClass), timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), billing_behavior?: string, customer: null|string, description: null|string, end_behavior?: null|string, proration_behavior?: null|string}&\Stripe\StripeObject&\stdClass))[] $subscription_data_overrides List representing overrides for subscription_data configurations for specific subscription schedules. * @property null|string|\Stripe\SubscriptionSchedule $subscription_schedule The subscription schedule that was created or updated from this quote. - * @property null|(object{applies_to: object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass, subscription_schedule: string}&\Stripe\StripeObject&\stdClass)[] $subscription_schedules The subscription schedules that were created or updated from this quote. + * @property null|((object{applies_to: (object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass), subscription_schedule: string}&\Stripe\StripeObject&\stdClass))[] $subscription_schedules The subscription schedules that were created or updated from this quote. * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this quote belongs to. - * @property object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: object{discounts: object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass[], taxes: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $total_details - * @property null|object{amount: null|int, amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. + * @property (object{amount_discount: int, amount_shipping: null|int, amount_tax: int, breakdown?: (object{discounts: (object{amount: int, discount: \Stripe\Discount}&\Stripe\StripeObject&\stdClass)[], taxes: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $total_details + * @property null|(object{amount: null|int, amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass) $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. */ class Quote extends ApiResource { @@ -72,7 +72,7 @@ class Quote extends ApiResource * expires_at can be set in the dashboard via the quote template. * - * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, from_quote?: array{is_revision?: bool, quote: string}, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: string, effective_date?: null|int|array, end_behavior?: string, from_subscription?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: string, end_behavior?: string, proration_behavior?: string}[], test_clock?: string, transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params + * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, from_quote?: array{is_revision?: bool, quote: string}, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|\Stripe\StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: string, effective_date?: null|int|array, end_behavior?: string, from_subscription?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: string, end_behavior?: string, proration_behavior?: string}[], test_clock?: string, transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -131,7 +131,7 @@ public static function retrieve($id, $opts = null) * A quote models prices and services for a customer. * * @param string $id the ID of the resource to update - * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, id?: string, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: null|string, effective_date?: null|int|array, end_behavior?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: null|(array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: null|string, end_behavior?: string, proration_behavior?: string})[], transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params + * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|\Stripe\StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, id?: string, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: null|string, effective_date?: null|int|array, end_behavior?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: null|(array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: null|string, end_behavior?: string, proration_behavior?: string})[], transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/QuoteLine.php b/lib/QuoteLine.php index 5fce94163..364647e66 100644 --- a/lib/QuoteLine.php +++ b/lib/QuoteLine.php @@ -9,16 +9,16 @@ * * @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 (object{add_discount: null|object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{type: string}&\Stripe\StripeObject&\stdClass, index: null|int, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass, add_item: null|object{discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], metadata: null|StripeObject, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, add_metadata: null|StripeObject, remove_discount: null|object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass, remove_item: null|object{price: string|\Stripe\Price}&\Stripe\StripeObject&\stdClass, remove_metadata: null|string[], set_discounts: null|(object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], set_items: null|(object{discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], metadata: null|StripeObject, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[], set_metadata: null|StripeObject, type: string}&\Stripe\StripeObject&\stdClass)[] $actions A list of items the customer is being quoted for. - * @property null|object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass $applies_to Details to identify the subscription schedule the quote line applies to. + * @property ((object{add_discount: null|(object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{type: string}&\Stripe\StripeObject&\stdClass), index: null|int, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass), add_item: null|(object{discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], metadata: null|\Stripe\StripeObject, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|(object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), add_metadata: null|\Stripe\StripeObject, remove_discount: null|(object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass), remove_item: null|(object{price: string|\Stripe\Price}&\Stripe\StripeObject&\stdClass), remove_metadata: null|string[], set_discounts: null|((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], set_items: null|((object{discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], metadata: null|\Stripe\StripeObject, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|(object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[], set_metadata: null|\Stripe\StripeObject, type: string}&\Stripe\StripeObject&\stdClass))[] $actions A list of items the customer is being quoted for. + * @property null|(object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass) $applies_to Details to identify the subscription schedule the quote line applies to. * @property null|string $billing_cycle_anchor For point-in-time quote lines (having no ends_at timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line starts_at timestamp.For time-span based quote lines (having both starts_at and ends_at), the only valid value is automatic, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line. - * @property null|object{cancel_at: string, invoice_now: null|bool, prorate: null|bool}&\Stripe\StripeObject&\stdClass $cancel_subscription_schedule A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with quote_acceptance_date for starts_at. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings. - * @property null|object{computed: null|int, discount_end?: null|object{discount: string}&\Stripe\StripeObject&\stdClass, duration: null|object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass, timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass $ends_at Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at starts_at, and a restricted set of attributes is supported on the quote line. + * @property null|(object{cancel_at: string, invoice_now: null|bool, prorate: null|bool}&\Stripe\StripeObject&\stdClass) $cancel_subscription_schedule A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with quote_acceptance_date for starts_at. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings. + * @property null|(object{computed: null|int, discount_end?: null|(object{discount: string}&\Stripe\StripeObject&\stdClass), duration: null|(object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass), timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass) $ends_at Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at starts_at, and a restricted set of attributes is supported on the quote line. * @property null|string $proration_behavior Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts. - * @property null|object{set?: null|object{behavior: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $set_pause_collection Details to modify the pause_collection behavior of the subscription schedule. + * @property null|(object{set?: null|(object{behavior: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $set_pause_collection Details to modify the pause_collection behavior of the subscription schedule. * @property null|string $set_schedule_end Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date. - * @property null|object{computed: null|int, discount_end?: null|object{discount: string}&\Stripe\StripeObject&\stdClass, line_ends_at: null|object{id: string}&\Stripe\StripeObject&\stdClass, timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass $starts_at Details to identify the earliest timestamp where the proposed change should take effect. - * @property null|object{end_behavior: null|object{prorate_up_front: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $trial_settings Settings related to subscription trials. + * @property null|(object{computed: null|int, discount_end?: null|(object{discount: string}&\Stripe\StripeObject&\stdClass), line_ends_at: null|(object{id: string}&\Stripe\StripeObject&\stdClass), timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass) $starts_at Details to identify the earliest timestamp where the proposed change should take effect. + * @property null|(object{end_behavior: null|(object{prorate_up_front: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $trial_settings Settings related to subscription trials. */ class QuoteLine extends ApiResource { diff --git a/lib/QuotePreviewInvoice.php b/lib/QuotePreviewInvoice.php index 548c33349..9e7284915 100644 --- a/lib/QuotePreviewInvoice.php +++ b/lib/QuotePreviewInvoice.php @@ -48,26 +48,26 @@ * @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|(object{amount: int, amount_paid: int, amount_remaining: int, days_until_due: null|int, description: null|string, due_date: null|int, paid_at: null|int, status: string}&\Stripe\StripeObject&\stdClass)[] $amounts_due List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically. + * @property null|((object{amount: int, amount_paid: int, amount_remaining: int, days_until_due: null|int, description: null|string, due_date: null|int, paid_at: null|int, status: string}&\Stripe\StripeObject&\stdClass))[] $amounts_due List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically. * @property null|string|\Stripe\Application $application ID of the Connect Application that created the invoice. * @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 object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass $applies_to + * @property (object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass) $applies_to * @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. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. * @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 object{disabled_reason: null|string, enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass, status: null|string}&\Stripe\StripeObject&\stdClass $automatic_tax + * @property (object{disabled_reason: null|string, enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass), status: null|string}&\Stripe\StripeObject&\stdClass) $automatic_tax * @property null|int $automatically_finalizes_at The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized. * @property null|string $billing_reason

Indicates the reason why the invoice was created.

* manual: Unrelated to a subscription, for example, created via the invoice editor. * subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * subscription_create: A new subscription was created. * subscription_cycle: A subscription advanced into a new period. * subscription_threshold: A subscription reached a billing threshold. * subscription_update: A subscription was updated. * upcoming: Reserved for simulated invoices, per the upcoming invoice endpoint.

* @property string $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 null|object{name: string, value: string}&\Stripe\StripeObject&\stdClass[] $custom_fields Custom fields displayed on the invoice. - * @property null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass $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 null|(object{name: string, value: string}&\Stripe\StripeObject&\stdClass)[] $custom_fields Custom fields displayed on the invoice. + * @property null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass) $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 null|string $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 null|string $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 null|string $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 null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $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 null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $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 null|string $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 null|(object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass)[] $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 null|((object{type: string, value: null|string}&\Stripe\StripeObject&\stdClass))[] $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 null|(string|\Stripe\Margin)[] $default_margins The margins applied to the invoice. Can be overridden by line item margins. Use expand[]=default_margins to expand each margin. * @property null|string|\Stripe\PaymentMethod $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 null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $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. @@ -79,20 +79,20 @@ * @property null|int $effective_at The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. * @property null|int $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 null|string $footer Footer displayed on the invoice. - * @property null|object{action: string, invoice: string|\Stripe\Invoice}&\Stripe\StripeObject&\stdClass $from_invoice Details of the invoice that was cloned. See the revision documentation for more details. - * @property object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass $issuer - * @property null|object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass $last_finalization_error The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. + * @property null|(object{action: string, invoice: string|\Stripe\Invoice}&\Stripe\StripeObject&\stdClass) $from_invoice Details of the invoice that was cloned. See the revision documentation for more details. + * @property (object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass) $issuer + * @property null|(object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass) $last_finalization_error The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. * @property null|string|\Stripe\Invoice $latest_revision The ID of the most recent non-draft revision of this invoice * @property \Stripe\Collection<\Stripe\InvoiceLineItem> $lines The individual line items that make up the invoice. lines is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order. * @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 null|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|\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|int $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 null|string $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 null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details. * @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 bool $paid_out_of_band Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. * @property null|string|\Stripe\PaymentIntent $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 object{default_mandate: null|string, payment_method_options: null|object{acss_debit: null|object{mandate_options?: object{transaction_type: null|string}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass, bancontact: null|object{preferred_language: string}&\Stripe\StripeObject&\stdClass, card: null|object{installments?: object{enabled: null|bool}&\Stripe\StripeObject&\stdClass, request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass, customer_balance: null|object{bank_transfer?: object{eu_bank_transfer?: object{country: string}&\Stripe\StripeObject&\stdClass, type: null|string}&\Stripe\StripeObject&\stdClass, funding_type: null|string}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: null|object{}&\Stripe\StripeObject&\stdClass, konbini: null|object{}&\Stripe\StripeObject&\stdClass, sepa_debit: null|object{}&\Stripe\StripeObject&\stdClass, us_bank_account: null|object{financial_connections?: object{filters?: object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass, permissions?: string[], prefetch: null|string[]}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payment_method_types: null|string[]}&\Stripe\StripeObject&\stdClass $payment_settings + * @property (object{default_mandate: null|string, payment_method_options: null|(object{acss_debit: null|(object{mandate_options?: (object{transaction_type: null|string}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass), bancontact: null|(object{preferred_language: string}&\Stripe\StripeObject&\stdClass), card: null|(object{installments?: (object{enabled: null|bool}&\Stripe\StripeObject&\stdClass), request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass), customer_balance: null|(object{bank_transfer?: (object{eu_bank_transfer?: (object{country: string}&\Stripe\StripeObject&\stdClass), type: null|string}&\Stripe\StripeObject&\stdClass), funding_type: null|string}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: null|(object{}&\Stripe\StripeObject&\stdClass), konbini: null|(object{}&\Stripe\StripeObject&\stdClass), sepa_debit: null|(object{}&\Stripe\StripeObject&\stdClass), us_bank_account: null|(object{financial_connections?: (object{filters?: (object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass), permissions?: string[], prefetch: null|string[]}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payment_method_types: null|string[]}&\Stripe\StripeObject&\stdClass) $payment_settings * @property null|\Stripe\Collection<\Stripe\InvoicePayment> $payments Payments for this invoice * @property int $period_end End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price. * @property int $period_start Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price. @@ -100,28 +100,28 @@ * @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|object{amount_tax_display: null|string, pdf: null|object{page_size: null|string}&\Stripe\StripeObject&\stdClass, template: null|string, template_version: null|int}&\Stripe\StripeObject&\stdClass $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|object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: (object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $shipping_cost The details of the cost of shipping, including the ShippingRate applied on the invoice. - * @property null|object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass $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. + * @property null|(object{amount_tax_display: null|string, pdf: null|(object{page_size: null|string}&\Stripe\StripeObject&\stdClass), template: null|string, template_version: null|int}&\Stripe\StripeObject&\stdClass) $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|(object{amount_subtotal: int, amount_tax: int, amount_total: int, shipping_rate: null|string|\Stripe\ShippingRate, taxes?: ((object{amount: int, rate: \Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $shipping_cost The details of the cost of shipping, including the ShippingRate applied on the invoice. + * @property null|(object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass) $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. * @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. For revision invoices, this also includes any customer balance that was applied to the original invoice. * @property null|string $statement_descriptor Extra information about an invoice for the customer's credit card statement. * @property null|string $status The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more - * @property object{finalized_at: null|int, marked_uncollectible_at: null|int, paid_at: null|int, voided_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{finalized_at: null|int, marked_uncollectible_at: null|int, paid_at: null|int, voided_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property null|string|\Stripe\Subscription $subscription - * @property null|object{metadata: null|StripeObject, pause_collection?: null|object{behavior: string, resumes_at: null|int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $subscription_details Details about the subscription that created this invoice. + * @property null|(object{metadata: null|\Stripe\StripeObject, pause_collection?: null|(object{behavior: string, resumes_at: null|int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $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 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 object{amount_gte: null|int, item_reasons: object{line_item_ids: string[], usage_gte: int}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass $threshold_reason + * @property (object{amount_gte: null|int, item_reasons: (object{line_item_ids: string[], usage_gte: int}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass) $threshold_reason * @property int $total Total after discounts and taxes. - * @property null|(object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass)[] $total_discount_amounts The aggregate amounts calculated per discount across all line items. + * @property null|((object{amount: int, discount: string|\Stripe\Discount}&\Stripe\StripeObject&\stdClass))[] $total_discount_amounts The aggregate amounts calculated per discount across all line items. * @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 null|(object{amount: int, margin: string|\Stripe\Margin}&\Stripe\StripeObject&\stdClass)[] $total_margin_amounts The aggregate amounts calculated per margin across all line items. - * @property null|(object{amount: int, credit_balance_transaction?: null|string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, margin?: string|\Stripe\Margin, type: string}&\Stripe\StripeObject&\stdClass)[] $total_pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. - * @property (object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass)[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items. - * @property null|object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass $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|((object{amount: int, margin: string|\Stripe\Margin}&\Stripe\StripeObject&\stdClass))[] $total_margin_amounts The aggregate amounts calculated per margin across all line items. + * @property null|((object{amount: int, credit_balance_transaction?: null|string|\Stripe\Billing\CreditBalanceTransaction, discount?: string|\Stripe\Discount, margin?: string|\Stripe\Margin, type: string}&\Stripe\StripeObject&\stdClass))[] $total_pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. + * @property ((object{amount: int, inclusive: bool, tax_rate: string|\Stripe\TaxRate, taxability_reason: null|string, taxable_amount: null|int}&\Stripe\StripeObject&\stdClass))[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items. + * @property null|(object{amount: null|int, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass) $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. */ class QuotePreviewInvoice extends ApiResource diff --git a/lib/QuotePreviewSubscriptionSchedule.php b/lib/QuotePreviewSubscriptionSchedule.php index 164fe3ce8..cb8d60b71 100644 --- a/lib/QuotePreviewSubscriptionSchedule.php +++ b/lib/QuotePreviewSubscriptionSchedule.php @@ -8,20 +8,20 @@ * @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|string|\Stripe\Application $application ID of the Connect Application that created the schedule. - * @property object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass $applies_to + * @property (object{new_reference: null|string, subscription_schedule: null|string, type: string}&\Stripe\StripeObject&\stdClass) $applies_to * @property null|string $billing_behavior Configures when the subscription schedule generates prorations for phase transitions. Possible values are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time. prorate_up_front will bill for all phases within the current billing cycle up front. * @property null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. * @property null|int $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 null|object{end_date: int, start_date: int}&\Stripe\StripeObject&\stdClass $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is active. + * @property null|(object{end_date: int, start_date: int}&\Stripe\StripeObject&\stdClass) $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 object{application_fee_percent: null|float, automatic_tax?: object{disabled_reason: null|string, enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, billing_cycle_anchor: string, billing_thresholds: null|object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass, collection_method: null|string, default_payment_method: null|string|\Stripe\PaymentMethod, description: null|string, invoice_settings: object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, on_behalf_of: null|string|\Stripe\Account, transfer_data: null|object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $default_settings + * @property (object{application_fee_percent: null|float, automatic_tax?: (object{disabled_reason: null|string, enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), billing_cycle_anchor: string, billing_thresholds: null|(object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass), collection_method: null|string, default_payment_method: null|string|\Stripe\PaymentMethod, description: null|string, invoice_settings: (object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: (object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), on_behalf_of: null|string|\Stripe\Account, transfer_data: null|(object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $default_settings * @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription. - * @property null|object{errored_at: int, failed_transitions: object{source_price: string, target_price: string}&\Stripe\StripeObject&\stdClass[], type: string}&\Stripe\StripeObject&\stdClass $last_price_migration_error Details of the most recent price migration that failed for the subscription schedule. + * @property null|(object{errored_at: int, failed_transitions: (object{source_price: string, target_price: string}&\Stripe\StripeObject&\stdClass)[], type: string}&\Stripe\StripeObject&\stdClass) $last_price_migration_error Details of the most recent price migration that failed for the subscription schedule. * @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 null|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 (object{add_invoice_items: (object{discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], price: string|\Stripe\Price, quantity: null|int, tax_rates?: null|\Stripe\TaxRate[]}&\Stripe\StripeObject&\stdClass)[], application_fee_percent: null|float, automatic_tax?: object{disabled_reason: null|string, enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, billing_cycle_anchor: null|string, billing_thresholds: null|object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass, collection_method: null|string, coupon: null|string|\Stripe\Coupon, currency: string, default_payment_method: null|string|\Stripe\PaymentMethod, default_tax_rates?: null|\Stripe\TaxRate[], description: null|string, discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], end_date: int, invoice_settings: null|object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, items: (object{billing_thresholds: null|object{usage_gte: null|int}&\Stripe\StripeObject&\stdClass, discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], metadata: null|StripeObject, plan: string|\Stripe\Plan, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[], metadata: null|StripeObject, on_behalf_of: null|string|\Stripe\Account, pause_collection?: null|object{behavior: string}&\Stripe\StripeObject&\stdClass, proration_behavior: string, start_date: int, transfer_data: null|object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass, trial_continuation?: null|string, trial_end: null|int, trial_settings?: null|object{end_behavior: null|object{prorate_up_front: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[] $phases Configuration for the subscription schedule's phases. - * @property null|object{invoice: string|\Stripe\Invoice, period_end: int, period_start: int, update_behavior?: string}&\Stripe\StripeObject&\stdClass $prebilling Time period and invoice for a Subscription billed in advance. + * @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 ((object{add_invoice_items: ((object{discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], price: string|\Stripe\Price, quantity: null|int, tax_rates?: null|\Stripe\TaxRate[]}&\Stripe\StripeObject&\stdClass))[], application_fee_percent: null|float, automatic_tax?: (object{disabled_reason: null|string, enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), billing_cycle_anchor: null|string, billing_thresholds: null|(object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass), collection_method: null|string, coupon: null|string|\Stripe\Coupon, currency: string, default_payment_method: null|string|\Stripe\PaymentMethod, default_tax_rates?: null|\Stripe\TaxRate[], description: null|string, discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], end_date: int, invoice_settings: null|(object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), items: ((object{billing_thresholds: null|(object{usage_gte: null|int}&\Stripe\StripeObject&\stdClass), discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], metadata: null|\Stripe\StripeObject, plan: string|\Stripe\Plan, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|(object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[], metadata: null|\Stripe\StripeObject, on_behalf_of: null|string|\Stripe\Account, pause_collection?: null|(object{behavior: string}&\Stripe\StripeObject&\stdClass), proration_behavior: string, start_date: int, transfer_data: null|(object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass), trial_continuation?: null|string, trial_end: null|int, trial_settings?: null|(object{end_behavior: null|(object{prorate_up_front: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[] $phases Configuration for the subscription schedule's phases. + * @property null|(object{invoice: string|\Stripe\Invoice, period_end: int, period_start: int, update_behavior?: string}&\Stripe\StripeObject&\stdClass) $prebilling Time period and invoice for a Subscription billed in advance. * @property null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. * @property null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released). * @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. diff --git a/lib/Radar/ValueList.php b/lib/Radar/ValueList.php index 022440b0d..b4dffa27f 100644 --- a/lib/Radar/ValueList.php +++ b/lib/Radar/ValueList.php @@ -65,7 +65,7 @@ public static function create($params = null, $options = null) * within the value list. To be deleted, a value list must not be referenced in any * rules. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Radar/ValueListItem.php b/lib/Radar/ValueListItem.php index 9716fcec5..0881772c8 100644 --- a/lib/Radar/ValueListItem.php +++ b/lib/Radar/ValueListItem.php @@ -48,7 +48,7 @@ public static function create($params = null, $options = null) * Deletes a ValueListItem object, removing it from its parent value * list. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Refund.php b/lib/Refund.php index b1b7f7472..10742b2d6 100644 --- a/lib/Refund.php +++ b/lib/Refund.php @@ -19,12 +19,12 @@ * @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. You can use this for displaying to users (available on non-card refunds only). - * @property object{affirm?: object{}&\Stripe\StripeObject&\stdClass, afterpay_clearpay?: object{}&\Stripe\StripeObject&\stdClass, alipay?: object{}&\Stripe\StripeObject&\stdClass, alma?: object{}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{}&\Stripe\StripeObject&\stdClass, au_bank_transfer?: object{}&\Stripe\StripeObject&\stdClass, blik?: object{network_decline_code?: null|string, reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, br_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, card?: object{reference?: string, reference_status?: string, reference_type?: string, type: string}&\Stripe\StripeObject&\stdClass, cashapp?: object{}&\Stripe\StripeObject&\stdClass, customer_cash_balance?: object{}&\Stripe\StripeObject&\stdClass, eps?: object{}&\Stripe\StripeObject&\stdClass, eu_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, gb_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, giropay?: object{}&\Stripe\StripeObject&\stdClass, grabpay?: object{}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, jp_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, klarna?: object{}&\Stripe\StripeObject&\stdClass, multibanco?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, mx_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, p24?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, paynow?: object{}&\Stripe\StripeObject&\stdClass, paypal?: object{}&\Stripe\StripeObject&\stdClass, pix?: object{}&\Stripe\StripeObject&\stdClass, revolut?: object{}&\Stripe\StripeObject&\stdClass, sofort?: object{}&\Stripe\StripeObject&\stdClass, swish?: object{network_decline_code?: null|string, reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, th_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, type: string, us_bank_transfer?: object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass, wechat_pay?: object{}&\Stripe\StripeObject&\stdClass, zip?: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $destination_details + * @property (object{affirm?: (object{}&\Stripe\StripeObject&\stdClass), afterpay_clearpay?: (object{}&\Stripe\StripeObject&\stdClass), alipay?: (object{}&\Stripe\StripeObject&\stdClass), alma?: (object{}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{}&\Stripe\StripeObject&\stdClass), au_bank_transfer?: (object{}&\Stripe\StripeObject&\stdClass), blik?: (object{network_decline_code?: null|string, reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), br_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), card?: (object{reference?: string, reference_status?: string, reference_type?: string, type: string}&\Stripe\StripeObject&\stdClass), cashapp?: (object{}&\Stripe\StripeObject&\stdClass), customer_cash_balance?: (object{}&\Stripe\StripeObject&\stdClass), eps?: (object{}&\Stripe\StripeObject&\stdClass), eu_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), gb_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), giropay?: (object{}&\Stripe\StripeObject&\stdClass), grabpay?: (object{}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), jp_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), klarna?: (object{}&\Stripe\StripeObject&\stdClass), multibanco?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), mx_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), p24?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), paynow?: (object{}&\Stripe\StripeObject&\stdClass), paypal?: (object{}&\Stripe\StripeObject&\stdClass), pix?: (object{}&\Stripe\StripeObject&\stdClass), revolut?: (object{}&\Stripe\StripeObject&\stdClass), sofort?: (object{}&\Stripe\StripeObject&\stdClass), swish?: (object{network_decline_code?: null|string, reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), th_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), type: string, us_bank_transfer?: (object{reference: null|string, reference_status: null|string}&\Stripe\StripeObject&\stdClass), wechat_pay?: (object{}&\Stripe\StripeObject&\stdClass), zip?: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $destination_details * @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. * @property null|string $failure_reason Provides the reason for the refund failure. Possible values are: lost_or_stolen_card, expired_or_canceled_card, charge_for_pending_refund_disputed, insufficient_funds, declined, merchant_request, or unknown. * @property null|string $instructions_email For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. - * @property null|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|object{display_details?: object{email_sent: object{email_sent_at: int, email_sent_to: string}&\Stripe\StripeObject&\stdClass, expires_at: int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $next_action + * @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|(object{display_details?: (object{email_sent: (object{email_sent_at: int, email_sent_to: string}&\Stripe\StripeObject&\stdClass), expires_at: int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $next_action * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that's refunded. * @property null|string $reason Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge). * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this refund. @@ -68,7 +68,7 @@ class Refund extends ApiResource * an error when called on an already-refunded charge, or when trying to refund * more money than is left on a charge. * - * @param null|array{amount?: int, charge?: string, currency?: string, customer?: string, expand?: string[], instructions_email?: string, metadata?: null|StripeObject, origin?: string, payment_intent?: string, reason?: string, refund_application_fee?: bool, reverse_transfer?: bool} $params + * @param null|array{amount?: int, charge?: string, currency?: string, customer?: string, expand?: string[], instructions_email?: string, metadata?: null|\Stripe\StripeObject, origin?: string, payment_intent?: string, reason?: string, refund_application_fee?: bool, reverse_transfer?: bool} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -132,7 +132,7 @@ public static function retrieve($id, $opts = null) * This request only accepts metadata as an argument. * * @param string $id the ID of the resource to update - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Reporting/ReportRun.php b/lib/Reporting/ReportRun.php index 19ffe8800..e26b7d5bd 100644 --- a/lib/Reporting/ReportRun.php +++ b/lib/Reporting/ReportRun.php @@ -19,7 +19,7 @@ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $error If something should go wrong during the run, a message about the failure (populated when status=failed). * @property bool $livemode true if the report is run on live mode data and false if it is run on test mode data. - * @property object{columns?: string[], connected_account?: string, currency?: string, interval_end?: int, interval_start?: int, payout?: string, reporting_category?: string, timezone?: string}&\Stripe\StripeObject&\stdClass $parameters + * @property (object{columns?: string[], connected_account?: string, currency?: string, interval_end?: int, interval_start?: int, payout?: string, reporting_category?: string, timezone?: string}&\Stripe\StripeObject&\stdClass) $parameters * @property string $report_type The ID of the report type to run, such as "balance.summary.1". * @property null|\Stripe\File $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. diff --git a/lib/Review.php b/lib/Review.php index 5f4abcdf4..0525e1908 100644 --- a/lib/Review.php +++ b/lib/Review.php @@ -17,13 +17,13 @@ * @property null|string $closed_reason The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, or redacted. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $ip_address The IP address where the payment originated. - * @property null|object{city: null|string, country: null|string, latitude: null|float, longitude: null|float, region: null|string}&\Stripe\StripeObject&\stdClass $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 null|(object{city: null|string, country: null|string, latitude: null|float, longitude: null|float, region: null|string}&\Stripe\StripeObject&\stdClass) $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 null|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, disputed, or redacted. - * @property null|object{browser: null|string, device: null|string, platform: null|string, version: null|string}&\Stripe\StripeObject&\stdClass $session Information related to the browsing session of the user who initiated the payment. + * @property null|(object{browser: null|string, device: null|string, platform: null|string, version: null|string}&\Stripe\StripeObject&\stdClass) $session Information related to the browsing session of the user who initiated the payment. */ class Review extends ApiResource { diff --git a/lib/Service/AccountService.php b/lib/Service/AccountService.php index 48650b738..73783f129 100644 --- a/lib/Service/AccountService.php +++ b/lib/Service/AccountService.php @@ -90,7 +90,7 @@ public function allPersons($parentId, $params = null, $opts = null) * information during account onboarding. You can prefill any information on the * account. * - * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, controller?: array{application?: array{loss_liable: bool, onboarding_owner?: bool, pricing_controls?: bool}, dashboard?: array{type?: string}, fees?: array{payer?: string}, losses?: array{payments?: string}, requirement_collection?: string, stripe_dashboard?: array{type?: string}}, country?: string, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}, type?: string} $params + * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, controller?: array{application?: array{loss_liable: bool, onboarding_owner?: bool, pricing_controls?: bool}, dashboard?: array{type?: string}, fees?: array{payer?: string}, losses?: array{payments?: string}, requirement_collection?: string, stripe_dashboard?: array{type?: string}}, country?: string, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|\Stripe\StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}, type?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -142,7 +142,7 @@ public function createLoginLink($parentId, $params = null, $opts = null) * Creates a new person. * * @param string $parentId - * @param null|array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, expand?: string[], first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, nationality?: string, person_token?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}} $params + * @param null|array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, expand?: string[], first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, nationality?: string, person_token?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -170,7 +170,7 @@ public function createPerson($parentId, $params = null, $opts = null) * your account settings instead. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -187,7 +187,7 @@ public function delete($id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -208,7 +208,7 @@ public function deleteExternalAccount($parentId, $id, $params = null, $opts = nu * * @param string $parentId * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -315,7 +315,7 @@ public function retrievePerson($parentId, $id, $params = null, $opts = null) * more about updating accounts. * * @param string $id - * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: null|string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, invoices?: array{default_account_tax_ids?: null|string[]}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}} $params + * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, automatic_indirect_tax?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, gopay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, id_bank_transfer_payments?: array{requested?: bool}, id_bank_transfer_payments_bca?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mb_way_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, paypal_payments?: array{requested?: bool}, payto_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, qris_payments?: array{requested?: bool}, rechnung_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, shopeepay_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, treasury_evolve?: array{requested?: bool}, treasury_fifth_third?: array{requested?: bool}, treasury_goldman_sachs?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: null|string|array, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|\Stripe\StripeObject, risk_controls?: array{charges?: array{pause_requested?: bool}, payouts?: array{pause_requested?: bool}}, settings?: array{bacs_debit_payments?: array{display_name?: string}, bank_bca_onboarding?: array{account_holder_name?: string, business_account_number?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, capital?: array{payout_destination?: \Stripe\StripeObject, payout_destination_selector?: \Stripe\StripeObject}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, invoices?: array{default_account_tax_ids?: null|string[]}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: int|array, interval?: string, monthly_anchor?: int, weekly_anchor?: string}, statement_descriptor?: string}, tax_forms?: array{consented_to_paperless_delivery?: bool}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -360,7 +360,7 @@ public function updateCapability($parentId, $id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{account_holder_name?: string, account_holder_type?: null|string, account_type?: string, address_city?: string, address_country?: string, address_line1?: string, address_line2?: string, address_state?: string, address_zip?: string, default_for_currency?: bool, documents?: array{bank_account_ownership_verification?: array{files?: string[]}}, exp_month?: string, exp_year?: string, expand?: string[], metadata?: null|StripeObject, name?: string} $params + * @param null|array{account_holder_name?: string, account_holder_type?: null|string, account_type?: string, address_city?: string, address_country?: string, address_line1?: string, address_line2?: string, address_state?: string, address_zip?: string, default_for_currency?: bool, documents?: array{bank_account_ownership_verification?: array{files?: string[]}}, exp_month?: string, exp_year?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -377,7 +377,7 @@ public function updateExternalAccount($parentId, $id, $params = null, $opts = nu * * @param string $parentId * @param string $id - * @param null|array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, expand?: string[], first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, nationality?: string, person_token?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}} $params + * @param null|array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, expand?: string[], first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, nationality?: string, person_token?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/ApplePayDomainService.php b/lib/Service/ApplePayDomainService.php index 86c9ac1f3..3c2b6f98f 100644 --- a/lib/Service/ApplePayDomainService.php +++ b/lib/Service/ApplePayDomainService.php @@ -44,7 +44,7 @@ public function create($params = null, $opts = null) * Delete an apple pay domain. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/ApplicationFeeService.php b/lib/Service/ApplicationFeeService.php index 3b3d35960..cb4383eee 100644 --- a/lib/Service/ApplicationFeeService.php +++ b/lib/Service/ApplicationFeeService.php @@ -115,7 +115,7 @@ public function retrieveRefund($parentId, $id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/BillingPortal/ConfigurationService.php b/lib/Service/BillingPortal/ConfigurationService.php index 6e9d778fb..c0f8ea635 100644 --- a/lib/Service/BillingPortal/ConfigurationService.php +++ b/lib/Service/BillingPortal/ConfigurationService.php @@ -63,7 +63,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates a configuration that describes the functionality of the customer portal. * * @param string $id - * @param null|array{active?: bool, business_profile?: array{headline?: null|string, privacy_policy_url?: null|string, terms_of_service_url?: null|string}, default_return_url?: null|string, expand?: string[], features?: array{customer_update?: array{allowed_updates?: null|string[], enabled?: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options?: null|string[]}, enabled?: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled?: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: null|array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: null|StripeObject} $params + * @param null|array{active?: bool, business_profile?: array{headline?: null|string, privacy_policy_url?: null|string, terms_of_service_url?: null|string}, default_return_url?: null|string, expand?: string[], features?: array{customer_update?: array{allowed_updates?: null|string[], enabled?: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options?: null|string[]}, enabled?: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled?: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: null|array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/ChargeService.php b/lib/Service/ChargeService.php index 9f035788b..af1a9ff40 100644 --- a/lib/Service/ChargeService.php +++ b/lib/Service/ChargeService.php @@ -56,7 +56,7 @@ public function capture($id, $params = null, $opts = null) * payment instead. Confirmation of the PaymentIntent creates the * Charge object used to request payment. * - * @param null|array{amount?: int, application_fee?: int, application_fee_amount?: int, capture?: bool, currency?: string, customer?: string, description?: string, destination?: array{account: string, amount?: int}, expand?: string[], metadata?: null|StripeObject, on_behalf_of?: string, radar_options?: array{session?: string}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, source?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}, transfer_group?: string} $params + * @param null|array{amount?: int, application_fee?: int, application_fee_amount?: int, capture?: bool, currency?: string, customer?: string, description?: string, destination?: array{account: string, amount?: int}, expand?: string[], metadata?: null|\Stripe\StripeObject, on_behalf_of?: string, radar_options?: array{session?: string}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, source?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}, transfer_group?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -112,7 +112,7 @@ public function search($params = null, $opts = null) * parameters not provided will be left unchanged. * * @param string $id - * @param null|array{customer?: string, description?: string, expand?: string[], fraud_details?: array{user_report: null|string}, metadata?: null|StripeObject, payment_details?: array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, transfer_group?: string} $params + * @param null|array{customer?: string, description?: string, expand?: string[], fraud_details?: array{user_report: null|string}, metadata?: null|\Stripe\StripeObject, payment_details?: array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, transfer_group?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Checkout/SessionService.php b/lib/Service/Checkout/SessionService.php index b548175b4..ddb43ce52 100644 --- a/lib/Service/Checkout/SessionService.php +++ b/lib/Service/Checkout/SessionService.php @@ -98,7 +98,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates a Session object. * * @param string $id - * @param null|array{collected_information?: array{shipping_details?: array{address: array{city?: string, country: string, line1: string, line2?: string, postal_code?: string, state?: string}, name: string}}, expand?: string[], line_items?: (array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id?: string, metadata?: null|StripeObject, price?: string, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|StripeObject, shipping_options?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[]} $params + * @param null|array{collected_information?: array{shipping_details?: array{address: array{city?: string, country: string, line1: string, line2?: string, postal_code?: string, state?: string}, name: string}}, expand?: string[], line_items?: (array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id?: string, metadata?: null|\Stripe\StripeObject, price?: string, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|\Stripe\StripeObject, shipping_options?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/CouponService.php b/lib/Service/CouponService.php index fcec52432..b7765f9ba 100644 --- a/lib/Service/CouponService.php +++ b/lib/Service/CouponService.php @@ -41,7 +41,7 @@ public function all($params = null, $opts = null) * a coupon with an amount_off of 200 is applied to * it. * - * @param null|array{amount_off?: int, applies_to?: array{products?: string[]}, currency?: string, currency_options?: \Stripe\StripeObject, duration?: string, duration_in_months?: int, expand?: string[], id?: string, max_redemptions?: int, metadata?: null|StripeObject, name?: string, percent_off?: float, redeem_by?: int} $params + * @param null|array{amount_off?: int, applies_to?: array{products?: string[]}, currency?: string, currency_options?: \Stripe\StripeObject, duration?: string, duration_in_months?: int, expand?: string[], id?: string, max_redemptions?: int, metadata?: null|\Stripe\StripeObject, name?: string, percent_off?: float, redeem_by?: int} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -61,7 +61,7 @@ public function create($params = null, $opts = null) * coupon. You can also delete coupons via the API. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -94,7 +94,7 @@ public function retrieve($id, $params = null, $opts = null) * amount_off) are, by design, not editable. * * @param string $id - * @param null|array{currency_options?: \Stripe\StripeObject, expand?: string[], metadata?: null|StripeObject, name?: string} $params + * @param null|array{currency_options?: \Stripe\StripeObject, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/CustomerService.php b/lib/Service/CustomerService.php index 1e0ba5b9e..c798b9cb4 100644 --- a/lib/Service/CustomerService.php +++ b/lib/Service/CustomerService.php @@ -111,7 +111,7 @@ public function allTaxIds($parentId, $params = null, $opts = null) /** * Creates a new customer object. * - * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|StripeObject, name?: string, next_invoice_sequence?: int, payment_method?: string, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, tax_id_data?: array{type: string, value: string}[], test_clock?: string, validate?: bool} $params + * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|\Stripe\StripeObject, name?: string, next_invoice_sequence?: int, payment_method?: string, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, tax_id_data?: array{type: string, value: string}[], test_clock?: string, validate?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -128,7 +128,7 @@ public function create($params = null, $opts = null) * href="/docs/billing/customer/balance">balance. * * @param string $parentId - * @param null|array{amount: int, currency: string, description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{amount: int, currency: string, description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -203,7 +203,7 @@ public function createTaxId($parentId, $params = null, $opts = null) * any active subscriptions on the customer. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -219,7 +219,7 @@ public function delete($id, $params = null, $opts = null) * Removes the currently applied discount on a customer. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -253,7 +253,7 @@ public function deleteSource($parentId, $id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -420,7 +420,7 @@ public function search($params = null, $opts = null) * This request accepts mostly the same arguments as the customer creation call. * * @param string $id - * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, default_source?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|StripeObject, name?: string, next_invoice_sequence?: int, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, validate?: bool} $params + * @param null|array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, balance?: int, cash_balance?: array{settings?: array{reconciliation_mode?: string}}, coupon?: string, default_source?: string, description?: string, email?: string, expand?: string[], invoice_prefix?: string, invoice_settings?: array{custom_fields?: null|array{name: string, value: string}[], default_payment_method?: string, footer?: string, rendering_options?: null|array{amount_tax_display?: null|string, template?: string}}, metadata?: null|\Stripe\StripeObject, name?: string, next_invoice_sequence?: int, phone?: string, preferred_locales?: string[], promotion_code?: string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, source?: string, tax?: array{ip_address?: null|string, validate_location?: string}, tax_exempt?: null|string, validate?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -438,7 +438,7 @@ public function update($id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -471,7 +471,7 @@ public function updateCashBalance($parentId, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{account_holder_name?: string, account_holder_type?: string, address_city?: string, address_country?: string, address_line1?: string, address_line2?: string, address_state?: string, address_zip?: string, exp_month?: string, exp_year?: string, expand?: string[], metadata?: null|StripeObject, name?: string, owner?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}} $params + * @param null|array{account_holder_name?: string, account_holder_type?: string, address_city?: string, address_country?: string, address_line1?: string, address_line2?: string, address_state?: string, address_zip?: string, exp_month?: string, exp_year?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string, owner?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/DisputeService.php b/lib/Service/DisputeService.php index 5ff72f5d8..2b96a6bdd 100644 --- a/lib/Service/DisputeService.php +++ b/lib/Service/DisputeService.php @@ -73,7 +73,7 @@ public function retrieve($id, $params = null, $opts = null) * see our guide to dispute types. * * @param string $id - * @param null|array{evidence?: array{access_activity_log?: string, billing_address?: string, cancellation_policy?: string, cancellation_policy_disclosure?: string, cancellation_rebuttal?: string, customer_communication?: string, customer_email_address?: string, customer_name?: string, customer_purchase_ip?: string, customer_signature?: string, duplicate_charge_documentation?: string, duplicate_charge_explanation?: string, duplicate_charge_id?: string, enhanced_evidence?: null|array{visa_compelling_evidence_3?: array{disputed_transaction?: array{customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, merchandise_or_services?: string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}}, prior_undisputed_transactions?: (array{charge: string, customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}})[]}}, product_description?: string, receipt?: string, refund_policy?: string, refund_policy_disclosure?: string, refund_refusal_explanation?: string, service_date?: string, service_documentation?: string, shipping_address?: string, shipping_carrier?: string, shipping_date?: string, shipping_documentation?: string, shipping_tracking_number?: string, uncategorized_file?: string, uncategorized_text?: string}, expand?: string[], metadata?: null|StripeObject, submit?: bool} $params + * @param null|array{evidence?: array{access_activity_log?: string, billing_address?: string, cancellation_policy?: string, cancellation_policy_disclosure?: string, cancellation_rebuttal?: string, customer_communication?: string, customer_email_address?: string, customer_name?: string, customer_purchase_ip?: string, customer_signature?: string, duplicate_charge_documentation?: string, duplicate_charge_explanation?: string, duplicate_charge_id?: string, enhanced_evidence?: null|array{visa_compelling_evidence_3?: array{disputed_transaction?: array{customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, merchandise_or_services?: string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}}, prior_undisputed_transactions?: (array{charge: string, customer_account_id?: null|string, customer_device_fingerprint?: null|string, customer_device_id?: null|string, customer_email_address?: null|string, customer_purchase_ip?: null|string, product_description?: null|string, shipping_address?: array{city?: null|string, country?: null|string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}})[]}}, product_description?: string, receipt?: string, refund_policy?: string, refund_policy_disclosure?: string, refund_refusal_explanation?: string, service_date?: string, service_documentation?: string, shipping_address?: string, shipping_carrier?: string, shipping_date?: string, shipping_documentation?: string, shipping_tracking_number?: string, uncategorized_file?: string, uncategorized_text?: string}, expand?: string[], metadata?: null|\Stripe\StripeObject, submit?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Entitlements/FeatureService.php b/lib/Service/Entitlements/FeatureService.php index f037139c0..e72696e8e 100644 --- a/lib/Service/Entitlements/FeatureService.php +++ b/lib/Service/Entitlements/FeatureService.php @@ -60,7 +60,7 @@ public function retrieve($id, $params = null, $opts = null) * Update a feature’s metadata or permanently deactivate it. * * @param string $id - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject, name?: string} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/FileLinkService.php b/lib/Service/FileLinkService.php index ba6e1bc1d..ffca3c113 100644 --- a/lib/Service/FileLinkService.php +++ b/lib/Service/FileLinkService.php @@ -28,7 +28,7 @@ public function all($params = null, $opts = null) /** * Creates a new file link object. * - * @param null|array{expand?: string[], expires_at?: int, file: string, metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], expires_at?: int, file: string, metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -60,7 +60,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates an existing file link object. Expired links can no longer be updated. * * @param string $id - * @param null|array{expand?: string[], expires_at?: null|int|array, metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], expires_at?: null|int|array, metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/GiftCards/CardService.php b/lib/Service/GiftCards/CardService.php index 5fedebe65..85aece92b 100644 --- a/lib/Service/GiftCards/CardService.php +++ b/lib/Service/GiftCards/CardService.php @@ -60,7 +60,7 @@ public function retrieve($id, $params = null, $opts = null) * Update a gift card. * * @param string $id - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/GiftCards/TransactionService.php b/lib/Service/GiftCards/TransactionService.php index 9336f52fd..ac969b1c2 100644 --- a/lib/Service/GiftCards/TransactionService.php +++ b/lib/Service/GiftCards/TransactionService.php @@ -92,7 +92,7 @@ public function retrieve($id, $params = null, $opts = null) * Update a gift card transaction. * * @param string $id - * @param null|array{description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/InvoiceItemService.php b/lib/Service/InvoiceItemService.php index 93118c14a..c63f752ab 100644 --- a/lib/Service/InvoiceItemService.php +++ b/lib/Service/InvoiceItemService.php @@ -31,7 +31,7 @@ public function all($params = null, $opts = null) * no invoice is specified, the item will be on the next invoice created for the * customer specified. * - * @param null|array{amount?: int, currency?: string, customer: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice?: string, margins?: string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, subscription?: string, tax_behavior?: string, tax_code?: null|string, tax_rates?: string[], unit_amount?: int, unit_amount_decimal?: string} $params + * @param null|array{amount?: int, currency?: string, customer: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice?: string, margins?: string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, subscription?: string, tax_behavior?: string, tax_code?: null|string, tax_rates?: string[], unit_amount?: int, unit_amount_decimal?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -49,7 +49,7 @@ public function create($params = null, $opts = null) * draft invoice. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -83,7 +83,7 @@ public function retrieve($id, $params = null, $opts = null) * closed. * * @param string $id - * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string} $params + * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/InvoiceService.php b/lib/Service/InvoiceService.php index d18a8ebfb..001e3d9db 100644 --- a/lib/Service/InvoiceService.php +++ b/lib/Service/InvoiceService.php @@ -15,7 +15,7 @@ class InvoiceService extends \Stripe\Service\AbstractService * still a draft. * * @param string $id - * @param null|array{expand?: string[], invoice_metadata?: null|StripeObject, lines: (array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoice_item?: string, margins?: null|string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]})[]} $params + * @param null|array{expand?: string[], invoice_metadata?: null|\Stripe\StripeObject, lines: (array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoice_item?: string, margins?: null|string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]})[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -101,7 +101,7 @@ public function allPayments($parentId, $params = null, $opts = null) * learn more. * * @param string $id - * @param null|array{amount_requested?: int, expand?: string[], payment_intent?: string, payment_record?: string, payment_record_data?: array{amount: int, currency: string, metadata?: null|StripeObject, money_movement_type: string, paid_at?: int, payment_reference?: string}} $params + * @param null|array{amount_requested?: int, expand?: string[], payment_intent?: string, payment_record?: string, payment_record_data?: array{amount: int, currency: string, metadata?: null|\Stripe\StripeObject, money_movement_type: string, paid_at?: int, payment_reference?: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -145,7 +145,7 @@ public function attachPaymentIntent($id, $params = null, $opts = null) * allows you to pay or send * the invoice to your customers. * - * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, currency?: string, custom_fields?: null|array{name: string, value: string}[], customer?: string, days_until_due?: int, default_margins?: string[], default_payment_method?: string, default_source?: string, default_tax_rates?: string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: int, expand?: string[], footer?: string, from_invoice?: array{action: string, invoice: string}, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, number?: string, on_behalf_of?: string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, pending_invoice_items_behavior?: string, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, subscription?: string, transfer_data?: array{amount?: int, destination: string}} $params + * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, currency?: string, custom_fields?: null|array{name: string, value: string}[], customer?: string, days_until_due?: int, default_margins?: string[], default_payment_method?: string, default_source?: string, default_tax_rates?: string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: int, expand?: string[], footer?: string, from_invoice?: array{action: string, invoice: string}, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, number?: string, on_behalf_of?: string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, pending_invoice_items_behavior?: string, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, subscription?: string, transfer_data?: array{amount?: int, destination: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -184,7 +184,7 @@ public function create($params = null, $opts = null) * invoice creation. Learn * more * - * @param null|array{automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, coupon?: string, currency?: string, customer?: string, customer_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, tax?: array{ip_address?: null|string}, tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_items?: (array{amount?: int, currency?: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoiceitem?: string, metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string})[], issuer?: array{account?: string, type: string}, on_behalf_of?: null|string, preview_mode?: string, schedule?: string, schedule_details?: array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], billing_behavior?: string, end_behavior?: string, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: null|array{bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, iterations?: int}[], proration_behavior?: string}, subscription?: string, subscription_details?: array{billing_cycle_anchor?: int|array, cancel_at?: null|int, cancel_at_period_end?: bool, cancel_now?: bool, default_tax_rates?: null|string[], items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], prebilling?: array{iterations: int}, proration_behavior?: string, proration_date?: int, resume_at?: string, start_date?: int, trial_end?: int|array}} $params + * @param null|array{automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, coupon?: string, currency?: string, customer?: string, customer_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, tax?: array{ip_address?: null|string}, tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_items?: (array{amount?: int, currency?: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoiceitem?: string, metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string})[], issuer?: array{account?: string, type: string}, on_behalf_of?: null|string, preview_mode?: string, schedule?: string, schedule_details?: array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|\Stripe\StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], billing_behavior?: string, end_behavior?: string, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: null|array{bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, iterations?: int}[], proration_behavior?: string}, subscription?: string, subscription_details?: array{billing_cycle_anchor?: int|array, cancel_at?: null|int, cancel_at_period_end?: bool, cancel_now?: bool, default_tax_rates?: null|string[], items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|\Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], prebilling?: array{iterations: int}, proration_behavior?: string, proration_date?: int, resume_at?: string, start_date?: int, trial_end?: int|array}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -203,7 +203,7 @@ public function createPreview($params = null, $opts = null) * href="#void_invoice">voided. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -275,7 +275,7 @@ public function pay($id, $params = null, $opts = null) * invoice is still a draft. * * @param string $id - * @param null|array{expand?: string[], invoice_metadata?: null|StripeObject, lines: array{behavior: string, id: string}[]} $params + * @param null|array{expand?: string[], invoice_metadata?: null|\Stripe\StripeObject, lines: array{behavior: string, id: string}[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -390,7 +390,7 @@ public function sendInvoice($id, $params = null, $opts = null) * invoice creation. Learn * more * - * @param null|array{automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, coupon?: string, currency?: string, customer?: string, customer_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, tax?: array{ip_address?: null|string}, tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_items?: (array{amount?: int, currency?: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoiceitem?: string, metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string})[], issuer?: array{account?: string, type: string}, on_behalf_of?: null|string, preview_mode?: string, schedule?: string, schedule_details?: array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], billing_behavior?: string, end_behavior?: string, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: null|array{bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, iterations?: int}[], proration_behavior?: string}, subscription?: string, subscription_billing_cycle_anchor?: int|array, subscription_cancel_at?: null|int, subscription_cancel_at_period_end?: bool, subscription_cancel_now?: bool, subscription_default_tax_rates?: null|string[], subscription_details?: array{billing_cycle_anchor?: int|array, cancel_at?: null|int, cancel_at_period_end?: bool, cancel_now?: bool, default_tax_rates?: null|string[], items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], prebilling?: array{iterations: int}, proration_behavior?: string, proration_date?: int, resume_at?: string, start_date?: int, trial_end?: int|array}, subscription_items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], subscription_prebilling?: array{iterations: int}, subscription_proration_behavior?: string, subscription_proration_date?: int, subscription_resume_at?: string, subscription_start_date?: int, subscription_trial_end?: int|array, subscription_trial_from_plan?: bool} $params + * @param null|array{automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, coupon?: string, currency?: string, customer?: string, customer_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, tax?: array{ip_address?: null|string}, tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_items?: (array{amount?: int, currency?: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoiceitem?: string, metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string})[], issuer?: array{account?: string, type: string}, on_behalf_of?: null|string, preview_mode?: string, schedule?: string, schedule_details?: array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|\Stripe\StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], billing_behavior?: string, end_behavior?: string, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: null|array{bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, iterations?: int}[], proration_behavior?: string}, subscription?: string, subscription_billing_cycle_anchor?: int|array, subscription_cancel_at?: null|int, subscription_cancel_at_period_end?: bool, subscription_cancel_now?: bool, subscription_default_tax_rates?: null|string[], subscription_details?: array{billing_cycle_anchor?: int|array, cancel_at?: null|int, cancel_at_period_end?: bool, cancel_now?: bool, default_tax_rates?: null|string[], items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|\Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], prebilling?: array{iterations: int}, proration_behavior?: string, proration_date?: int, resume_at?: string, start_date?: int, trial_end?: int|array}, subscription_items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|\Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], subscription_prebilling?: array{iterations: int}, subscription_proration_behavior?: string, subscription_proration_date?: int, subscription_resume_at?: string, subscription_start_date?: int, subscription_trial_end?: int|array, subscription_trial_from_plan?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -408,7 +408,7 @@ public function upcoming($params = null, $opts = null) * items. There is also a URL where you can retrieve the full (paginated) list of * line items. * - * @param null|array{automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, coupon?: string, currency?: string, customer?: string, customer_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, tax?: array{ip_address?: null|string}, tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], ending_before?: string, expand?: string[], invoice_items?: (array{amount?: int, currency?: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoiceitem?: string, metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string})[], issuer?: array{account?: string, type: string}, limit?: int, on_behalf_of?: null|string, preview_mode?: string, schedule?: string, schedule_details?: array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], billing_behavior?: string, end_behavior?: string, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: null|array{bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, iterations?: int}[], proration_behavior?: string}, starting_after?: string, subscription?: string, subscription_billing_cycle_anchor?: int|array, subscription_cancel_at?: null|int, subscription_cancel_at_period_end?: bool, subscription_cancel_now?: bool, subscription_default_tax_rates?: null|string[], subscription_details?: array{billing_cycle_anchor?: int|array, cancel_at?: null|int, cancel_at_period_end?: bool, cancel_now?: bool, default_tax_rates?: null|string[], items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], prebilling?: array{iterations: int}, proration_behavior?: string, proration_date?: int, resume_at?: string, start_date?: int, trial_end?: int|array}, subscription_items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], subscription_prebilling?: array{iterations: int}, subscription_proration_behavior?: string, subscription_proration_date?: int, subscription_resume_at?: string, subscription_start_date?: int, subscription_trial_end?: int|array, subscription_trial_from_plan?: bool} $params + * @param null|array{automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, coupon?: string, currency?: string, customer?: string, customer_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: string}, tax?: array{ip_address?: null|string}, tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], ending_before?: string, expand?: string[], invoice_items?: (array{amount?: int, currency?: string, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], invoiceitem?: string, metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_behavior?: string, tax_code?: null|string, tax_rates?: null|string[], unit_amount?: int, unit_amount_decimal?: string})[], issuer?: array{account?: string, type: string}, limit?: int, on_behalf_of?: null|string, preview_mode?: string, schedule?: string, schedule_details?: array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|\Stripe\StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], billing_behavior?: string, end_behavior?: string, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: null|array{bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, iterations?: int}[], proration_behavior?: string}, starting_after?: string, subscription?: string, subscription_billing_cycle_anchor?: int|array, subscription_cancel_at?: null|int, subscription_cancel_at_period_end?: bool, subscription_cancel_now?: bool, subscription_default_tax_rates?: null|string[], subscription_details?: array{billing_cycle_anchor?: int|array, cancel_at?: null|int, cancel_at_period_end?: bool, cancel_now?: bool, default_tax_rates?: null|string[], items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|\Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], prebilling?: array{iterations: int}, proration_behavior?: string, proration_date?: int, resume_at?: string, start_date?: int, trial_end?: int|array}, subscription_items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|\Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], subscription_prebilling?: array{iterations: int}, subscription_proration_behavior?: string, subscription_proration_date?: int, subscription_resume_at?: string, subscription_start_date?: int, subscription_trial_end?: int|array, subscription_trial_from_plan?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -431,7 +431,7 @@ public function upcomingLines($params = null, $opts = null) * invoices, pass auto_advance=false. * * @param string $id - * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, custom_fields?: null|array{name: string, value: string}[], days_until_due?: int, default_margins?: null|string[], default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: null|int, expand?: string[], footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, number?: null|string, on_behalf_of?: null|string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, transfer_data?: null|array{amount?: int, destination: string}} $params + * @param null|array{account_tax_ids?: null|string[], amounts_due?: null|array{amount: int, days_until_due?: int, description: string, due_date?: int}[], application_fee_amount?: int, auto_advance?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, automatically_finalizes_at?: int, collection_method?: string, custom_fields?: null|array{name: string, value: string}[], days_until_due?: int, default_margins?: null|string[], default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], due_date?: int, effective_at?: null|int, expand?: string[], footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, number?: null|string, on_behalf_of?: null|string, payment_settings?: array{default_mandate?: null|string, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[]}, rendering?: array{amount_tax_display?: null|string, pdf?: array{page_size?: string}, template?: string, template_version?: null|int}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, statement_descriptor?: string, transfer_data?: null|array{amount?: int, destination: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -453,7 +453,7 @@ public function update($id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]} $params + * @param null|array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], margins?: null|string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -470,7 +470,7 @@ public function updateLine($parentId, $id, $params = null, $opts = null) * is still a draft. * * @param string $id - * @param null|array{expand?: string[], invoice_metadata?: null|StripeObject, lines: (array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id: string, margins?: null|string[], metadata?: null|StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]})[]} $params + * @param null|array{expand?: string[], invoice_metadata?: null|\Stripe\StripeObject, lines: (array{amount?: int, description?: string, discountable?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id: string, margins?: null|string[], metadata?: null|\Stripe\StripeObject, period?: array{end: int, start: int}, price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_amounts?: null|array{amount: int, tax_rate_data: array{country?: string, description?: string, display_name: string, inclusive: bool, jurisdiction?: string, percentage: float, state?: string, tax_type?: string}, taxable_amount: int}[], tax_rates?: null|string[]})[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Issuing/AuthorizationService.php b/lib/Service/Issuing/AuthorizationService.php index d034eafbe..1d8a2fce8 100644 --- a/lib/Service/Issuing/AuthorizationService.php +++ b/lib/Service/Issuing/AuthorizationService.php @@ -38,7 +38,7 @@ public function all($params = null, $opts = null) * @deprecated this method is deprecated, please refer to the description for details * * @param string $id - * @param null|array{amount?: int, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{amount?: int, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -61,7 +61,7 @@ public function approve($id, $params = null, $opts = null) * @deprecated this method is deprecated, please refer to the description for details * * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -95,7 +95,7 @@ public function retrieve($id, $params = null, $opts = null) * unchanged. * * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Issuing/CardService.php b/lib/Service/Issuing/CardService.php index a48a384de..c4bb24612 100644 --- a/lib/Service/Issuing/CardService.php +++ b/lib/Service/Issuing/CardService.php @@ -63,7 +63,7 @@ public function retrieve($id, $params = null, $opts = null) * the parameters passed. Any parameters not provided will be left unchanged. * * @param string $id - * @param null|array{cancellation_reason?: string, expand?: string[], metadata?: null|StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string} $params + * @param null|array{cancellation_reason?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Issuing/DisputeService.php b/lib/Service/Issuing/DisputeService.php index 86e0878dd..2f4d544e9 100644 --- a/lib/Service/Issuing/DisputeService.php +++ b/lib/Service/Issuing/DisputeService.php @@ -70,7 +70,7 @@ public function retrieve($id, $params = null, $opts = null) * reasons and evidence. * * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -89,7 +89,7 @@ public function submit($id, $params = null, $opts = null) * empty string. * * @param string $id - * @param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Issuing/TransactionService.php b/lib/Service/Issuing/TransactionService.php index 42fdc5d7a..be49ffc5f 100644 --- a/lib/Service/Issuing/TransactionService.php +++ b/lib/Service/Issuing/TransactionService.php @@ -49,7 +49,7 @@ public function retrieve($id, $params = null, $opts = null) * unchanged. * * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/OrderService.php b/lib/Service/OrderService.php index abd29810e..988c95e95 100644 --- a/lib/Service/OrderService.php +++ b/lib/Service/OrderService.php @@ -63,7 +63,7 @@ public function cancel($id, $params = null, $opts = null) /** * Creates a new open order object. * - * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency: string, customer?: string, description?: string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: \Stripe\StripeObject, payment?: array{settings: array{application_fee_amount?: int, payment_method_options?: array{acss_debit?: array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: array{setup_future_usage?: null|string}, bancontact?: array{preferred_language?: string, setup_future_usage?: null|string}, card?: array{capture_method?: string, setup_future_usage?: string}, customer_balance?: array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: array{setup_future_usage?: null|string}, klarna?: array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: array{expires_after_days?: int, setup_future_usage?: string}, p24?: array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params + * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency: string, customer?: string, description?: string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|\Stripe\StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: \Stripe\StripeObject, payment?: array{settings: array{application_fee_amount?: int, payment_method_options?: array{acss_debit?: array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: array{setup_future_usage?: null|string}, bancontact?: array{preferred_language?: string, setup_future_usage?: null|string}, card?: array{capture_method?: string, setup_future_usage?: string}, customer_balance?: array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: array{setup_future_usage?: null|string}, klarna?: array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: array{expires_after_days?: int, setup_future_usage?: string}, p24?: array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -134,7 +134,7 @@ public function submit($id, $params = null, $opts = null) * parameters not provided will be left unchanged. * * @param string $id - * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency?: string, customer?: string, description?: null|string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items?: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], id?: string, price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|StripeObject, payment?: array{settings: array{application_fee_amount?: null|int, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: null|array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, card?: null|array{capture_method?: string, setup_future_usage?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: null|string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: null|array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params + * @param null|array{automatic_tax?: array{enabled: bool}, billing_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, credits?: null|array{gift_card?: string, type: string}[], currency?: string, customer?: string, description?: null|string, discounts?: null|array{coupon?: string, discount?: string, promotion_code?: string}[], expand?: string[], ip_address?: string, line_items?: (array{description?: string, discounts?: null|array{coupon?: string, discount?: string}[], id?: string, price?: string, price_data?: array{currency?: string, product?: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, product?: string, product_data?: array{description?: null|string, id: string, images?: null|string[], metadata?: null|\Stripe\StripeObject, name: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, tax_code?: null|string, url?: null|string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|\Stripe\StripeObject, payment?: array{settings: array{application_fee_amount?: null|int, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, afterpay_clearpay?: null|array{capture_method?: string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, card?: null|array{capture_method?: string, setup_future_usage?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], return_url?: null|string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: null|array{amount?: int, destination: string}}}, shipping_cost?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}, shipping_details?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}, tax_details?: array{tax_exempt?: null|string, tax_ids?: array{type: string, value: string}[]}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/PaymentIntentService.php b/lib/Service/PaymentIntentService.php index 23115abf9..27ee6b8d3 100644 --- a/lib/Service/PaymentIntentService.php +++ b/lib/Service/PaymentIntentService.php @@ -81,7 +81,7 @@ public function cancel($id, $params = null, $opts = null) * and capture. * * @param string $id - * @param null|array{amount_to_capture?: int, application_fee_amount?: int, async_workflows?: array{inputs?: array{tax?: array{calculation: null|string}}}, expand?: string[], final_capture?: bool, metadata?: null|StripeObject, payment_details?: null|array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int}} $params + * @param null|array{amount_to_capture?: int, application_fee_amount?: int, async_workflows?: array{inputs?: array{tax?: array{calculation: null|string}}}, expand?: string[], final_capture?: bool, metadata?: null|\Stripe\StripeObject, payment_details?: null|array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -301,7 +301,7 @@ public function triggerAction($id, $params = null, $opts = null) * href="/docs/api/payment_intents/confirm">confirm API instead. * * @param string $id - * @param null|array{amount?: int, application_fee_amount?: null|int, async_workflows?: array{inputs?: array{tax?: array{calculation: null|string}}}, capture_method?: string, currency?: string, customer?: string, description?: string, expand?: string[], mandate_data?: array{customer_acceptance: array{online: array{ip_address?: string, user_agent?: string}, type: string}}, metadata?: null|StripeObject, payment_details?: null|array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, affirm?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, afterpay_clearpay?: null|array{capture_method?: null|string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, alma?: null|array{capture_method?: null|string}, amazon_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, au_becs_debit?: null|array{setup_future_usage?: null|string}, bacs_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, blik?: null|array{code?: string, setup_future_usage?: null|string}, boleto?: null|array{expires_after_days?: int, setup_future_usage?: null|string}, card?: null|array{capture_method?: null|string, cvc_token?: string, installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, mandate_options?: array{amount: int, amount_type: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_partial_authorization?: string, request_three_d_secure?: string, require_cvc_recollection?: bool, setup_future_usage?: null|string, statement_descriptor_suffix_kana?: null|string, statement_descriptor_suffix_kanji?: null|string, statement_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, phone?: string}, three_d_secure?: array{ares_trans_status?: string, cryptogram: string, electronic_commerce_indicator?: string, exemption_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id: string, version: string}}, card_present?: null|array{request_extended_authorization?: bool, request_incremental_authorization_support?: bool, routing?: array{requested_priority?: string}}, cashapp?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, eps?: null|array{setup_future_usage?: string}, fpx?: null|array{setup_future_usage?: string}, giropay?: null|array{setup_future_usage?: string}, gopay?: null|array{setup_future_usage?: string}, grabpay?: null|array{setup_future_usage?: string}, id_bank_transfer?: null|array{expires_after?: int, expires_at?: int, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, interac_present?: null|array{}, kakao_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, konbini?: null|array{confirmation_number?: null|string, expires_after_days?: null|int, expires_at?: null|int, product_description?: null|string, setup_future_usage?: string}, kr_card?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, mb_way?: null|array{setup_future_usage?: string}, mobilepay?: null|array{capture_method?: null|string, setup_future_usage?: string}, multibanco?: null|array{setup_future_usage?: string}, naver_pay?: null|array{capture_method?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, payco?: null|array{capture_method?: null|string}, paynow?: null|array{setup_future_usage?: string}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, payto?: null|array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string}, setup_future_usage?: null|string}, pix?: null|array{expires_after_seconds?: int, expires_at?: int, setup_future_usage?: string}, promptpay?: null|array{setup_future_usage?: string}, qris?: null|array{setup_future_usage?: string}, rechnung?: null|array{}, revolut_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, samsung_pay?: null|array{capture_method?: null|string}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, shopeepay?: null|array{setup_future_usage?: string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, swish?: null|array{reference?: null|string, setup_future_usage?: string}, twint?: null|array{setup_future_usage?: string}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, preferred_settlement_speed?: null|string, setup_future_usage?: null|string, verification_method?: string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}, zip?: null|array{setup_future_usage?: string}}, payment_method_types?: string[], receipt_email?: null|string, setup_future_usage?: null|string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int}, transfer_group?: string} $params + * @param null|array{amount?: int, application_fee_amount?: null|int, async_workflows?: array{inputs?: array{tax?: array{calculation: null|string}}}, capture_method?: string, currency?: string, customer?: string, description?: string, expand?: string[], mandate_data?: array{customer_acceptance: array{online: array{ip_address?: string, user_agent?: string}, type: string}}, metadata?: null|\Stripe\StripeObject, payment_details?: null|array{car_rental?: array{affiliate?: array{name: string}, booking_number: string, car_class_code?: string, car_make?: string, car_model?: string, company?: string, customer_service_phone_number?: string, days_rented: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, drivers?: array{name: string}[], extra_charges?: string[], no_show?: bool, pickup_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, pickup_at: int, rate_amount?: int, rate_interval?: string, renter_name?: string, return_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, return_at: int, tax_exempt?: bool}, event_details?: array{access_controlled_venue?: bool, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, affiliate?: array{name: string}, company?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, ends_at?: int, genre?: string, name: string, starts_at?: int}, flight?: array{affiliate?: array{name: string}, agency_number?: string, carrier?: string, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, passenger_name?: string, passengers?: array{name: string}[], segments: array{amount?: int, arrival_airport?: string, arrives_at?: int, carrier?: string, departs_at: int, departure_airport?: string, flight_number?: string, service_class?: string}[], ticket_number?: string}, lodging?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, adults?: int, affiliate?: array{name: string}, booking_number?: string, category?: string, checkin_at: int, checkout_at: int, customer_service_phone_number?: string, daily_room_rate_amount?: int, delivery?: array{mode?: string, recipient?: array{email?: string, name?: string, phone?: string}}, extra_charges?: string[], fire_safety_act_compliance?: bool, name?: string, no_show?: bool, number_of_rooms?: int, passengers?: array{name: string}[], property_phone_number?: string, room_class?: string, room_nights?: int, total_room_tax_amount?: int, total_tax_amount?: int}, subscription?: array{affiliate?: array{name: string}, auto_renewal?: bool, billing_interval?: array{count: int, interval: string}, ends_at?: int, name: string, starts_at?: int}}, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{custom_mandate_url?: null|string, interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: null|string, verification_method?: string}, affirm?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, afterpay_clearpay?: null|array{capture_method?: null|string, reference?: string, setup_future_usage?: string}, alipay?: null|array{setup_future_usage?: null|string}, alma?: null|array{capture_method?: null|string}, amazon_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, au_becs_debit?: null|array{setup_future_usage?: null|string}, bacs_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, bancontact?: null|array{preferred_language?: string, setup_future_usage?: null|string}, blik?: null|array{code?: string, setup_future_usage?: null|string}, boleto?: null|array{expires_after_days?: int, setup_future_usage?: null|string}, card?: null|array{capture_method?: null|string, cvc_token?: string, installments?: array{enabled?: bool, plan?: null|array{count?: int, interval?: string, type: string}}, mandate_options?: array{amount: int, amount_type: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_decremental_authorization?: string, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_partial_authorization?: string, request_three_d_secure?: string, require_cvc_recollection?: bool, setup_future_usage?: null|string, statement_descriptor_suffix_kana?: null|string, statement_descriptor_suffix_kanji?: null|string, statement_details?: null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, phone?: string}, three_d_secure?: array{ares_trans_status?: string, cryptogram: string, electronic_commerce_indicator?: string, exemption_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id: string, version: string}}, card_present?: null|array{request_extended_authorization?: bool, request_incremental_authorization_support?: bool, routing?: array{requested_priority?: string}}, cashapp?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, eps?: null|array{setup_future_usage?: string}, fpx?: null|array{setup_future_usage?: string}, giropay?: null|array{setup_future_usage?: string}, gopay?: null|array{setup_future_usage?: string}, grabpay?: null|array{setup_future_usage?: string}, id_bank_transfer?: null|array{expires_after?: int, expires_at?: int, setup_future_usage?: string}, ideal?: null|array{setup_future_usage?: null|string}, interac_present?: null|array{}, kakao_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, klarna?: null|array{capture_method?: null|string, preferred_locale?: string, setup_future_usage?: string}, konbini?: null|array{confirmation_number?: null|string, expires_after_days?: null|int, expires_at?: null|int, product_description?: null|string, setup_future_usage?: string}, kr_card?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, link?: null|array{capture_method?: null|string, persistent_token?: string, setup_future_usage?: null|string}, mb_way?: null|array{setup_future_usage?: string}, mobilepay?: null|array{capture_method?: null|string, setup_future_usage?: string}, multibanco?: null|array{setup_future_usage?: string}, naver_pay?: null|array{capture_method?: null|string}, oxxo?: null|array{expires_after_days?: int, setup_future_usage?: string}, p24?: null|array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, payco?: null|array{capture_method?: null|string}, paynow?: null|array{setup_future_usage?: string}, paypal?: null|array{capture_method?: null|string, line_items?: array{category?: string, description?: string, name: string, quantity: int, sku?: string, sold_by?: string, tax?: array{amount: int, behavior: string}, unit_amount: int}[], preferred_locale?: string, reference?: string, reference_id?: string, risk_correlation_id?: string, setup_future_usage?: null|string, subsellers?: string[]}, payto?: null|array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string}, setup_future_usage?: null|string}, pix?: null|array{expires_after_seconds?: int, expires_at?: int, setup_future_usage?: string}, promptpay?: null|array{setup_future_usage?: string}, qris?: null|array{setup_future_usage?: string}, rechnung?: null|array{}, revolut_pay?: null|array{capture_method?: null|string, setup_future_usage?: null|string}, samsung_pay?: null|array{capture_method?: null|string}, sepa_debit?: null|array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: null|string}, shopeepay?: null|array{setup_future_usage?: string}, sofort?: null|array{preferred_language?: null|string, setup_future_usage?: null|string}, swish?: null|array{reference?: null|string, setup_future_usage?: string}, twint?: null|array{setup_future_usage?: string}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, preferred_settlement_speed?: null|string, setup_future_usage?: null|string, verification_method?: string}, wechat_pay?: null|array{app_id?: string, client: string, setup_future_usage?: string}, zip?: null|array{setup_future_usage?: string}}, payment_method_types?: string[], receipt_email?: null|string, setup_future_usage?: null|string, shipping?: null|array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int}, transfer_group?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/PaymentLinkService.php b/lib/Service/PaymentLinkService.php index 4e7236f35..fc85953be 100644 --- a/lib/Service/PaymentLinkService.php +++ b/lib/Service/PaymentLinkService.php @@ -47,7 +47,7 @@ public function allLineItems($id, $params = null, $opts = null) /** * Creates a payment link. * - * @param null|array{after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, application_fee_amount?: int, application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, consent_collection?: array{payment_method_reuse_agreement?: array{position: string}, promotions?: string, terms_of_service?: string}, currency?: string, custom_fields?: array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, price: string, quantity: int}[], metadata?: \Stripe\StripeObject, on_behalf_of?: string, payment_intent_data?: array{capture_method?: string, description?: string, metadata?: \Stripe\StripeObject, setup_future_usage?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_group?: string}, payment_method_collection?: string, payment_method_types?: string[], phone_number_collection?: array{enabled: bool}, restrictions?: array{completed_sessions: array{limit: int}}, shipping_address_collection?: array{allowed_countries: string[]}, shipping_options?: array{shipping_rate?: string}[], submit_type?: string, subscription_data?: array{description?: string, invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: \Stripe\StripeObject, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}, transfer_data?: array{amount?: int, destination: string}} $params + * @param null|array{after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, application_fee_amount?: int, application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, consent_collection?: array{payment_method_reuse_agreement?: array{position: string}, promotions?: string, terms_of_service?: string}, currency?: string, custom_fields?: array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, price: string, quantity: int}[], metadata?: \Stripe\StripeObject, on_behalf_of?: string, payment_intent_data?: array{capture_method?: string, description?: string, metadata?: \Stripe\StripeObject, setup_future_usage?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_group?: string}, payment_method_collection?: string, payment_method_types?: string[], phone_number_collection?: array{enabled: bool}, restrictions?: array{completed_sessions: array{limit: int}}, shipping_address_collection?: array{allowed_countries: string[]}, shipping_options?: array{shipping_rate?: string}[], submit_type?: string, subscription_data?: array{description?: string, invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: \Stripe\StripeObject, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}, transfer_data?: array{amount?: int, destination: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -79,7 +79,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates a payment link. * * @param string $id - * @param null|array{active?: bool, after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, custom_fields?: null|array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: null|string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id: string, quantity?: int}[], metadata?: \Stripe\StripeObject, payment_intent_data?: array{description?: null|string, metadata?: null|StripeObject, statement_descriptor?: null|string, statement_descriptor_suffix?: null|string, transfer_group?: null|string}, payment_method_collection?: string, payment_method_types?: null|string[], restrictions?: null|array{completed_sessions: array{limit: int}}, shipping_address_collection?: null|array{allowed_countries: string[]}, submit_type?: string, subscription_data?: array{invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: null|StripeObject, trial_period_days?: null|int, trial_settings?: null|array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}} $params + * @param null|array{active?: bool, after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{url: string}, type: string}, allow_promotion_codes?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, custom_fields?: null|array{dropdown?: array{options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer_creation?: string, expand?: string[], inactive_message?: null|string, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: null|\Stripe\StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, id: string, quantity?: int}[], metadata?: \Stripe\StripeObject, payment_intent_data?: array{description?: null|string, metadata?: null|\Stripe\StripeObject, statement_descriptor?: null|string, statement_descriptor_suffix?: null|string, transfer_group?: null|string}, payment_method_collection?: string, payment_method_types?: null|string[], restrictions?: null|array{completed_sessions: array{limit: int}}, shipping_address_collection?: null|array{allowed_countries: string[]}, submit_type?: string, subscription_data?: array{invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: null|\Stripe\StripeObject, trial_period_days?: null|int, trial_settings?: null|array{end_behavior: array{missing_payment_method: string}}}, tax_id_collection?: array{enabled: bool, required?: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/PaymentMethodService.php b/lib/Service/PaymentMethodService.php index d66025295..1af91cd79 100644 --- a/lib/Service/PaymentMethodService.php +++ b/lib/Service/PaymentMethodService.php @@ -125,7 +125,7 @@ public function retrieve($id, $params = null, $opts = null) * be updated. * * @param string $id - * @param null|array{allow_redisplay?: string, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, card?: array{exp_month?: int, exp_year?: int, networks?: array{preferred?: null|string}}, expand?: string[], link?: array{}, metadata?: null|StripeObject, naver_pay?: array{funding?: string}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, us_bank_account?: array{account_holder_type?: string, account_type?: string}} $params + * @param null|array{allow_redisplay?: string, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, card?: array{exp_month?: int, exp_year?: int, networks?: array{preferred?: null|string}}, expand?: string[], link?: array{}, metadata?: null|\Stripe\StripeObject, naver_pay?: array{funding?: string}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, us_bank_account?: array{account_holder_type?: string, account_type?: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/PayoutService.php b/lib/Service/PayoutService.php index a9ae05d5d..e4a2e4121 100644 --- a/lib/Service/PayoutService.php +++ b/lib/Service/PayoutService.php @@ -117,7 +117,7 @@ public function reverse($id, $params = null, $opts = null) * metadata as arguments. * * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/PlanService.php b/lib/Service/PlanService.php index c51a1414a..d5ae80af6 100644 --- a/lib/Service/PlanService.php +++ b/lib/Service/PlanService.php @@ -30,7 +30,7 @@ public function all($params = null, $opts = null) * API. It replaces the Plans API and is backwards compatible to simplify your * migration. * - * @param null|array{active?: bool, aggregate_usage?: string, amount?: int, amount_decimal?: string, billing_scheme?: string, currency: string, expand?: string[], id?: string, interval: string, interval_count?: int, metadata?: null|StripeObject, meter?: string, nickname?: string, product?: string|array, tiers?: (array{flat_amount?: int, flat_amount_decimal?: string, unit_amount?: int, unit_amount_decimal?: string, up_to: int|array})[], tiers_mode?: string, transform_usage?: array{divide_by: int, round: string}, trial_period_days?: int, usage_type?: string} $params + * @param null|array{active?: bool, aggregate_usage?: string, amount?: int, amount_decimal?: string, billing_scheme?: string, currency: string, expand?: string[], id?: string, interval: string, interval_count?: int, metadata?: null|\Stripe\StripeObject, meter?: string, nickname?: string, product?: string|array, tiers?: (array{flat_amount?: int, flat_amount_decimal?: string, unit_amount?: int, unit_amount_decimal?: string, up_to: int|array})[], tiers_mode?: string, transform_usage?: array{divide_by: int, round: string}, trial_period_days?: int, usage_type?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -47,7 +47,7 @@ public function create($params = null, $opts = null) * affected. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -81,7 +81,7 @@ public function retrieve($id, $params = null, $opts = null) * plan’s ID, amount, currency, or billing cycle. * * @param string $id - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject, nickname?: string, product?: string, trial_period_days?: int} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, nickname?: string, product?: string, trial_period_days?: int} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/PriceService.php b/lib/Service/PriceService.php index 686de6c12..2c82e8151 100644 --- a/lib/Service/PriceService.php +++ b/lib/Service/PriceService.php @@ -84,7 +84,7 @@ public function search($params = null, $opts = null) * parameters not provided are left unchanged. * * @param string $id - * @param null|array{active?: bool, currency_options?: null|StripeObject, expand?: string[], lookup_key?: string, metadata?: null|StripeObject, migrate_to?: null|array{behavior: string, effective_after?: int, price: string}, nickname?: string, tax_behavior?: string, transfer_lookup_key?: bool} $params + * @param null|array{active?: bool, currency_options?: null|\Stripe\StripeObject, expand?: string[], lookup_key?: string, metadata?: null|\Stripe\StripeObject, migrate_to?: null|array{behavior: string, effective_after?: int, price: string}, nickname?: string, tax_behavior?: string, transfer_lookup_key?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/ProductService.php b/lib/Service/ProductService.php index 830bb4bc6..b02eb4bd5 100644 --- a/lib/Service/ProductService.php +++ b/lib/Service/ProductService.php @@ -79,7 +79,7 @@ public function createFeature($parentId, $params = null, $opts = null) * is only possible if it has no SKUs associated with it. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -96,7 +96,7 @@ public function delete($id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -168,7 +168,7 @@ public function search($params = null, $opts = null) * parameters not provided will be left unchanged. * * @param string $id - * @param null|array{active?: bool, default_price?: string, description?: null|string, expand?: string[], images?: null|string[], marketing_features?: null|array{name: string}[], metadata?: null|StripeObject, name?: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, statement_descriptor?: string, tax_code?: null|string, unit_label?: null|string, url?: null|string} $params + * @param null|array{active?: bool, default_price?: string, description?: null|string, expand?: string[], images?: null|string[], marketing_features?: null|array{name: string}[], metadata?: null|\Stripe\StripeObject, name?: string, package_dimensions?: null|array{height: float, length: float, weight: float, width: float}, shippable?: bool, statement_descriptor?: string, tax_code?: null|string, unit_label?: null|string, url?: null|string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/PromotionCodeService.php b/lib/Service/PromotionCodeService.php index 1f4346a6b..0651055bb 100644 --- a/lib/Service/PromotionCodeService.php +++ b/lib/Service/PromotionCodeService.php @@ -65,7 +65,7 @@ public function retrieve($id, $params = null, $opts = null) * passed. Most fields are, by design, not editable. * * @param string $id - * @param null|array{active?: bool, expand?: string[], metadata?: null|StripeObject, restrictions?: array{currency_options?: \Stripe\StripeObject}} $params + * @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, restrictions?: array{currency_options?: \Stripe\StripeObject}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/QuoteService.php b/lib/Service/QuoteService.php index 3b4aaedba..121717e7f 100644 --- a/lib/Service/QuoteService.php +++ b/lib/Service/QuoteService.php @@ -167,7 +167,7 @@ public function cancel($id, $params = null, $opts = null) * expires_at can be set in the dashboard via the quote template. * - * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, from_quote?: array{is_revision?: bool, quote: string}, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: string, effective_date?: null|int|array, end_behavior?: string, from_subscription?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: string, end_behavior?: string, proration_behavior?: string}[], test_clock?: string, transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params + * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, from_quote?: array{is_revision?: bool, quote: string}, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|\Stripe\StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: string, effective_date?: null|int|array, end_behavior?: string, from_subscription?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: string, end_behavior?: string, proration_behavior?: string}[], test_clock?: string, transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -286,7 +286,7 @@ public function retrieve($id, $params = null, $opts = null) * A quote models prices and services for a customer. * * @param string $id - * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, id?: string, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: null|string, effective_date?: null|int|array, end_behavior?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: null|(array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: null|string, end_behavior?: string, proration_behavior?: string})[], transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params + * @param null|array{allow_backdated_lines?: bool, application_fee_amount?: null|int, application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, collection_method?: string, customer?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], expires_at?: int, footer?: null|string, header?: null|string, invoice_settings?: array{days_until_due?: int, issuer?: array{account?: string, type: string}}, line_items?: (array{discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, price?: string, price_data?: array{currency: string, product: string, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], lines?: (array{actions?: (array{add_discount?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, add_item?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, add_metadata?: \Stripe\StripeObject, remove_discount?: array{coupon?: string, discount?: string, promotion_code?: string}, remove_item?: array{price: string}, remove_metadata?: string[], set_discounts?: array{coupon?: string, discount?: string, promotion_code?: string}[], set_items?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}[], set_metadata?: null|\Stripe\StripeObject, type: string})[], applies_to?: array{new_reference?: string, subscription_schedule?: string, type: string}, billing_cycle_anchor?: string, cancel_subscription_schedule?: array{cancel_at: string, invoice_now?: bool, prorate?: bool}, ends_at?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, id?: string, proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, starts_at?: array{discount_end?: array{discount: string}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], metadata?: \Stripe\StripeObject, on_behalf_of?: null|string, subscription_data?: array{bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, billing_cycle_anchor?: null|string, description?: null|string, effective_date?: null|int|array, end_behavior?: string, metadata?: \Stripe\StripeObject, prebilling?: null|array{iterations: int}, proration_behavior?: string, trial_period_days?: null|int}, subscription_data_overrides?: null|(array{applies_to: array{new_reference?: string, subscription_schedule?: string, type: string}, bill_on_acceptance?: null|array{bill_from?: array{line_starts_at?: array{id?: string, index?: int}, timestamp?: int, type: string}, bill_until?: array{duration?: array{interval: string, interval_count: int}, line_ends_at?: array{id?: string, index?: int}, timestamp?: int, type: string}}, billing_behavior?: string, customer?: string, description?: null|string, end_behavior?: string, proration_behavior?: string})[], transfer_data?: null|array{amount?: int, amount_percent?: float, destination: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Radar/ValueListItemService.php b/lib/Service/Radar/ValueListItemService.php index ad922b025..02e47ab19 100644 --- a/lib/Service/Radar/ValueListItemService.php +++ b/lib/Service/Radar/ValueListItemService.php @@ -48,7 +48,7 @@ public function create($params = null, $opts = null) * list. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Radar/ValueListService.php b/lib/Service/Radar/ValueListService.php index 71ac8a911..1f7ae76c1 100644 --- a/lib/Service/Radar/ValueListService.php +++ b/lib/Service/Radar/ValueListService.php @@ -49,7 +49,7 @@ public function create($params = null, $opts = null) * rules. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/RefundService.php b/lib/Service/RefundService.php index df9415a9e..9263616aa 100644 --- a/lib/Service/RefundService.php +++ b/lib/Service/RefundService.php @@ -61,7 +61,7 @@ public function cancel($id, $params = null, $opts = null) * an error when called on an already-refunded charge, or when trying to refund * more money than is left on a charge. * - * @param null|array{amount?: int, charge?: string, currency?: string, customer?: string, expand?: string[], instructions_email?: string, metadata?: null|StripeObject, origin?: string, payment_intent?: string, reason?: string, refund_application_fee?: bool, reverse_transfer?: bool} $params + * @param null|array{amount?: int, charge?: string, currency?: string, customer?: string, expand?: string[], instructions_email?: string, metadata?: null|\Stripe\StripeObject, origin?: string, payment_intent?: string, reason?: string, refund_application_fee?: bool, reverse_transfer?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -96,7 +96,7 @@ public function retrieve($id, $params = null, $opts = null) * This request only accepts metadata as an argument. * * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/SetupIntentService.php b/lib/Service/SetupIntentService.php index 24c6f8afd..5dedd1e85 100644 --- a/lib/Service/SetupIntentService.php +++ b/lib/Service/SetupIntentService.php @@ -120,7 +120,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates a SetupIntent object. * * @param string $id - * @param null|array{attach_to_self?: bool, customer?: string, description?: string, expand?: string[], flow_directions?: string[], metadata?: null|StripeObject, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: array{currency?: string, mandate_options?: array{custom_mandate_url?: null|string, default_for?: string[], interval_description?: string, payment_schedule?: string, transaction_type?: string}, verification_method?: string}, amazon_pay?: array{}, bacs_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, card?: array{mandate_options?: array{amount: int, amount_type: string, currency: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_three_d_secure?: string, three_d_secure?: array{ares_trans_status?: string, cryptogram?: string, electronic_commerce_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id?: string, version?: string}}, card_present?: array{}, link?: array{persistent_token?: string}, paypal?: array{billing_agreement_id?: string, currency?: string, subsellers?: string[]}, payto?: array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string, start_date?: string}}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, us_bank_account?: array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, verification_method?: string}}, payment_method_types?: string[]} $params + * @param null|array{attach_to_self?: bool, customer?: string, description?: string, expand?: string[], flow_directions?: string[], metadata?: null|\Stripe\StripeObject, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: array{currency?: string, mandate_options?: array{custom_mandate_url?: null|string, default_for?: string[], interval_description?: string, payment_schedule?: string, transaction_type?: string}, verification_method?: string}, amazon_pay?: array{}, bacs_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, card?: array{mandate_options?: array{amount: int, amount_type: string, currency: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_three_d_secure?: string, three_d_secure?: array{ares_trans_status?: string, cryptogram?: string, electronic_commerce_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id?: string, version?: string}}, card_present?: array{}, link?: array{persistent_token?: string}, paypal?: array{billing_agreement_id?: string, currency?: string, subsellers?: string[]}, payto?: array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string, start_date?: string}}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, us_bank_account?: array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, verification_method?: string}}, payment_method_types?: string[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/ShippingRateService.php b/lib/Service/ShippingRateService.php index 940a0ce68..812fd9a7a 100644 --- a/lib/Service/ShippingRateService.php +++ b/lib/Service/ShippingRateService.php @@ -60,7 +60,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates an existing shipping rate object. * * @param string $id - * @param null|array{active?: bool, expand?: string[], fixed_amount?: array{currency_options?: \Stripe\StripeObject}, metadata?: null|StripeObject, tax_behavior?: string} $params + * @param null|array{active?: bool, expand?: string[], fixed_amount?: array{currency_options?: \Stripe\StripeObject}, metadata?: null|\Stripe\StripeObject, tax_behavior?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/SourceService.php b/lib/Service/SourceService.php index b60f914a9..c39983034 100644 --- a/lib/Service/SourceService.php +++ b/lib/Service/SourceService.php @@ -86,7 +86,7 @@ public function retrieve($id, $params = null, $opts = null) * guides for more detail. * * @param string $id - * @param null|array{amount?: int, expand?: string[], mandate?: array{acceptance?: array{date?: int, ip?: string, offline?: array{contact_email: string}, online?: array{date?: int, ip?: string, user_agent?: string}, status: string, type?: string, user_agent?: string}, amount?: null|int, currency?: string, interval?: string, notification_method?: string}, metadata?: null|StripeObject, owner?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, source_order?: array{items?: array{amount?: int, currency?: string, description?: string, parent?: string, quantity?: int, type?: string}[], shipping?: array{address: array{city?: string, country?: string, line1: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name?: string, phone?: string, tracking_number?: string}}} $params + * @param null|array{amount?: int, expand?: string[], mandate?: array{acceptance?: array{date?: int, ip?: string, offline?: array{contact_email: string}, online?: array{date?: int, ip?: string, user_agent?: string}, status: string, type?: string, user_agent?: string}, amount?: null|int, currency?: string, interval?: string, notification_method?: string}, metadata?: null|\Stripe\StripeObject, owner?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, source_order?: array{items?: array{amount?: int, currency?: string, description?: string, parent?: string, quantity?: int, type?: string}[], shipping?: array{address: array{city?: string, country?: string, line1: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name?: string, phone?: string, tracking_number?: string}}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/SubscriptionItemService.php b/lib/Service/SubscriptionItemService.php index 92fa26b82..e97f95f7a 100644 --- a/lib/Service/SubscriptionItemService.php +++ b/lib/Service/SubscriptionItemService.php @@ -141,7 +141,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates the plan or quantity of an item on a current subscription. * * @param string $id - * @param null|array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], metadata?: null|StripeObject, off_session?: bool, payment_behavior?: string, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, proration_behavior?: string, proration_date?: int, quantity?: int, tax_rates?: null|string[]} $params + * @param null|array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], metadata?: null|\Stripe\StripeObject, off_session?: bool, payment_behavior?: string, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, proration_behavior?: string, proration_date?: int, quantity?: int, tax_rates?: null|string[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/SubscriptionScheduleService.php b/lib/Service/SubscriptionScheduleService.php index 360f805fc..49c1ca197 100644 --- a/lib/Service/SubscriptionScheduleService.php +++ b/lib/Service/SubscriptionScheduleService.php @@ -29,7 +29,7 @@ public function all($params = null, $opts = null) * Amends an existing subscription schedule. * * @param string $id - * @param null|array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], expand?: string[], prebilling?: null|array{bill_from?: array{amendment_start?: array{index: int}, timestamp?: int, type: string}, bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, invoice_at?: string, update_behavior?: string}[], proration_behavior?: string, schedule_settings?: array{end_behavior?: string}} $params + * @param null|array{amendments?: (array{amendment_end?: array{discount_end?: array{discount: string}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, amendment_start: array{amendment_end?: array{index: int}, discount_end?: array{discount: string}, timestamp?: int, type: string}, billing_cycle_anchor?: string, discount_actions?: array{add?: array{coupon?: string, discount?: string, discount_end?: array{type: string}, index?: int, promotion_code?: string}, remove?: array{coupon?: string, discount?: string, promotion_code?: string}, set?: array{coupon?: string, discount?: string, promotion_code?: string}, type: string}[], item_actions?: array{add?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, remove?: array{price: string}, set?: array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, price: string, quantity?: int, tax_rates?: string[], trial?: array{converts_to?: string[], type: string}}, type: string}[], metadata_actions?: (array{add?: \Stripe\StripeObject, remove?: string[], set?: null|\Stripe\StripeObject, type: string})[], proration_behavior?: string, set_pause_collection?: array{set?: array{behavior: string}, type: string}, set_schedule_end?: string, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], expand?: string[], prebilling?: null|array{bill_from?: array{amendment_start?: array{index: int}, timestamp?: int, type: string}, bill_until?: array{amendment_end?: array{index: int}, duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, invoice_at?: string, update_behavior?: string}[], proration_behavior?: string, schedule_settings?: array{end_behavior?: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -64,7 +64,7 @@ public function cancel($id, $params = null, $opts = null) * Creates a new subscription schedule object. Each customer can have up to 500 * active or scheduled subscriptions. * - * @param null|array{billing_behavior?: string, customer?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], from_subscription?: string, metadata?: null|StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, start_date?: int|array} $params + * @param null|array{billing_behavior?: string, customer?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], from_subscription?: string, metadata?: null|\Stripe\StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, start_date?: int|array} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -119,7 +119,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates an existing subscription schedule. * * @param string $id - * @param null|array{billing_behavior?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], metadata?: null|StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, proration_behavior?: string} $params + * @param null|array{billing_behavior?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, proration_behavior?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/SubscriptionService.php b/lib/Service/SubscriptionService.php index 5818dfeba..2745351be 100644 --- a/lib/Service/SubscriptionService.php +++ b/lib/Service/SubscriptionService.php @@ -72,7 +72,7 @@ public function cancel($id, $params = null, $opts = null) * schedules instead. Schedules provide the flexibility to model more complex * billing configurations that change over time. * - * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, backdate_start_date?: int, billing_cycle_anchor?: int, billing_cycle_anchor_config?: array{day_of_month: int, hour?: int, minute?: int, month?: int, second?: int}, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: int, cancel_at_period_end?: bool, collection_method?: string, coupon?: string, currency?: string, customer: string, days_until_due?: int, default_payment_method?: string, default_source?: string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], metadata?: null|StripeObject, off_session?: bool, on_behalf_of?: null|string, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params + * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, backdate_start_date?: int, billing_cycle_anchor?: int, billing_cycle_anchor_config?: array{day_of_month: int, hour?: int, minute?: int, month?: int, second?: int}, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: int, cancel_at_period_end?: bool, collection_method?: string, coupon?: string, currency?: string, customer: string, days_until_due?: int, default_payment_method?: string, default_source?: string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], metadata?: null|\Stripe\StripeObject, off_session?: bool, on_behalf_of?: null|string, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -88,7 +88,7 @@ public function create($params = null, $opts = null) * Removes the currently applied discount on a subscription. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -209,7 +209,7 @@ public function search($params = null, $opts = null) * href="/docs/billing/subscriptions/usage-based">usage-based billing instead. * * @param string $id - * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: null|int, cancel_at_period_end?: bool, cancellation_details?: array{comment?: null|string, feedback?: null|string}, collection_method?: string, coupon?: string, days_until_due?: int, default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|StripeObject, off_session?: bool, on_behalf_of?: null|string, pause_collection?: null|array{behavior: string, resumes_at?: int}, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, proration_date?: int, transfer_data?: null|array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params + * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: null|int, cancel_at_period_end?: bool, cancellation_details?: array{comment?: null|string, feedback?: null|string}, collection_method?: string, coupon?: string, days_until_due?: int, default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|\Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|\Stripe\StripeObject, off_session?: bool, on_behalf_of?: null|string, pause_collection?: null|array{behavior: string, resumes_at?: int}, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, proration_date?: int, transfer_data?: null|array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/TaxIdService.php b/lib/Service/TaxIdService.php index a0507654b..b16af5a4b 100644 --- a/lib/Service/TaxIdService.php +++ b/lib/Service/TaxIdService.php @@ -44,7 +44,7 @@ public function create($params = null, $opts = null) * Deletes an existing account or customer tax_id object. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/TaxRateService.php b/lib/Service/TaxRateService.php index 09a0dfb99..a9692c519 100644 --- a/lib/Service/TaxRateService.php +++ b/lib/Service/TaxRateService.php @@ -61,7 +61,7 @@ public function retrieve($id, $params = null, $opts = null) * Updates an existing tax rate. * * @param string $id - * @param null|array{active?: bool, country?: string, description?: string, display_name?: string, expand?: string[], jurisdiction?: string, metadata?: null|StripeObject, state?: string, tax_type?: string} $params + * @param null|array{active?: bool, country?: string, description?: string, display_name?: string, expand?: string[], jurisdiction?: string, metadata?: null|\Stripe\StripeObject, state?: string, tax_type?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Terminal/ConfigurationService.php b/lib/Service/Terminal/ConfigurationService.php index 8ad9d7f64..5b700135d 100644 --- a/lib/Service/Terminal/ConfigurationService.php +++ b/lib/Service/Terminal/ConfigurationService.php @@ -44,7 +44,7 @@ public function create($params = null, $opts = null) * Deletes a Configuration object. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Terminal/LocationService.php b/lib/Service/Terminal/LocationService.php index a45b266d5..2ced99e0e 100644 --- a/lib/Service/Terminal/LocationService.php +++ b/lib/Service/Terminal/LocationService.php @@ -30,7 +30,7 @@ public function all($params = null, $opts = null) * address fields are required in each country, see the Manage locations guide. * - * @param null|array{address: array{city?: string, country: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: string, display_name: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{address: array{city?: string, country: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: string, display_name: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -46,7 +46,7 @@ public function create($params = null, $opts = null) * Deletes a Location object. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -79,7 +79,7 @@ public function retrieve($id, $params = null, $opts = null) * passed. Any parameters not provided will be left unchanged. * * @param string $id - * @param null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: null|string, display_name?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: null|string, display_name?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/Terminal/ReaderService.php b/lib/Service/Terminal/ReaderService.php index f0768dda2..2f35984c1 100644 --- a/lib/Service/Terminal/ReaderService.php +++ b/lib/Service/Terminal/ReaderService.php @@ -93,7 +93,7 @@ public function confirmPaymentIntent($id, $params = null, $opts = null) /** * Creates a new Reader object. * - * @param null|array{expand?: string[], label?: string, location?: string, metadata?: null|StripeObject, registration_code: string} $params + * @param null|array{expand?: string[], label?: string, location?: string, metadata?: null|\Stripe\StripeObject, registration_code: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -109,7 +109,7 @@ public function create($params = null, $opts = null) * Deletes a Reader object. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -206,7 +206,7 @@ public function setReaderDisplay($id, $params = null, $opts = null) * passed. Any parameters not provided will be left unchanged. * * @param string $id - * @param null|array{expand?: string[], label?: null|string, metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], label?: null|string, metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/TestHelpers/TestClockService.php b/lib/Service/TestHelpers/TestClockService.php index 56c57953b..27974edee 100644 --- a/lib/Service/TestHelpers/TestClockService.php +++ b/lib/Service/TestHelpers/TestClockService.php @@ -61,7 +61,7 @@ public function create($params = null, $opts = null) * Deletes a test clock. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/TokenService.php b/lib/Service/TokenService.php index 362d42c76..cf051920d 100644 --- a/lib/Service/TokenService.php +++ b/lib/Service/TokenService.php @@ -18,7 +18,7 @@ class TokenService extends \Stripe\Service\AbstractService * href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection * is application, which includes Custom accounts. * - * @param null|array{account?: array{business_type?: string, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, ownership_declaration_shown_and_signed?: bool, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, tos_shown_and_accepted?: bool}, bank_account?: array{account_holder_name?: string, account_holder_type?: string, account_number: string, account_type?: string, country: string, currency?: string, payment_method?: string, routing_number?: string}, card?: string|array, customer?: string, cvc_update?: array{cvc: string}, expand?: string[], person?: array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, nationality?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, pii?: array{id_number?: string}} $params + * @param null|array{account?: array{business_type?: string, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, ownership_declaration_shown_and_signed?: bool, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, tos_shown_and_accepted?: bool}, bank_account?: array{account_holder_name?: string, account_holder_type?: string, account_number: string, account_type?: string, country: string, currency?: string, payment_method?: string, routing_number?: string}, card?: string|array, customer?: string, cvc_update?: array{cvc: string}, expand?: string[], person?: array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, nationality?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, pii?: array{id_number?: string}} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/TopupService.php b/lib/Service/TopupService.php index 9697cd200..ea549109c 100644 --- a/lib/Service/TopupService.php +++ b/lib/Service/TopupService.php @@ -44,7 +44,7 @@ public function cancel($id, $params = null, $opts = null) /** * Top up the balance of an account. * - * @param null|array{amount: int, currency: string, description?: string, expand?: string[], metadata?: null|StripeObject, source?: string, statement_descriptor?: string, transfer_group?: string} $params + * @param null|array{amount: int, currency: string, description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, source?: string, statement_descriptor?: string, transfer_group?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -79,7 +79,7 @@ public function retrieve($id, $params = null, $opts = null) * design. * * @param string $id - * @param null|array{description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/TransferService.php b/lib/Service/TransferService.php index 98ae7dc70..738551efe 100644 --- a/lib/Service/TransferService.php +++ b/lib/Service/TransferService.php @@ -75,7 +75,7 @@ public function create($params = null, $opts = null) * reverse more money than is left on a transfer. * * @param string $parentId - * @param null|array{amount?: int, description?: string, expand?: string[], metadata?: null|StripeObject, refund_application_fee?: bool} $params + * @param null|array{amount?: int, description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, refund_application_fee?: bool} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -131,7 +131,7 @@ public function retrieveReversal($parentId, $id, $params = null, $opts = null) * This request accepts only metadata as an argument. * * @param string $id - * @param null|array{description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -151,7 +151,7 @@ public function update($id, $params = null, $opts = null) * * @param string $parentId * @param string $id - * @param null|array{expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/V2/Billing/MeterEventSessionService.php b/lib/Service/V2/Billing/MeterEventSessionService.php index fcca1c000..d1ca99dab 100644 --- a/lib/Service/V2/Billing/MeterEventSessionService.php +++ b/lib/Service/V2/Billing/MeterEventSessionService.php @@ -15,7 +15,7 @@ class MeterEventSessionService extends \Stripe\Service\AbstractService * stream. Authentication tokens are only valid for 15 minutes, so you will need to * create a new meter event session when your token expires. * - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/V2/Core/EventDestinationService.php b/lib/Service/V2/Core/EventDestinationService.php index 6301f99e3..9be759273 100644 --- a/lib/Service/V2/Core/EventDestinationService.php +++ b/lib/Service/V2/Core/EventDestinationService.php @@ -44,7 +44,7 @@ public function create($params = null, $opts = null) * Delete an event destination. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -60,7 +60,7 @@ public function delete($id, $params = null, $opts = null) * Disable an event destination. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -76,7 +76,7 @@ public function disable($id, $params = null, $opts = null) * Enable an event destination. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -92,7 +92,7 @@ public function enable($id, $params = null, $opts = null) * Send a `ping` event to an event destination. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/V2/Core/EventService.php b/lib/Service/V2/Core/EventService.php index 338633db6..ebc13a9d0 100644 --- a/lib/Service/V2/Core/EventService.php +++ b/lib/Service/V2/Core/EventService.php @@ -29,7 +29,7 @@ public function all($params = null, $opts = null) * Retrieves the details of an event. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Service/WebhookEndpointService.php b/lib/Service/WebhookEndpointService.php index 1358050c9..65239b58c 100644 --- a/lib/Service/WebhookEndpointService.php +++ b/lib/Service/WebhookEndpointService.php @@ -36,7 +36,7 @@ public function all($params = null, $opts = null) * href="https://dashboard.stripe.com/account/webhooks">webhooks settings * section of the Dashboard. * - * @param null|array{api_version?: string, connect?: bool, description?: null|string, enabled_events: string[], expand?: string[], metadata?: null|StripeObject, url: string} $params + * @param null|array{api_version?: string, connect?: bool, description?: null|string, enabled_events: string[], expand?: string[], metadata?: null|\Stripe\StripeObject, url: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -54,7 +54,7 @@ public function create($params = null, $opts = null) * management page of the Stripe dashboard. * * @param string $id - * @param null|array{{}} $params + * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -87,7 +87,7 @@ public function retrieve($id, $params = null, $opts = null) * enabled_events, and the status of your endpoint. * * @param string $id - * @param null|array{description?: null|string, disabled?: bool, enabled_events?: string[], expand?: string[], metadata?: null|StripeObject, url?: string} $params + * @param null|array{description?: null|string, disabled?: bool, enabled_events?: string[], expand?: string[], metadata?: null|\Stripe\StripeObject, url?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/SetupAttempt.php b/lib/SetupAttempt.php index ea208bcf3..15a5101c1 100644 --- a/lib/SetupAttempt.php +++ b/lib/SetupAttempt.php @@ -20,8 +20,8 @@ * @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 null|string|\Stripe\Account $on_behalf_of The value of on_behalf_of on the SetupIntent at the time of this confirmation. * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupAttempt. - * @property object{acss_debit?: object{}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{}&\Stripe\StripeObject&\stdClass, au_becs_debit?: object{}&\Stripe\StripeObject&\stdClass, bacs_debit?: object{}&\Stripe\StripeObject&\stdClass, bancontact?: object{bank_code: null|string, bank_name: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, boleto?: object{}&\Stripe\StripeObject&\stdClass, card?: object{brand: null|string, checks: null|object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass, country: null|string, description?: null|string, exp_month: null|int, exp_year: null|int, fingerprint?: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, network: null|string, three_d_secure: null|object{authentication_flow: null|string, electronic_commerce_indicator: null|string, result: null|string, result_reason: null|string, transaction_id: null|string, version: null|string}&\Stripe\StripeObject&\stdClass, wallet: null|object{apple_pay?: object{}&\Stripe\StripeObject&\stdClass, google_pay?: object{}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, card_present?: object{generated_card: null|string|\Stripe\PaymentMethod, offline: null|object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, cashapp?: object{}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: object{bank: null|string, bank_code: null|string, bank_name: null|string, display_name: null|string}&\Stripe\StripeObject&\stdClass, ideal?: object{bank: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, kakao_pay?: object{}&\Stripe\StripeObject&\stdClass, klarna?: object{}&\Stripe\StripeObject&\stdClass, kr_card?: object{}&\Stripe\StripeObject&\stdClass, link?: object{}&\Stripe\StripeObject&\stdClass, paypal?: object{}&\Stripe\StripeObject&\stdClass, payto?: object{}&\Stripe\StripeObject&\stdClass, revolut_pay?: object{}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{}&\Stripe\StripeObject&\stdClass, sofort?: object{bank_code: null|string, bank_name: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass, type: string, us_bank_account?: object{}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_details - * @property null|object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass $setup_error The error encountered during this attempt to confirm the SetupIntent, if any. + * @property (object{acss_debit?: (object{}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{}&\Stripe\StripeObject&\stdClass), au_becs_debit?: (object{}&\Stripe\StripeObject&\stdClass), bacs_debit?: (object{}&\Stripe\StripeObject&\stdClass), bancontact?: (object{bank_code: null|string, bank_name: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), boleto?: (object{}&\Stripe\StripeObject&\stdClass), card?: (object{brand: null|string, checks: null|(object{address_line1_check: null|string, address_postal_code_check: null|string, cvc_check: null|string}&\Stripe\StripeObject&\stdClass), country: null|string, description?: null|string, exp_month: null|int, exp_year: null|int, fingerprint?: null|string, funding: null|string, iin?: null|string, issuer?: null|string, last4: null|string, network: null|string, three_d_secure: null|(object{authentication_flow: null|string, electronic_commerce_indicator: null|string, result: null|string, result_reason: null|string, transaction_id: null|string, version: null|string}&\Stripe\StripeObject&\stdClass), wallet: null|(object{apple_pay?: (object{}&\Stripe\StripeObject&\stdClass), google_pay?: (object{}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), card_present?: (object{generated_card: null|string|\Stripe\PaymentMethod, offline: null|(object{stored_at: null|int, type: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), cashapp?: (object{}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: (object{bank: null|string, bank_code: null|string, bank_name: null|string, display_name: null|string}&\Stripe\StripeObject&\stdClass), ideal?: (object{bank: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), kakao_pay?: (object{}&\Stripe\StripeObject&\stdClass), klarna?: (object{}&\Stripe\StripeObject&\stdClass), kr_card?: (object{}&\Stripe\StripeObject&\stdClass), link?: (object{}&\Stripe\StripeObject&\stdClass), paypal?: (object{}&\Stripe\StripeObject&\stdClass), payto?: (object{}&\Stripe\StripeObject&\stdClass), revolut_pay?: (object{}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{}&\Stripe\StripeObject&\stdClass), sofort?: (object{bank_code: null|string, bank_name: null|string, bic: null|string, generated_sepa_debit: null|string|\Stripe\PaymentMethod, generated_sepa_debit_mandate: null|string|\Stripe\Mandate, iban_last4: null|string, preferred_language: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass), type: string, us_bank_account?: (object{}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $payment_method_details + * @property null|(object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass) $setup_error The error encountered during this attempt to confirm the SetupIntent, if any. * @property string|\Stripe\SetupIntent $setup_intent ID of the SetupIntent that this attempt belongs to. * @property string $status Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned. * @property string $usage The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session. diff --git a/lib/SetupIntent.php b/lib/SetupIntent.php index ff5c84578..8aa6b758c 100644 --- a/lib/SetupIntent.php +++ b/lib/SetupIntent.php @@ -31,23 +31,23 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property null|string|\Stripe\Application $application ID of the Connect application that created the SetupIntent. * @property null|bool $attach_to_self

If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

- * @property null|object{allow_redirects?: string, enabled: null|bool}&\Stripe\StripeObject&\stdClass $automatic_payment_methods Settings for dynamic payment methods compatible with this Setup Intent + * @property null|(object{allow_redirects?: string, enabled: null|bool}&\Stripe\StripeObject&\stdClass) $automatic_payment_methods Settings for dynamic payment methods compatible with this Setup Intent * @property null|string $cancellation_reason Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate. * @property null|string $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, 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 null|string|\Stripe\Customer $customer

ID of the Customer this SetupIntent belongs to, if one exists.

If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

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

Indicates the directions of money movement for which this payment method is intended to be used.

Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

- * @property null|object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass $last_setup_error The error encountered in the previous SetupIntent confirmation. + * @property null|(object{charge?: string, code?: string, decline_code?: string, doc_url?: string, message?: string, network_advice_code?: string, network_decline_code?: string, param?: string, payment_intent?: \Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, payment_method_type?: string, request_log_url?: string, setup_intent?: \Stripe\SetupIntent, source?: \Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source, type: string}&\Stripe\StripeObject&\stdClass) $last_setup_error The error encountered in the previous SetupIntent confirmation. * @property null|string|\Stripe\SetupAttempt $latest_attempt The most recent SetupAttempt for this SetupIntent. * @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 null|string|\Stripe\Mandate $mandate ID of the multi use Mandate generated by the SetupIntent. - * @property null|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|object{cashapp_handle_redirect_or_display_qr_code?: object{hosted_instructions_url: string, mobile_auth_url: string, qr_code: object{expires_at: int, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, redirect_to_url?: object{return_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass, type: string, use_stripe_sdk?: \Stripe\StripeObject, verify_with_microdeposits?: object{arrival_date: int, hosted_verification_url: string, microdeposit_type: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $next_action If present, this property tells you what actions you need to take in order for your customer to continue payment setup. + * @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|(object{cashapp_handle_redirect_or_display_qr_code?: (object{hosted_instructions_url: string, mobile_auth_url: string, qr_code: (object{expires_at: int, image_url_png: string, image_url_svg: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), redirect_to_url?: (object{return_url: null|string, url: null|string}&\Stripe\StripeObject&\stdClass), type: string, use_stripe_sdk?: \Stripe\StripeObject, verify_with_microdeposits?: (object{arrival_date: int, hosted_verification_url: string, microdeposit_type: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $next_action If present, this property tells you what actions you need to take in order for your customer to continue payment setup. * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the setup is intended. * @property null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead. - * @property null|object{id: string, parent: null|string}&\Stripe\StripeObject&\stdClass $payment_method_configuration_details Information about the payment method configuration used for this Setup Intent. - * @property null|object{acss_debit?: object{currency: null|string, mandate_options?: object{custom_mandate_url?: string, default_for?: string[], interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass, amazon_pay?: object{}&\Stripe\StripeObject&\stdClass, bacs_debit?: object{mandate_options?: object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, card?: object{mandate_options: null|object{amount: int, amount_type: string, currency: string, description: null|string, end_date: null|int, interval: string, interval_count: null|int, reference: string, start_date: int, supported_types: null|string[]}&\Stripe\StripeObject&\stdClass, network: null|string, request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass, card_present?: object{}&\Stripe\StripeObject&\stdClass, link?: object{persistent_token: null|string}&\Stripe\StripeObject&\stdClass, paypal?: object{billing_agreement_id: null|string, currency?: null|string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass, payto?: object{mandate_options?: object{amount: null|int, amount_type: null|string, end_date: null|string, payment_schedule: null|string, payments_per_period: null|int, purpose: null|string, start_date: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, sepa_debit?: object{mandate_options?: object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, us_bank_account?: object{financial_connections?: object{filters?: object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass, manual_entry?: object{mode?: string}&\Stripe\StripeObject&\stdClass, permissions?: string[], prefetch: null|string[], return_url?: string}&\Stripe\StripeObject&\stdClass, mandate_options?: object{collection_method?: string}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $payment_method_options Payment method-specific configuration for this SetupIntent. + * @property null|(object{id: string, parent: null|string}&\Stripe\StripeObject&\stdClass) $payment_method_configuration_details Information about the payment method configuration used for this Setup Intent. + * @property null|(object{acss_debit?: (object{currency: null|string, mandate_options?: (object{custom_mandate_url?: string, default_for?: string[], interval_description: null|string, payment_schedule: null|string, transaction_type: null|string}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass), amazon_pay?: (object{}&\Stripe\StripeObject&\stdClass), bacs_debit?: (object{mandate_options?: (object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), card?: (object{mandate_options: null|(object{amount: int, amount_type: string, currency: string, description: null|string, end_date: null|int, interval: string, interval_count: null|int, reference: string, start_date: int, supported_types: null|string[]}&\Stripe\StripeObject&\stdClass), network: null|string, request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass), card_present?: (object{}&\Stripe\StripeObject&\stdClass), link?: (object{persistent_token: null|string}&\Stripe\StripeObject&\stdClass), paypal?: (object{billing_agreement_id: null|string, currency?: null|string, subsellers?: string[]}&\Stripe\StripeObject&\stdClass), payto?: (object{mandate_options?: (object{amount: null|int, amount_type: null|string, end_date: null|string, payment_schedule: null|string, payments_per_period: null|int, purpose: null|string, start_date: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), sepa_debit?: (object{mandate_options?: (object{reference_prefix?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), us_bank_account?: (object{financial_connections?: (object{filters?: (object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass), manual_entry?: (object{mode?: string}&\Stripe\StripeObject&\stdClass), permissions?: string[], prefetch: null|string[], return_url?: string}&\Stripe\StripeObject&\stdClass), mandate_options?: (object{collection_method?: string}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $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 null|string|\Stripe\Mandate $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. @@ -143,7 +143,7 @@ public static function retrieve($id, $opts = null) * Updates a SetupIntent object. * * @param string $id the ID of the resource to update - * @param null|array{attach_to_self?: bool, customer?: string, description?: string, expand?: string[], flow_directions?: string[], metadata?: null|StripeObject, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: array{currency?: string, mandate_options?: array{custom_mandate_url?: null|string, default_for?: string[], interval_description?: string, payment_schedule?: string, transaction_type?: string}, verification_method?: string}, amazon_pay?: array{}, bacs_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, card?: array{mandate_options?: array{amount: int, amount_type: string, currency: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_three_d_secure?: string, three_d_secure?: array{ares_trans_status?: string, cryptogram?: string, electronic_commerce_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id?: string, version?: string}}, card_present?: array{}, link?: array{persistent_token?: string}, paypal?: array{billing_agreement_id?: string, currency?: string, subsellers?: string[]}, payto?: array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string, start_date?: string}}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, us_bank_account?: array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, verification_method?: string}}, payment_method_types?: string[]} $params + * @param null|array{attach_to_self?: bool, customer?: string, description?: string, expand?: string[], flow_directions?: string[], metadata?: null|\Stripe\StripeObject, payment_method?: string, payment_method_configuration?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, gopay?: array{}, grabpay?: array{}, id_bank_transfer?: array{bank?: string}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, mb_way?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, oxxo?: array{}, p24?: array{bank?: string}, payco?: array{}, paynow?: array{}, paypal?: array{}, payto?: array{account_number?: string, bsb_number?: string, pay_id?: string}, pix?: array{}, promptpay?: array{}, qris?: array{}, radar_options?: array{session?: string}, rechnung?: array{dob: array{day: int, month: int, year: int}}, revolut_pay?: array{}, samsung_pay?: array{}, sepa_debit?: array{iban: string}, shopeepay?: array{}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{acss_debit?: array{currency?: string, mandate_options?: array{custom_mandate_url?: null|string, default_for?: string[], interval_description?: string, payment_schedule?: string, transaction_type?: string}, verification_method?: string}, amazon_pay?: array{}, bacs_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, card?: array{mandate_options?: array{amount: int, amount_type: string, currency: string, description?: string, end_date?: int, interval: string, interval_count?: int, reference: string, start_date: int, supported_types?: string[]}, moto?: bool, network?: string, request_three_d_secure?: string, three_d_secure?: array{ares_trans_status?: string, cryptogram?: string, electronic_commerce_indicator?: string, network_options?: array{cartes_bancaires?: array{cb_avalgo: string, cb_exemption?: string, cb_score?: int}}, requestor_challenge_indicator?: string, transaction_id?: string, version?: string}}, card_present?: array{}, link?: array{persistent_token?: string}, paypal?: array{billing_agreement_id?: string, currency?: string, subsellers?: string[]}, payto?: array{mandate_options?: array{amount?: int, amount_type?: string, end_date?: string, payment_schedule?: string, payments_per_period?: int, purpose?: string, start_date?: string}}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}}, us_bank_account?: array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, manual_entry?: array{mode: string}, permissions?: string[], prefetch?: string[], return_url?: string}, mandate_options?: array{collection_method?: null|string}, networks?: array{requested?: string[]}, verification_method?: string}}, payment_method_types?: string[]} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/ShippingRate.php b/lib/ShippingRate.php index 903cf0095..1678f1de5 100644 --- a/lib/ShippingRate.php +++ b/lib/ShippingRate.php @@ -12,9 +12,9 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property bool $active Whether the shipping rate can be used for new purchases. Defaults to true. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|object{maximum: null|object{unit: string, value: int}&\Stripe\StripeObject&\stdClass, minimum: null|object{unit: string, value: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $delivery_estimate The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. + * @property null|(object{maximum: null|(object{unit: string, value: int}&\Stripe\StripeObject&\stdClass), minimum: null|(object{unit: string, value: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $delivery_estimate The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. * @property null|string $display_name The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. - * @property null|object{amount: int, currency: string, currency_options?: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass $fixed_amount + * @property null|(object{amount: int, currency: string, currency_options?: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass) $fixed_amount * @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 null|string $tax_behavior Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. @@ -95,7 +95,7 @@ public static function retrieve($id, $opts = null) * Updates an existing shipping rate object. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, expand?: string[], fixed_amount?: array{currency_options?: \Stripe\StripeObject}, metadata?: null|StripeObject, tax_behavior?: string} $params + * @param null|array{active?: bool, expand?: string[], fixed_amount?: array{currency_options?: \Stripe\StripeObject}, metadata?: null|\Stripe\StripeObject, tax_behavior?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Sigma/ScheduledQueryRun.php b/lib/Sigma/ScheduledQueryRun.php index debe829ba..594037ca0 100644 --- a/lib/Sigma/ScheduledQueryRun.php +++ b/lib/Sigma/ScheduledQueryRun.php @@ -14,7 +14,7 @@ * @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 $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time. - * @property null|object{message: string}&\Stripe\StripeObject&\stdClass $error + * @property null|(object{message: string}&\Stripe\StripeObject&\stdClass) $error * @property null|\Stripe\File $file The file object representing the results of the query. * @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 $result_available_until Time at which the result expires and is no longer available for download. diff --git a/lib/Source.php b/lib/Source.php index 3ffc65ba4..d79c5ef14 100644 --- a/lib/Source.php +++ b/lib/Source.php @@ -18,43 +18,43 @@ * * @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 object{account_number?: null|string, bank_name?: null|string, fingerprint?: null|string, refund_account_holder_name?: null|string, refund_account_holder_type?: null|string, refund_routing_number?: null|string, routing_number?: null|string, swift_code?: null|string}&\Stripe\StripeObject&\stdClass $ach_credit_transfer - * @property object{bank_name?: null|string, country?: null|string, fingerprint?: null|string, last4?: null|string, routing_number?: null|string, type?: null|string}&\Stripe\StripeObject&\stdClass $ach_debit - * @property object{bank_address_city?: null|string, bank_address_line_1?: null|string, bank_address_line_2?: null|string, bank_address_postal_code?: null|string, bank_name?: null|string, category?: null|string, country?: null|string, fingerprint?: null|string, last4?: null|string, routing_number?: null|string}&\Stripe\StripeObject&\stdClass $acss_debit - * @property object{data_string?: null|string, native_url?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass $alipay + * @property (object{account_number?: null|string, bank_name?: null|string, fingerprint?: null|string, refund_account_holder_name?: null|string, refund_account_holder_type?: null|string, refund_routing_number?: null|string, routing_number?: null|string, swift_code?: null|string}&\Stripe\StripeObject&\stdClass) $ach_credit_transfer + * @property (object{bank_name?: null|string, country?: null|string, fingerprint?: null|string, last4?: null|string, routing_number?: null|string, type?: null|string}&\Stripe\StripeObject&\stdClass) $ach_debit + * @property (object{bank_address_city?: null|string, bank_address_line_1?: null|string, bank_address_line_2?: null|string, bank_address_postal_code?: null|string, bank_name?: null|string, category?: null|string, country?: null|string, fingerprint?: null|string, last4?: null|string, routing_number?: null|string}&\Stripe\StripeObject&\stdClass) $acss_debit + * @property (object{data_string?: null|string, native_url?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass) $alipay * @property null|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 associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources. - * @property object{bsb_number?: null|string, fingerprint?: null|string, last4?: null|string}&\Stripe\StripeObject&\stdClass $au_becs_debit - * @property object{bank_code?: null|string, bank_name?: null|string, bic?: null|string, iban_last4?: null|string, preferred_language?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass $bancontact - * @property object{address_line1_check?: null|string, address_zip_check?: null|string, brand?: null|string, country?: null|string, cvc_check?: null|string, description?: string, dynamic_last4?: null|string, exp_month?: null|int, exp_year?: null|int, fingerprint?: string, funding?: null|string, iin?: string, issuer?: string, last4?: null|string, name?: null|string, three_d_secure?: string, tokenization_method?: null|string}&\Stripe\StripeObject&\stdClass $card - * @property object{application_cryptogram?: string, application_preferred_name?: string, authorization_code?: null|string, authorization_response_code?: string, brand?: null|string, country?: null|string, cvm_type?: string, data_type?: null|string, dedicated_file_name?: string, description?: string, emv_auth_data?: string, evidence_customer_signature?: null|string, evidence_transaction_certificate?: null|string, exp_month?: null|int, exp_year?: null|int, fingerprint?: string, funding?: null|string, iin?: string, issuer?: string, last4?: null|string, pos_device_id?: null|string, pos_entry_mode?: string, read_method?: null|string, reader?: null|string, terminal_verification_results?: string, transaction_status_information?: string}&\Stripe\StripeObject&\stdClass $card_present + * @property (object{bsb_number?: null|string, fingerprint?: null|string, last4?: null|string}&\Stripe\StripeObject&\stdClass) $au_becs_debit + * @property (object{bank_code?: null|string, bank_name?: null|string, bic?: null|string, iban_last4?: null|string, preferred_language?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass) $bancontact + * @property (object{address_line1_check?: null|string, address_zip_check?: null|string, brand?: null|string, country?: null|string, cvc_check?: null|string, description?: string, dynamic_last4?: null|string, exp_month?: null|int, exp_year?: null|int, fingerprint?: string, funding?: null|string, iin?: string, issuer?: string, last4?: null|string, name?: null|string, three_d_secure?: string, tokenization_method?: null|string}&\Stripe\StripeObject&\stdClass) $card + * @property (object{application_cryptogram?: string, application_preferred_name?: string, authorization_code?: null|string, authorization_response_code?: string, brand?: null|string, country?: null|string, cvm_type?: string, data_type?: null|string, dedicated_file_name?: string, description?: string, emv_auth_data?: string, evidence_customer_signature?: null|string, evidence_transaction_certificate?: null|string, exp_month?: null|int, exp_year?: null|int, fingerprint?: string, funding?: null|string, iin?: string, issuer?: string, last4?: null|string, pos_device_id?: null|string, pos_entry_mode?: string, read_method?: null|string, reader?: null|string, terminal_verification_results?: string, transaction_status_information?: string}&\Stripe\StripeObject&\stdClass) $card_present * @property string $client_secret The client secret of the source. Used for client-side retrieval using a publishable key. - * @property null|object{attempts_remaining: int, status: string}&\Stripe\StripeObject&\stdClass $code_verification + * @property null|(object{attempts_remaining: int, status: string}&\Stripe\StripeObject&\stdClass) $code_verification * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $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 null|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 object{reference?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass $eps + * @property (object{reference?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass) $eps * @property string $flow The authentication flow of the source. flow is one of redirect, receiver, code_verification, none. - * @property object{bank_code?: null|string, bank_name?: null|string, bic?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass $giropay - * @property object{bank?: null|string, bic?: null|string, iban_last4?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass $ideal - * @property object{background_image_url?: string, client_token?: null|string, first_name?: string, last_name?: string, locale?: string, logo_url?: string, page_title?: string, pay_later_asset_urls_descriptive?: string, pay_later_asset_urls_standard?: string, pay_later_name?: string, pay_later_redirect_url?: string, pay_now_asset_urls_descriptive?: string, pay_now_asset_urls_standard?: string, pay_now_name?: string, pay_now_redirect_url?: string, pay_over_time_asset_urls_descriptive?: string, pay_over_time_asset_urls_standard?: string, pay_over_time_name?: string, pay_over_time_redirect_url?: string, payment_method_categories?: string, purchase_country?: string, purchase_type?: string, redirect_url?: string, shipping_delay?: int, shipping_first_name?: string, shipping_last_name?: string}&\Stripe\StripeObject&\stdClass $klarna + * @property (object{bank_code?: null|string, bank_name?: null|string, bic?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass) $giropay + * @property (object{bank?: null|string, bic?: null|string, iban_last4?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass) $ideal + * @property (object{background_image_url?: string, client_token?: null|string, first_name?: string, last_name?: string, locale?: string, logo_url?: string, page_title?: string, pay_later_asset_urls_descriptive?: string, pay_later_asset_urls_standard?: string, pay_later_name?: string, pay_later_redirect_url?: string, pay_now_asset_urls_descriptive?: string, pay_now_asset_urls_standard?: string, pay_now_name?: string, pay_now_redirect_url?: string, pay_over_time_asset_urls_descriptive?: string, pay_over_time_asset_urls_standard?: string, pay_over_time_name?: string, pay_over_time_redirect_url?: string, payment_method_categories?: string, purchase_country?: string, purchase_type?: string, redirect_url?: string, shipping_delay?: int, shipping_first_name?: string, shipping_last_name?: string}&\Stripe\StripeObject&\stdClass) $klarna * @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 null|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 object{entity?: null|string, reference?: null|string, refund_account_holder_address_city?: null|string, refund_account_holder_address_country?: null|string, refund_account_holder_address_line1?: null|string, refund_account_holder_address_line2?: null|string, refund_account_holder_address_postal_code?: null|string, refund_account_holder_address_state?: null|string, refund_account_holder_name?: null|string, refund_iban?: null|string}&\Stripe\StripeObject&\stdClass $multibanco - * @property null|object{address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string, phone: null|string, verified_address: null|object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, verified_email: null|string, verified_name: null|string, verified_phone: null|string}&\Stripe\StripeObject&\stdClass $owner Information about the owner of the payment instrument that may be used or required by particular source types. - * @property object{reference?: null|string}&\Stripe\StripeObject&\stdClass $p24 - * @property object{billing_agreement?: null|string, fingerprint?: null|string, payer_id?: null|string, reference_id?: string, reference_transaction_amount?: string, reference_transaction_charged?: bool, statement_descriptor?: null|string, transaction_id?: string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass $paypal - * @property object{address: null|string, amount_charged: int, amount_received: int, amount_returned: int, refund_attributes_method: string, refund_attributes_status: string}&\Stripe\StripeObject&\stdClass $receiver - * @property object{failure_reason: null|string, return_url: string, status: string, url: string}&\Stripe\StripeObject&\stdClass $redirect - * @property object{bank_name?: null|string, bic?: null|string, iban?: null|string, refund_account_holder_address_city?: null|string, refund_account_holder_address_country?: null|string, refund_account_holder_address_line1?: null|string, refund_account_holder_address_line2?: null|string, refund_account_holder_address_postal_code?: null|string, refund_account_holder_address_state?: null|string, refund_account_holder_name?: null|string, refund_iban?: null|string}&\Stripe\StripeObject&\stdClass $sepa_credit_transfer - * @property object{bank_code?: null|string, branch_code?: null|string, country?: null|string, fingerprint?: null|string, last4?: null|string, mandate_reference?: null|string, mandate_url?: null|string}&\Stripe\StripeObject&\stdClass $sepa_debit - * @property object{bank_code?: null|string, bank_name?: null|string, bic?: null|string, country?: null|string, iban_last4?: null|string, preferred_language?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass $sofort - * @property object{amount: int, currency: string, email?: string, items: null|(object{amount: null|int, currency: null|string, description: null|string, parent: null|string, quantity?: int, type: null|string}&\Stripe\StripeObject&\stdClass)[], shipping?: object{address?: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $source_order + * @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 (object{entity?: null|string, reference?: null|string, refund_account_holder_address_city?: null|string, refund_account_holder_address_country?: null|string, refund_account_holder_address_line1?: null|string, refund_account_holder_address_line2?: null|string, refund_account_holder_address_postal_code?: null|string, refund_account_holder_address_state?: null|string, refund_account_holder_name?: null|string, refund_iban?: null|string}&\Stripe\StripeObject&\stdClass) $multibanco + * @property null|(object{address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string, phone: null|string, verified_address: null|(object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), verified_email: null|string, verified_name: null|string, verified_phone: null|string}&\Stripe\StripeObject&\stdClass) $owner Information about the owner of the payment instrument that may be used or required by particular source types. + * @property (object{reference?: null|string}&\Stripe\StripeObject&\stdClass) $p24 + * @property (object{billing_agreement?: null|string, fingerprint?: null|string, payer_id?: null|string, reference_id?: string, reference_transaction_amount?: string, reference_transaction_charged?: bool, statement_descriptor?: null|string, transaction_id?: string, verified_email?: null|string}&\Stripe\StripeObject&\stdClass) $paypal + * @property (object{address: null|string, amount_charged: int, amount_received: int, amount_returned: int, refund_attributes_method: string, refund_attributes_status: string}&\Stripe\StripeObject&\stdClass) $receiver + * @property (object{failure_reason: null|string, return_url: string, status: string, url: string}&\Stripe\StripeObject&\stdClass) $redirect + * @property (object{bank_name?: null|string, bic?: null|string, iban?: null|string, refund_account_holder_address_city?: null|string, refund_account_holder_address_country?: null|string, refund_account_holder_address_line1?: null|string, refund_account_holder_address_line2?: null|string, refund_account_holder_address_postal_code?: null|string, refund_account_holder_address_state?: null|string, refund_account_holder_name?: null|string, refund_iban?: null|string}&\Stripe\StripeObject&\stdClass) $sepa_credit_transfer + * @property (object{bank_code?: null|string, branch_code?: null|string, country?: null|string, fingerprint?: null|string, last4?: null|string, mandate_reference?: null|string, mandate_url?: null|string}&\Stripe\StripeObject&\stdClass) $sepa_debit + * @property (object{bank_code?: null|string, bank_name?: null|string, bic?: null|string, country?: null|string, iban_last4?: null|string, preferred_language?: null|string, statement_descriptor?: null|string}&\Stripe\StripeObject&\stdClass) $sofort + * @property (object{amount: int, currency: string, email?: string, items: null|((object{amount: null|int, currency: null|string, description: null|string, parent: null|string, quantity?: int, type: null|string}&\Stripe\StripeObject&\stdClass))[], shipping?: (object{address?: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), carrier?: null|string, name?: string, phone?: null|string, tracking_number?: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $source_order * @property null|string $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 object{address_line1_check?: null|string, address_zip_check?: null|string, authenticated?: null|bool, brand?: null|string, card?: null|string, country?: null|string, customer?: null|string, cvc_check?: null|string, description?: string, dynamic_last4?: null|string, exp_month?: null|int, exp_year?: null|int, fingerprint?: string, funding?: null|string, iin?: string, issuer?: string, last4?: null|string, name?: null|string, three_d_secure?: string, tokenization_method?: null|string}&\Stripe\StripeObject&\stdClass $three_d_secure + * @property (object{address_line1_check?: null|string, address_zip_check?: null|string, authenticated?: null|bool, brand?: null|string, card?: null|string, country?: null|string, customer?: null|string, cvc_check?: null|string, description?: string, dynamic_last4?: null|string, exp_month?: null|int, exp_year?: null|int, fingerprint?: string, funding?: null|string, iin?: string, issuer?: string, last4?: null|string, name?: null|string, three_d_secure?: string, tokenization_method?: null|string}&\Stripe\StripeObject&\stdClass) $three_d_secure * @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 null|string $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 object{prepay_id?: string, qr_code_url?: null|string, statement_descriptor?: string}&\Stripe\StripeObject&\stdClass $wechat + * @property (object{prepay_id?: string, qr_code_url?: null|string, statement_descriptor?: string}&\Stripe\StripeObject&\stdClass) $wechat */ class Source extends ApiResource { @@ -150,7 +150,7 @@ public static function retrieve($id, $opts = null) * guides for more detail. * * @param string $id the ID of the resource to update - * @param null|array{amount?: int, expand?: string[], mandate?: array{acceptance?: array{date?: int, ip?: string, offline?: array{contact_email: string}, online?: array{date?: int, ip?: string, user_agent?: string}, status: string, type?: string, user_agent?: string}, amount?: null|int, currency?: string, interval?: string, notification_method?: string}, metadata?: null|StripeObject, owner?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, source_order?: array{items?: array{amount?: int, currency?: string, description?: string, parent?: string, quantity?: int, type?: string}[], shipping?: array{address: array{city?: string, country?: string, line1: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name?: string, phone?: string, tracking_number?: string}}} $params + * @param null|array{amount?: int, expand?: string[], mandate?: array{acceptance?: array{date?: int, ip?: string, offline?: array{contact_email: string}, online?: array{date?: int, ip?: string, user_agent?: string}, status: string, type?: string, user_agent?: string}, amount?: null|int, currency?: string, interval?: string, notification_method?: string}, metadata?: null|\Stripe\StripeObject, owner?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: string, name?: string, phone?: string}, source_order?: array{items?: array{amount?: int, currency?: string, description?: string, parent?: string, quantity?: int, type?: string}[], shipping?: array{address: array{city?: string, country?: string, line1: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name?: string, phone?: string, tracking_number?: string}}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/SourceMandateNotification.php b/lib/SourceMandateNotification.php index 2d9513883..02aa93df1 100644 --- a/lib/SourceMandateNotification.php +++ b/lib/SourceMandateNotification.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 null|object{statement_descriptor?: string}&\Stripe\StripeObject&\stdClass $acss_debit + * @property null|(object{statement_descriptor?: string}&\Stripe\StripeObject&\stdClass) $acss_debit * @property null|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 amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is debit_initiated. - * @property null|object{last4?: string}&\Stripe\StripeObject&\stdClass $bacs_debit + * @property null|(object{last4?: string}&\Stripe\StripeObject&\stdClass) $bacs_debit * @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 $reason The reason of the mandate notification. Valid reasons are mandate_confirmed or debit_initiated. - * @property null|object{creditor_identifier?: string, last4?: string, mandate_reference?: string}&\Stripe\StripeObject&\stdClass $sepa_debit + * @property null|(object{creditor_identifier?: string, last4?: string, mandate_reference?: string}&\Stripe\StripeObject&\stdClass) $sepa_debit * @property \Stripe\Source $source

Source objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a Card object: once chargeable, they can be charged, or can be attached to customers.

Stripe doesn't recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API provides access to our latest features and payment method types.

Related guides: Sources API and Sources & Customers.

* @property string $status The status of the mandate notification. Valid statuses are pending or submitted. * @property string $type The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as three_d_secure. diff --git a/lib/SourceTransaction.php b/lib/SourceTransaction.php index 6810effe4..955e66c3d 100644 --- a/lib/SourceTransaction.php +++ b/lib/SourceTransaction.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 null|object{customer_data?: string, fingerprint?: string, last4?: string, routing_number?: string}&\Stripe\StripeObject&\stdClass $ach_credit_transfer + * @property null|(object{customer_data?: string, fingerprint?: string, last4?: string, routing_number?: string}&\Stripe\StripeObject&\stdClass) $ach_credit_transfer * @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 amount your customer has pushed to the receiver. - * @property null|object{reference?: string, sender_address_country?: string, sender_address_line1?: string, sender_iban?: string, sender_name?: string}&\Stripe\StripeObject&\stdClass $chf_credit_transfer + * @property null|(object{reference?: string, sender_address_country?: string, sender_address_line1?: string, sender_iban?: string, sender_name?: string}&\Stripe\StripeObject&\stdClass) $chf_credit_transfer * @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|object{fingerprint?: string, funding_method?: string, last4?: string, reference?: string, sender_account_number?: string, sender_name?: string, sender_sort_code?: string}&\Stripe\StripeObject&\stdClass $gbp_credit_transfer + * @property null|(object{fingerprint?: string, funding_method?: string, last4?: string, reference?: string, sender_account_number?: string, sender_name?: string, sender_sort_code?: string}&\Stripe\StripeObject&\stdClass) $gbp_credit_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 null|object{available_at?: string, invoices?: string}&\Stripe\StripeObject&\stdClass $paper_check - * @property null|object{reference?: string, sender_iban?: string, sender_name?: string}&\Stripe\StripeObject&\stdClass $sepa_credit_transfer + * @property null|(object{available_at?: string, invoices?: string}&\Stripe\StripeObject&\stdClass) $paper_check + * @property null|(object{reference?: string, sender_iban?: string, sender_name?: string}&\Stripe\StripeObject&\stdClass) $sepa_credit_transfer * @property string $source The ID of the source this transaction is attached to. * @property string $status The status of the transaction, one of succeeded, pending, or failed. * @property string $type The type of source this transaction is attached to. diff --git a/lib/Subscription.php b/lib/Subscription.php index cefd7faf8..4932da7fd 100644 --- a/lib/Subscription.php +++ b/lib/Subscription.php @@ -13,14 +13,14 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property null|string|\Stripe\Application $application ID of the Connect Application that created the subscription. * @property null|float $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 total that will be transferred to the application owner's Stripe account. - * @property object{disabled_reason: null|string, enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $automatic_tax + * @property (object{disabled_reason: null|string, enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $automatic_tax * @property int $billing_cycle_anchor The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format. - * @property null|object{day_of_month: int, hour: null|int, minute: null|int, month: null|int, second: null|int}&\Stripe\StripeObject&\stdClass $billing_cycle_anchor_config The fixed values used to calculate the billing_cycle_anchor. - * @property null|object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass $billing_thresholds Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + * @property null|(object{day_of_month: int, hour: null|int, minute: null|int, month: null|int, second: null|int}&\Stripe\StripeObject&\stdClass) $billing_cycle_anchor_config The fixed values used to calculate the billing_cycle_anchor. + * @property null|(object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass) $billing_thresholds Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period * @property null|int $cancel_at A date in the future at which the subscription will automatically get canceled * @property bool $cancel_at_period_end Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period. * @property null|int $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 reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. - * @property null|object{comment: null|string, feedback: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass $cancellation_details Details about why this subscription was cancelled + * @property null|(object{comment: null|string, feedback: null|string, reason: null|string}&\Stripe\StripeObject&\stdClass) $cancellation_details Details about why this subscription was cancelled * @property string $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 and mark the subscription as active. * @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. @@ -35,27 +35,27 @@ * @property null|\Stripe\Discount $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. This field has been deprecated and will be removed in a future API version. Use discounts instead. * @property (string|\Stripe\Discount)[] $discounts The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount. * @property null|int $ended_at If the subscription has ended, the date the subscription ended. - * @property object{account_tax_ids: null|(string|\Stripe\TaxId)[], issuer: object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $invoice_settings + * @property (object{account_tax_ids: null|(string|\Stripe\TaxId)[], issuer: (object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $invoice_settings * @property \Stripe\Collection<\Stripe\SubscriptionItem> $items List of subscription items, each with an attached price. - * @property null|object{errored_at: int, failed_transitions: object{source_price: string, target_price: string}&\Stripe\StripeObject&\stdClass[], type: string}&\Stripe\StripeObject&\stdClass $last_price_migration_error Details of the most recent price migration that failed for the subscription. + * @property null|(object{errored_at: int, failed_transitions: (object{source_price: string, target_price: string}&\Stripe\StripeObject&\stdClass)[], type: string}&\Stripe\StripeObject&\stdClass) $last_price_migration_error Details of the most recent price migration that failed for the subscription. * @property null|string|\Stripe\Invoice $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 null|int $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 null|string|\Stripe\Account $on_behalf_of The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. - * @property null|object{behavior: string, resumes_at: null|int}&\Stripe\StripeObject&\stdClass $pause_collection If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection. - * @property null|object{payment_method_options: null|object{acss_debit: null|object{mandate_options?: object{transaction_type: null|string}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass, bancontact: null|object{preferred_language: string}&\Stripe\StripeObject&\stdClass, card: null|object{mandate_options?: object{amount: null|int, amount_type: null|string, description: null|string}&\Stripe\StripeObject&\stdClass, network: null|string, request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass, customer_balance: null|object{bank_transfer?: object{eu_bank_transfer?: object{country: string}&\Stripe\StripeObject&\stdClass, type: null|string}&\Stripe\StripeObject&\stdClass, funding_type: null|string}&\Stripe\StripeObject&\stdClass, id_bank_transfer?: null|object{}&\Stripe\StripeObject&\stdClass, konbini: null|object{}&\Stripe\StripeObject&\stdClass, sepa_debit: null|object{}&\Stripe\StripeObject&\stdClass, us_bank_account: null|object{financial_connections?: object{filters?: object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass, permissions?: string[], prefetch: null|string[]}&\Stripe\StripeObject&\stdClass, verification_method?: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payment_method_types: null|string[], save_default_payment_method: null|string}&\Stripe\StripeObject&\stdClass $payment_settings Payment settings passed on to invoices created by the subscription. - * @property null|object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass $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 null|(object{behavior: string, resumes_at: null|int}&\Stripe\StripeObject&\stdClass) $pause_collection If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection. + * @property null|(object{payment_method_options: null|(object{acss_debit: null|(object{mandate_options?: (object{transaction_type: null|string}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass), bancontact: null|(object{preferred_language: string}&\Stripe\StripeObject&\stdClass), card: null|(object{mandate_options?: (object{amount: null|int, amount_type: null|string, description: null|string}&\Stripe\StripeObject&\stdClass), network: null|string, request_three_d_secure: null|string}&\Stripe\StripeObject&\stdClass), customer_balance: null|(object{bank_transfer?: (object{eu_bank_transfer?: (object{country: string}&\Stripe\StripeObject&\stdClass), type: null|string}&\Stripe\StripeObject&\stdClass), funding_type: null|string}&\Stripe\StripeObject&\stdClass), id_bank_transfer?: null|(object{}&\Stripe\StripeObject&\stdClass), konbini: null|(object{}&\Stripe\StripeObject&\stdClass), sepa_debit: null|(object{}&\Stripe\StripeObject&\stdClass), us_bank_account: null|(object{financial_connections?: (object{filters?: (object{account_subcategories?: string[], institution?: string}&\Stripe\StripeObject&\stdClass), permissions?: string[], prefetch: null|string[]}&\Stripe\StripeObject&\stdClass), verification_method?: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payment_method_types: null|string[], save_default_payment_method: null|string}&\Stripe\StripeObject&\stdClass) $payment_settings Payment settings passed on to invoices created by the subscription. + * @property null|(object{interval: string, interval_count: int}&\Stripe\StripeObject&\stdClass) $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 null|string|\Stripe\SetupIntent $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 null|object{billing_cycle_anchor: null|int, expires_at: int, prebilling_iterations?: null|int, subscription_items: null|\Stripe\SubscriptionItem[], trial_end: null|int, trial_from_plan: null|bool}&\Stripe\StripeObject&\stdClass $pending_update If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid. - * @property null|object{invoice: string|\Stripe\Invoice, period_end: int, period_start: int, update_behavior?: string}&\Stripe\StripeObject&\stdClass $prebilling Time period and invoice for a Subscription billed in advance. + * @property null|(object{billing_cycle_anchor: null|int, expires_at: int, prebilling_iterations?: null|int, subscription_items: null|\Stripe\SubscriptionItem[], trial_end: null|int, trial_from_plan: null|bool}&\Stripe\StripeObject&\stdClass) $pending_update If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid. + * @property null|(object{invoice: string|\Stripe\Invoice, period_end: int, period_start: int, update_behavior?: string}&\Stripe\StripeObject&\stdClass) $prebilling Time period and invoice for a Subscription billed in advance. * @property null|string|\Stripe\SubscriptionSchedule $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, unpaid, or paused.

For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, 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.

A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

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.

* @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription belongs to. - * @property null|object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass $transfer_data The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. + * @property null|(object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass) $transfer_data The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. * @property null|int $trial_end If the subscription has a trial, the end of that trial. - * @property null|object{end_behavior: object{missing_payment_method: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $trial_settings Settings related to subscription trials. + * @property null|(object{end_behavior: (object{missing_payment_method: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $trial_settings Settings related to subscription trials. * @property null|int $trial_start If the subscription has a trial, the beginning of that trial. */ class Subscription extends ApiResource @@ -91,7 +91,7 @@ class Subscription extends ApiResource * schedules instead. Schedules provide the flexibility to model more complex * billing configurations that change over time. * - * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, backdate_start_date?: int, billing_cycle_anchor?: int, billing_cycle_anchor_config?: array{day_of_month: int, hour?: int, minute?: int, month?: int, second?: int}, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: int, cancel_at_period_end?: bool, collection_method?: string, coupon?: string, currency?: string, customer: string, days_until_due?: int, default_payment_method?: string, default_source?: string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], metadata?: null|StripeObject, off_session?: bool, on_behalf_of?: null|string, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params + * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, backdate_start_date?: int, billing_cycle_anchor?: int, billing_cycle_anchor_config?: array{day_of_month: int, hour?: int, minute?: int, month?: int, second?: int}, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: int, cancel_at_period_end?: bool, collection_method?: string, coupon?: string, currency?: string, customer: string, days_until_due?: int, default_payment_method?: string, default_source?: string, default_tax_rates?: null|string[], description?: string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], metadata?: null|\Stripe\StripeObject, off_session?: bool, on_behalf_of?: null|string, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -199,7 +199,7 @@ public static function retrieve($id, $opts = null) * href="/docs/billing/subscriptions/usage-based">usage-based billing instead. * * @param string $id the ID of the resource to update - * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: null|int, cancel_at_period_end?: bool, cancellation_details?: array{comment?: null|string, feedback?: null|string}, collection_method?: string, coupon?: string, days_until_due?: int, default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|StripeObject, off_session?: bool, on_behalf_of?: null|string, pause_collection?: null|array{behavior: string, resumes_at?: int}, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, proration_date?: int, transfer_data?: null|array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params + * @param null|array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: null|float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, cancel_at?: null|int, cancel_at_period_end?: bool, cancellation_details?: array{comment?: null|string, feedback?: null|string}, collection_method?: string, coupon?: string, days_until_due?: int, default_payment_method?: string, default_source?: null|string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], invoice_settings?: array{account_tax_ids?: null|string[], issuer?: array{account?: string, type: string}}, items?: (array{billing_thresholds?: null|array{usage_gte: int}, clear_usage?: bool, deleted?: bool, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], id?: string, metadata?: null|\Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], metadata?: null|\Stripe\StripeObject, off_session?: bool, on_behalf_of?: null|string, pause_collection?: null|array{behavior: string, resumes_at?: int}, payment_behavior?: string, payment_settings?: array{payment_method_options?: array{acss_debit?: null|array{mandate_options?: array{transaction_type?: string}, verification_method?: string}, bancontact?: null|array{preferred_language?: string}, card?: null|array{mandate_options?: array{amount?: int, amount_type?: string, description?: string}, network?: string, request_three_d_secure?: string}, customer_balance?: null|array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, type?: string}, funding_type?: string}, id_bank_transfer?: null|array{}, konbini?: null|array{}, sepa_debit?: null|array{}, us_bank_account?: null|array{financial_connections?: array{filters?: array{account_subcategories?: string[], institution?: string}, permissions?: string[], prefetch?: string[]}, verification_method?: string}}, payment_method_types?: null|string[], save_default_payment_method?: string}, pending_invoice_item_interval?: null|array{interval: string, interval_count?: int}, prebilling?: array{iterations: int, update_behavior?: string}, promotion_code?: string, proration_behavior?: string, proration_date?: int, transfer_data?: null|array{amount_percent?: float, destination: string}, trial_end?: int|array, trial_from_plan?: bool, trial_settings?: array{end_behavior: array{missing_payment_method: string}}} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/SubscriptionItem.php b/lib/SubscriptionItem.php index 55cbb6e38..1c499e7da 100644 --- a/lib/SubscriptionItem.php +++ b/lib/SubscriptionItem.php @@ -10,7 +10,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|object{usage_gte: null|int}&\Stripe\StripeObject&\stdClass $billing_thresholds Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + * @property null|(object{usage_gte: null|int}&\Stripe\StripeObject&\stdClass) $billing_thresholds Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property (string|\Stripe\Discount)[] $discounts The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount. * @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. @@ -19,7 +19,7 @@ * @property null|int $quantity The quantity of the plan to which the customer should be subscribed. * @property string $subscription The subscription this subscription_item belongs to. * @property null|\Stripe\TaxRate[] $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. - * @property null|object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass $trial Options that configure the trial on the subscription item. + * @property null|(object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass) $trial Options that configure the trial on the subscription item. */ class SubscriptionItem extends ApiResource { @@ -113,7 +113,7 @@ public static function retrieve($id, $opts = null) * Updates the plan or quantity of an item on a current subscription. * * @param string $id the ID of the resource to update - * @param null|array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], metadata?: null|StripeObject, off_session?: bool, payment_behavior?: string, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, proration_behavior?: string, proration_date?: int, quantity?: int, tax_rates?: null|string[]} $params + * @param null|array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], expand?: string[], metadata?: null|\Stripe\StripeObject, off_session?: bool, payment_behavior?: string, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, proration_behavior?: string, proration_date?: int, quantity?: int, tax_rates?: null|string[]} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/SubscriptionSchedule.php b/lib/SubscriptionSchedule.php index 0253c6815..9e7ea468f 100644 --- a/lib/SubscriptionSchedule.php +++ b/lib/SubscriptionSchedule.php @@ -16,15 +16,15 @@ * @property null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. * @property null|int $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 null|object{end_date: int, start_date: int}&\Stripe\StripeObject&\stdClass $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is active. + * @property null|(object{end_date: int, start_date: int}&\Stripe\StripeObject&\stdClass) $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 object{application_fee_percent: null|float, automatic_tax?: object{disabled_reason: null|string, enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, billing_cycle_anchor: string, billing_thresholds: null|object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass, collection_method: null|string, default_payment_method: null|string|\Stripe\PaymentMethod, description: null|string, invoice_settings: object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, on_behalf_of: null|string|\Stripe\Account, transfer_data: null|object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $default_settings + * @property (object{application_fee_percent: null|float, automatic_tax?: (object{disabled_reason: null|string, enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), billing_cycle_anchor: string, billing_thresholds: null|(object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass), collection_method: null|string, default_payment_method: null|string|\Stripe\PaymentMethod, description: null|string, invoice_settings: (object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: (object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), on_behalf_of: null|string|\Stripe\Account, transfer_data: null|(object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $default_settings * @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription. - * @property null|object{errored_at: int, failed_transitions: object{source_price: string, target_price: string}&\Stripe\StripeObject&\stdClass[], type: string}&\Stripe\StripeObject&\stdClass $last_price_migration_error Details of the most recent price migration that failed for the subscription schedule. + * @property null|(object{errored_at: int, failed_transitions: (object{source_price: string, target_price: string}&\Stripe\StripeObject&\stdClass)[], type: string}&\Stripe\StripeObject&\stdClass) $last_price_migration_error Details of the most recent price migration that failed for the subscription schedule. * @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 null|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 (object{add_invoice_items: (object{discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], price: string|\Stripe\Price, quantity: null|int, tax_rates?: null|\Stripe\TaxRate[]}&\Stripe\StripeObject&\stdClass)[], application_fee_percent: null|float, automatic_tax?: object{disabled_reason: null|string, enabled: bool, liability: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, billing_cycle_anchor: null|string, billing_thresholds: null|object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass, collection_method: null|string, coupon: null|string|\Stripe\Coupon, currency: string, default_payment_method: null|string|\Stripe\PaymentMethod, default_tax_rates?: null|\Stripe\TaxRate[], description: null|string, discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], end_date: int, invoice_settings: null|object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: null|object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, items: (object{billing_thresholds: null|object{usage_gte: null|int}&\Stripe\StripeObject&\stdClass, discounts: (object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass, promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass)[], metadata: null|StripeObject, plan: string|\Stripe\Plan, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[], metadata: null|StripeObject, on_behalf_of: null|string|\Stripe\Account, pause_collection?: null|object{behavior: string}&\Stripe\StripeObject&\stdClass, proration_behavior: string, start_date: int, transfer_data: null|object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass, trial_continuation?: null|string, trial_end: null|int, trial_settings?: null|object{end_behavior: null|object{prorate_up_front: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass)[] $phases Configuration for the subscription schedule's phases. - * @property null|object{invoice: string|\Stripe\Invoice, period_end: int, period_start: int, update_behavior?: string}&\Stripe\StripeObject&\stdClass $prebilling Time period and invoice for a Subscription billed in advance. + * @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 ((object{add_invoice_items: ((object{discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], price: string|\Stripe\Price, quantity: null|int, tax_rates?: null|\Stripe\TaxRate[]}&\Stripe\StripeObject&\stdClass))[], application_fee_percent: null|float, automatic_tax?: (object{disabled_reason: null|string, enabled: bool, liability: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), billing_cycle_anchor: null|string, billing_thresholds: null|(object{amount_gte: null|int, reset_billing_cycle_anchor: null|bool}&\Stripe\StripeObject&\stdClass), collection_method: null|string, coupon: null|string|\Stripe\Coupon, currency: string, default_payment_method: null|string|\Stripe\PaymentMethod, default_tax_rates?: null|\Stripe\TaxRate[], description: null|string, discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], end_date: int, invoice_settings: null|(object{account_tax_ids: null|(string|\Stripe\TaxId)[], days_until_due: null|int, issuer: null|(object{account?: string|\Stripe\Account, type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), items: ((object{billing_thresholds: null|(object{usage_gte: null|int}&\Stripe\StripeObject&\stdClass), discounts: ((object{coupon: null|string|\Stripe\Coupon, discount: null|string|\Stripe\Discount, discount_end?: null|(object{timestamp: null|int, type: string}&\Stripe\StripeObject&\stdClass), promotion_code: null|string|\Stripe\PromotionCode}&\Stripe\StripeObject&\stdClass))[], metadata: null|\Stripe\StripeObject, plan: string|\Stripe\Plan, price: string|\Stripe\Price, quantity?: int, tax_rates?: null|\Stripe\TaxRate[], trial?: null|(object{converts_to?: null|string[], type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[], metadata: null|\Stripe\StripeObject, on_behalf_of: null|string|\Stripe\Account, pause_collection?: null|(object{behavior: string}&\Stripe\StripeObject&\stdClass), proration_behavior: string, start_date: int, transfer_data: null|(object{amount_percent: null|float, destination: string|\Stripe\Account}&\Stripe\StripeObject&\stdClass), trial_continuation?: null|string, trial_end: null|int, trial_settings?: null|(object{end_behavior: null|(object{prorate_up_front: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass))[] $phases Configuration for the subscription schedule's phases. + * @property null|(object{invoice: string|\Stripe\Invoice, period_end: int, period_start: int, update_behavior?: string}&\Stripe\StripeObject&\stdClass) $prebilling Time period and invoice for a Subscription billed in advance. * @property null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. * @property null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released). * @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. @@ -55,7 +55,7 @@ class SubscriptionSchedule extends ApiResource * Creates a new subscription schedule object. Each customer can have up to 500 * active or scheduled subscriptions. * - * @param null|array{billing_behavior?: string, customer?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], from_subscription?: string, metadata?: null|StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, start_date?: int|array} $params + * @param null|array{billing_behavior?: string, customer?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], from_subscription?: string, metadata?: null|\Stripe\StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, start_date?: int|array} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -116,7 +116,7 @@ public static function retrieve($id, $opts = null) * Updates an existing subscription schedule. * * @param string $id the ID of the resource to update - * @param null|array{billing_behavior?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], metadata?: null|StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, proration_behavior?: string} $params + * @param null|array{billing_behavior?: string, default_settings?: array{application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, default_payment_method?: string, description?: null|string, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, on_behalf_of?: null|string, transfer_data?: null|array{amount_percent?: float, destination: string}}, end_behavior?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, phases?: (array{add_invoice_items?: (array{discounts?: array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], price?: string, price_data?: array{currency: string, product: string, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[]})[], application_fee_percent?: float, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_cycle_anchor?: string, billing_thresholds?: null|array{amount_gte?: int, reset_billing_cycle_anchor?: bool}, collection_method?: string, coupon?: string, currency?: string, default_payment_method?: string, default_tax_rates?: null|string[], description?: null|string, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], end_date?: int|array, invoice_settings?: array{account_tax_ids?: null|string[], days_until_due?: int, issuer?: array{account?: string, type: string}}, items: (array{billing_thresholds?: null|array{usage_gte: int}, discounts?: null|array{coupon?: string, discount?: string, discount_end?: array{duration?: array{interval: string, interval_count: int}, timestamp?: int, type: string}, promotion_code?: string}[], metadata?: \Stripe\StripeObject, plan?: string, price?: string, price_data?: array{currency: string, product: string, recurring: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: null|string[], trial?: array{converts_to?: string[], type: string}})[], iterations?: int, metadata?: \Stripe\StripeObject, on_behalf_of?: string, pause_collection?: array{behavior: string}, proration_behavior?: string, start_date?: int|array, transfer_data?: array{amount_percent?: float, destination: string}, trial?: bool, trial_continuation?: string, trial_end?: int|array, trial_settings?: array{end_behavior?: array{prorate_up_front?: string}}})[], prebilling?: array{iterations: int, update_behavior?: string}, proration_behavior?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Tax/Association.php b/lib/Tax/Association.php index 1591c5ae2..6a5713d5b 100644 --- a/lib/Tax/Association.php +++ b/lib/Tax/Association.php @@ -12,7 +12,7 @@ * @property string $calculation The Tax Calculation that was included in PaymentIntent. * @property string $payment_intent The PaymentIntent that this Tax Association is tracking. * @property string $status Status of the Tax Association. - * @property object{committed?: object{reversals: object{status: string, status_details: object{committed?: object{transaction: string}&\Stripe\StripeObject&\stdClass, errored?: object{reason: string, refund_id: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass[], transaction: string}&\Stripe\StripeObject&\stdClass, errored?: object{reason: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $status_details + * @property (object{committed?: (object{reversals: (object{status: string, status_details: (object{committed?: (object{transaction: string}&\Stripe\StripeObject&\stdClass), errored?: (object{reason: string, refund_id: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass)[], transaction: string}&\Stripe\StripeObject&\stdClass), errored?: (object{reason: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $status_details */ class Association extends \Stripe\ApiResource { diff --git a/lib/Tax/Calculation.php b/lib/Tax/Calculation.php index 6bb20b0f8..5645d624e 100644 --- a/lib/Tax/Calculation.php +++ b/lib/Tax/Calculation.php @@ -14,15 +14,15 @@ * @property int $amount_total Total amount after taxes in the smallest currency unit. * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property null|string $customer The ID of an existing Customer used for the resource. - * @property object{address: null|object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, address_source: null|string, ip_address: null|string, tax_ids: object{type: string, value: string}&\Stripe\StripeObject&\stdClass[], taxability_override: string}&\Stripe\StripeObject&\stdClass $customer_details + * @property (object{address: null|(object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), address_source: null|string, ip_address: null|string, tax_ids: (object{type: string, value: string}&\Stripe\StripeObject&\stdClass)[], taxability_override: string}&\Stripe\StripeObject&\stdClass) $customer_details * @property null|int $expires_at Timestamp of date at which the tax calculation will expire. - * @property null|Collection<\Stripe\Tax\CalculationLineItem> $line_items The list of items the customer is purchasing. + * @property null|\Stripe\Collection<\Stripe\Tax\CalculationLineItem> $line_items The list of items the customer is purchasing. * @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 null|object{address: object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $ship_from_details The details of the ship from location, such as the address. - * @property null|object{amount: int, amount_tax: int, shipping_rate?: string, tax_behavior: string, tax_breakdown?: (object{amount: int, jurisdiction: object{country: string, display_name: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass, sourcing: string, tax_rate_details: null|object{display_name: string, percentage_decimal: string, tax_type: string}&\Stripe\StripeObject&\stdClass, taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass)[], tax_code: string}&\Stripe\StripeObject&\stdClass $shipping_cost The shipping cost details for the calculation. + * @property null|(object{address: (object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $ship_from_details The details of the ship from location, such as the address. + * @property null|(object{amount: int, amount_tax: int, shipping_rate?: string, tax_behavior: string, tax_breakdown?: ((object{amount: int, jurisdiction: (object{country: string, display_name: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass), sourcing: string, tax_rate_details: null|(object{display_name: string, percentage_decimal: string, tax_type: string}&\Stripe\StripeObject&\stdClass), taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass))[], tax_code: string}&\Stripe\StripeObject&\stdClass) $shipping_cost The shipping cost details for the calculation. * @property int $tax_amount_exclusive The amount of tax to be collected on top of the line item prices. * @property int $tax_amount_inclusive The amount of tax already included in the line item prices. - * @property (object{amount: int, inclusive: bool, tax_rate_details: object{country: null|string, flat_amount: null|object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass, percentage_decimal: string, rate_type: null|string, state: null|string, tax_type: null|string}&\Stripe\StripeObject&\stdClass, taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass)[] $tax_breakdown Breakdown of individual tax amounts that add up to the total. + * @property ((object{amount: int, inclusive: bool, tax_rate_details: (object{country: null|string, flat_amount: null|(object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass), percentage_decimal: string, rate_type: null|string, state: null|string, tax_type: null|string}&\Stripe\StripeObject&\stdClass), taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass))[] $tax_breakdown Breakdown of individual tax amounts that add up to the total. * @property int $tax_date Timestamp of date at which the tax rules and rates in effect applies for the calculation. */ class Calculation extends \Stripe\ApiResource diff --git a/lib/Tax/CalculationLineItem.php b/lib/Tax/CalculationLineItem.php index 42d38f7d4..900592044 100644 --- a/lib/Tax/CalculationLineItem.php +++ b/lib/Tax/CalculationLineItem.php @@ -14,7 +14,7 @@ * @property int $quantity The number of units of the item being purchased. For reversals, this is the quantity reversed. * @property null|string $reference A custom identifier for this line item. * @property string $tax_behavior Specifies whether the amount includes taxes. If tax_behavior=inclusive, then the amount includes taxes. - * @property null|(object{amount: int, jurisdiction: object{country: string, display_name: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass, sourcing: string, tax_rate_details: null|object{display_name: string, percentage_decimal: string, tax_type: string}&\Stripe\StripeObject&\stdClass, taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass)[] $tax_breakdown Detailed account of taxes relevant to this line item. + * @property null|((object{amount: int, jurisdiction: (object{country: string, display_name: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass), sourcing: string, tax_rate_details: null|(object{display_name: string, percentage_decimal: string, tax_type: string}&\Stripe\StripeObject&\stdClass), taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass))[] $tax_breakdown Detailed account of taxes relevant to this line item. * @property string $tax_code The tax code ID used for this resource. */ class CalculationLineItem extends \Stripe\ApiResource diff --git a/lib/Tax/Form.php b/lib/Tax/Form.php index cb759233f..04cc2a082 100644 --- a/lib/Tax/Form.php +++ b/lib/Tax/Form.php @@ -11,20 +11,20 @@ * * @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|object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass $au_serr - * @property null|object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass $ca_mrdp + * @property null|(object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass) $au_serr + * @property null|(object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass) $ca_mrdp * @property null|string|\Stripe\Tax\Form $corrected_by The form that corrects this form, if any. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass $eu_dac7 - * @property (object{effective_at: int, jurisdiction: object{country: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass, value: string}&\Stripe\StripeObject&\stdClass)[] $filing_statuses A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority. - * @property null|object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass $gb_mrdp + * @property null|(object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass) $eu_dac7 + * @property ((object{effective_at: int, jurisdiction: (object{country: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass), value: string}&\Stripe\StripeObject&\stdClass))[] $filing_statuses A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority. + * @property null|(object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass) $gb_mrdp * @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 null|object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass $nz_mrdp - * @property object{account: null|string|\Stripe\Account, external_reference: null|string, type: string}&\Stripe\StripeObject&\stdClass $payee + * @property null|(object{reporting_period_end_date: string, reporting_period_start_date: string}&\Stripe\StripeObject&\stdClass) $nz_mrdp + * @property (object{account: null|string|\Stripe\Account, external_reference: null|string, type: string}&\Stripe\StripeObject&\stdClass) $payee * @property string $type The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type. - * @property null|object{reporting_year: int}&\Stripe\StripeObject&\stdClass $us_1099_k - * @property null|object{reporting_year: int}&\Stripe\StripeObject&\stdClass $us_1099_misc - * @property null|object{reporting_year: int}&\Stripe\StripeObject&\stdClass $us_1099_nec + * @property null|(object{reporting_year: int}&\Stripe\StripeObject&\stdClass) $us_1099_k + * @property null|(object{reporting_year: int}&\Stripe\StripeObject&\stdClass) $us_1099_misc + * @property null|(object{reporting_year: int}&\Stripe\StripeObject&\stdClass) $us_1099_nec */ class Form extends \Stripe\ApiResource { diff --git a/lib/Tax/Registration.php b/lib/Tax/Registration.php index 4da29706d..d29518c2b 100644 --- a/lib/Tax/Registration.php +++ b/lib/Tax/Registration.php @@ -15,7 +15,7 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $active_from Time at which the registration becomes active. Measured in seconds since the Unix epoch. * @property string $country Two-letter country code (ISO 3166-1 alpha-2). - * @property object{ae?: object{type: string}&\Stripe\StripeObject&\stdClass, at?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, au?: object{type: string}&\Stripe\StripeObject&\stdClass, be?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, bg?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, bh?: object{type: string}&\Stripe\StripeObject&\stdClass, by?: object{type: string}&\Stripe\StripeObject&\stdClass, ca?: object{province_standard?: object{province: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, ch?: object{type: string}&\Stripe\StripeObject&\stdClass, cl?: object{type: string}&\Stripe\StripeObject&\stdClass, co?: object{type: string}&\Stripe\StripeObject&\stdClass, cr?: object{type: string}&\Stripe\StripeObject&\stdClass, cy?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, cz?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, de?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, dk?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, ec?: object{type: string}&\Stripe\StripeObject&\stdClass, ee?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, eg?: object{type: string}&\Stripe\StripeObject&\stdClass, es?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, fi?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, fr?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, gb?: object{type: string}&\Stripe\StripeObject&\stdClass, ge?: object{type: string}&\Stripe\StripeObject&\stdClass, gr?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, hr?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, hu?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, id?: object{type: string}&\Stripe\StripeObject&\stdClass, ie?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, is?: object{type: string}&\Stripe\StripeObject&\stdClass, it?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, jp?: object{type: string}&\Stripe\StripeObject&\stdClass, ke?: object{type: string}&\Stripe\StripeObject&\stdClass, kr?: object{type: string}&\Stripe\StripeObject&\stdClass, kz?: object{type: string}&\Stripe\StripeObject&\stdClass, lt?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, lu?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, lv?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, ma?: object{type: string}&\Stripe\StripeObject&\stdClass, md?: object{type: string}&\Stripe\StripeObject&\stdClass, mt?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, mx?: object{type: string}&\Stripe\StripeObject&\stdClass, my?: object{type: string}&\Stripe\StripeObject&\stdClass, ng?: object{type: string}&\Stripe\StripeObject&\stdClass, nl?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, no?: object{type: string}&\Stripe\StripeObject&\stdClass, nz?: object{type: string}&\Stripe\StripeObject&\stdClass, om?: object{type: string}&\Stripe\StripeObject&\stdClass, pl?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, pt?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, ro?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, rs?: object{type: string}&\Stripe\StripeObject&\stdClass, ru?: object{type: string}&\Stripe\StripeObject&\stdClass, sa?: object{type: string}&\Stripe\StripeObject&\stdClass, se?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, sg?: object{type: string}&\Stripe\StripeObject&\stdClass, si?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, sk?: object{standard?: object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, th?: object{type: string}&\Stripe\StripeObject&\stdClass, tr?: object{type: string}&\Stripe\StripeObject&\stdClass, tz?: object{type: string}&\Stripe\StripeObject&\stdClass, us?: object{local_amusement_tax?: object{jurisdiction: string}&\Stripe\StripeObject&\stdClass, local_lease_tax?: object{jurisdiction: string}&\Stripe\StripeObject&\stdClass, state: string, state_sales_tax?: object{elections?: object{jurisdiction?: string, type: string}&\Stripe\StripeObject&\stdClass[]}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, uz?: object{type: string}&\Stripe\StripeObject&\stdClass, vn?: object{type: string}&\Stripe\StripeObject&\stdClass, za?: object{type: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $country_options + * @property (object{ae?: (object{type: string}&\Stripe\StripeObject&\stdClass), at?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), au?: (object{type: string}&\Stripe\StripeObject&\stdClass), be?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), bg?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), bh?: (object{type: string}&\Stripe\StripeObject&\stdClass), by?: (object{type: string}&\Stripe\StripeObject&\stdClass), ca?: (object{province_standard?: (object{province: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), ch?: (object{type: string}&\Stripe\StripeObject&\stdClass), cl?: (object{type: string}&\Stripe\StripeObject&\stdClass), co?: (object{type: string}&\Stripe\StripeObject&\stdClass), cr?: (object{type: string}&\Stripe\StripeObject&\stdClass), cy?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), cz?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), de?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), dk?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), ec?: (object{type: string}&\Stripe\StripeObject&\stdClass), ee?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), eg?: (object{type: string}&\Stripe\StripeObject&\stdClass), es?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), fi?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), fr?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), gb?: (object{type: string}&\Stripe\StripeObject&\stdClass), ge?: (object{type: string}&\Stripe\StripeObject&\stdClass), gr?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), hr?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), hu?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), id?: (object{type: string}&\Stripe\StripeObject&\stdClass), ie?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), is?: (object{type: string}&\Stripe\StripeObject&\stdClass), it?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), jp?: (object{type: string}&\Stripe\StripeObject&\stdClass), ke?: (object{type: string}&\Stripe\StripeObject&\stdClass), kr?: (object{type: string}&\Stripe\StripeObject&\stdClass), kz?: (object{type: string}&\Stripe\StripeObject&\stdClass), lt?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), lu?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), lv?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), ma?: (object{type: string}&\Stripe\StripeObject&\stdClass), md?: (object{type: string}&\Stripe\StripeObject&\stdClass), mt?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), mx?: (object{type: string}&\Stripe\StripeObject&\stdClass), my?: (object{type: string}&\Stripe\StripeObject&\stdClass), ng?: (object{type: string}&\Stripe\StripeObject&\stdClass), nl?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), no?: (object{type: string}&\Stripe\StripeObject&\stdClass), nz?: (object{type: string}&\Stripe\StripeObject&\stdClass), om?: (object{type: string}&\Stripe\StripeObject&\stdClass), pl?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), pt?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), ro?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), rs?: (object{type: string}&\Stripe\StripeObject&\stdClass), ru?: (object{type: string}&\Stripe\StripeObject&\stdClass), sa?: (object{type: string}&\Stripe\StripeObject&\stdClass), se?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), sg?: (object{type: string}&\Stripe\StripeObject&\stdClass), si?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), sk?: (object{standard?: (object{place_of_supply_scheme: string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), th?: (object{type: string}&\Stripe\StripeObject&\stdClass), tr?: (object{type: string}&\Stripe\StripeObject&\stdClass), tz?: (object{type: string}&\Stripe\StripeObject&\stdClass), us?: (object{local_amusement_tax?: (object{jurisdiction: string}&\Stripe\StripeObject&\stdClass), local_lease_tax?: (object{jurisdiction: string}&\Stripe\StripeObject&\stdClass), state: string, state_sales_tax?: (object{elections?: (object{jurisdiction?: string, type: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), uz?: (object{type: string}&\Stripe\StripeObject&\stdClass), vn?: (object{type: string}&\Stripe\StripeObject&\stdClass), za?: (object{type: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $country_options * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|int $expires_at If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. 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. diff --git a/lib/Tax/Settings.php b/lib/Tax/Settings.php index a0c864d57..67cae67cf 100644 --- a/lib/Tax/Settings.php +++ b/lib/Tax/Settings.php @@ -10,11 +10,11 @@ * Related guide: Using the Settings API * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property object{tax_behavior: null|string, tax_code: null|string}&\Stripe\StripeObject&\stdClass $defaults - * @property null|object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $head_office The place where your business is located. + * @property (object{tax_behavior: null|string, tax_code: null|string}&\Stripe\StripeObject&\stdClass) $defaults + * @property null|(object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $head_office The place where your business is located. * @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 $status The status of the Tax Settings. - * @property object{active?: object{}&\Stripe\StripeObject&\stdClass, pending?: object{missing_fields: null|string[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $status_details + * @property (object{active?: (object{}&\Stripe\StripeObject&\stdClass), pending?: (object{missing_fields: null|string[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $status_details */ class Settings extends \Stripe\SingletonApiResource { diff --git a/lib/Tax/Transaction.php b/lib/Tax/Transaction.php index 4ce931c8e..bd840a2c9 100644 --- a/lib/Tax/Transaction.php +++ b/lib/Tax/Transaction.php @@ -14,15 +14,15 @@ * @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 $customer The ID of an existing Customer used for the resource. - * @property object{address: null|object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, address_source: null|string, ip_address: null|string, tax_ids: object{type: string, value: string}&\Stripe\StripeObject&\stdClass[], taxability_override: string}&\Stripe\StripeObject&\stdClass $customer_details - * @property null|Collection<\Stripe\Tax\TransactionLineItem> $line_items The tax collected or refunded, by line item. + * @property (object{address: null|(object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), address_source: null|string, ip_address: null|string, tax_ids: (object{type: string, value: string}&\Stripe\StripeObject&\stdClass)[], taxability_override: string}&\Stripe\StripeObject&\stdClass) $customer_details + * @property null|\Stripe\Collection<\Stripe\Tax\TransactionLineItem> $line_items The tax collected or refunded, by line item. * @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 null|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|\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 $posted_at The Unix timestamp representing when the tax liability is assumed or reduced. * @property string $reference A custom unique identifier, such as 'myOrder_123'. - * @property null|object{original_transaction: null|string}&\Stripe\StripeObject&\stdClass $reversal If type=reversal, contains information about what was reversed. - * @property null|object{address: object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $ship_from_details The details of the ship from location, such as the address. - * @property null|object{amount: int, amount_tax: int, shipping_rate?: string, tax_behavior: string, tax_breakdown?: (object{amount: int, jurisdiction: object{country: string, display_name: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass, sourcing: string, tax_rate_details: null|object{display_name: string, percentage_decimal: string, tax_type: string}&\Stripe\StripeObject&\stdClass, taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass)[], tax_code: string}&\Stripe\StripeObject&\stdClass $shipping_cost The shipping cost details for the transaction. + * @property null|(object{original_transaction: null|string}&\Stripe\StripeObject&\stdClass) $reversal If type=reversal, contains information about what was reversed. + * @property null|(object{address: (object{city: null|string, country: string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $ship_from_details The details of the ship from location, such as the address. + * @property null|(object{amount: int, amount_tax: int, shipping_rate?: string, tax_behavior: string, tax_breakdown?: ((object{amount: int, jurisdiction: (object{country: string, display_name: string, level: string, state: null|string}&\Stripe\StripeObject&\stdClass), sourcing: string, tax_rate_details: null|(object{display_name: string, percentage_decimal: string, tax_type: string}&\Stripe\StripeObject&\stdClass), taxability_reason: string, taxable_amount: int}&\Stripe\StripeObject&\stdClass))[], tax_code: string}&\Stripe\StripeObject&\stdClass) $shipping_cost The shipping cost details for the transaction. * @property int $tax_date Timestamp of date at which the tax rules and rates in effect applies for the calculation. * @property string $type If reversal, this transaction reverses an earlier transaction. */ diff --git a/lib/Tax/TransactionLineItem.php b/lib/Tax/TransactionLineItem.php index 30d19f9ef..f1d7e843d 100644 --- a/lib/Tax/TransactionLineItem.php +++ b/lib/Tax/TransactionLineItem.php @@ -10,11 +10,11 @@ * @property int $amount The line item amount in the smallest currency unit. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. * @property int $amount_tax The amount of tax calculated for this line item, in the smallest currency unit. * @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 null|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|\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 $product The ID of an existing Product. * @property int $quantity The number of units of the item being purchased. For reversals, this is the quantity reversed. * @property string $reference A custom identifier for this line item in the transaction. - * @property null|object{original_line_item: string}&\Stripe\StripeObject&\stdClass $reversal If type=reversal, contains information about what was reversed. + * @property null|(object{original_line_item: string}&\Stripe\StripeObject&\stdClass) $reversal If type=reversal, contains information about what was reversed. * @property string $tax_behavior Specifies whether the amount includes taxes. If tax_behavior=inclusive, then the amount includes taxes. * @property string $tax_code The tax code ID used for this resource. * @property string $type If reversal, this line item reverses an earlier transaction. diff --git a/lib/TaxId.php b/lib/TaxId.php index 523ac05f0..8cea58379 100644 --- a/lib/TaxId.php +++ b/lib/TaxId.php @@ -16,10 +16,10 @@ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string|\Stripe\Customer $customer ID of 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 null|object{account?: string|\Stripe\Account, application?: string|\Stripe\Application, customer?: string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass $owner The account or customer the tax ID belongs to. + * @property null|(object{account?: string|\Stripe\Account, application?: string|\Stripe\Application, customer?: string|\Stripe\Customer, type: string}&\Stripe\StripeObject&\stdClass) $owner The account or customer the tax ID belongs to. * @property string $type Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, li_vat, ma_vat, md_vat, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, tz_vat, ua_vat, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, or za_vat. Note that some legacy tax IDs have type unknown * @property string $value Value of the tax ID. - * @property null|object{status: string, verified_address: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass $verification Tax ID verification information. + * @property null|(object{status: string, verified_address: null|string, verified_name: null|string}&\Stripe\StripeObject&\stdClass) $verification Tax ID verification information. */ class TaxId extends ApiResource { @@ -133,7 +133,7 @@ public static function create($params = null, $options = null) /** * Deletes an existing account or customer tax_id object. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/TaxRate.php b/lib/TaxRate.php index 9cdacacc7..b2bcf012a 100644 --- a/lib/TaxRate.php +++ b/lib/TaxRate.php @@ -17,12 +17,12 @@ * @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 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 null|object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass $flat_amount The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate. + * @property null|(object{amount: int, currency: string}&\Stripe\StripeObject&\stdClass) $flat_amount The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate. * @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 null|string $jurisdiction_level The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. * @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 null|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|\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 Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. * @property null|string $rate_type Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. * @property null|string $state ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States. @@ -122,7 +122,7 @@ public static function retrieve($id, $opts = null) * Updates an existing tax rate. * * @param string $id the ID of the resource to update - * @param null|array{active?: bool, country?: string, description?: string, display_name?: string, expand?: string[], jurisdiction?: string, metadata?: null|StripeObject, state?: string, tax_type?: string} $params + * @param null|array{active?: bool, country?: string, description?: string, display_name?: string, expand?: string[], jurisdiction?: string, metadata?: null|\Stripe\StripeObject, state?: string, tax_type?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Terminal/Configuration.php b/lib/Terminal/Configuration.php index e79614d31..bf511cb96 100644 --- a/lib/Terminal/Configuration.php +++ b/lib/Terminal/Configuration.php @@ -9,15 +9,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 null|object{splashscreen?: string|\Stripe\File}&\Stripe\StripeObject&\stdClass $bbpos_wisepos_e + * @property null|(object{splashscreen?: string|\Stripe\File}&\Stripe\StripeObject&\stdClass) $bbpos_wisepos_e * @property null|bool $is_account_default Whether this Configuration is the default for your account * @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 null|string $name String indicating the name of the Configuration object, set by the user - * @property object{enabled: null|bool}&\Stripe\StripeObject&\stdClass $offline - * @property null|object{end_hour: int, start_hour: int}&\Stripe\StripeObject&\stdClass $reboot_window - * @property null|object{splashscreen?: string|\Stripe\File}&\Stripe\StripeObject&\stdClass $stripe_s700 - * @property object{aud?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, cad?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, chf?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, czk?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, dkk?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, eur?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, gbp?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, hkd?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, myr?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, nok?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, nzd?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, pln?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, sek?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, sgd?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass, usd?: object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $tipping - * @property null|object{splashscreen?: string|\Stripe\File}&\Stripe\StripeObject&\stdClass $verifone_p400 + * @property (object{enabled: null|bool}&\Stripe\StripeObject&\stdClass) $offline + * @property null|(object{end_hour: int, start_hour: int}&\Stripe\StripeObject&\stdClass) $reboot_window + * @property null|(object{splashscreen?: string|\Stripe\File}&\Stripe\StripeObject&\stdClass) $stripe_s700 + * @property (object{aud?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), cad?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), chf?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), czk?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), dkk?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), eur?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), gbp?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), hkd?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), myr?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), nok?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), nzd?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), pln?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), sek?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), sgd?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass), usd?: (object{fixed_amounts?: null|int[], percentages?: null|int[], smart_tip_threshold?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $tipping + * @property null|(object{splashscreen?: string|\Stripe\File}&\Stripe\StripeObject&\stdClass) $verifone_p400 */ class Configuration extends \Stripe\ApiResource { @@ -50,7 +50,7 @@ public static function create($params = null, $options = null) /** * Deletes a Configuration object. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Terminal/Location.php b/lib/Terminal/Location.php index 0bbbd1f6d..e133c5d4e 100644 --- a/lib/Terminal/Location.php +++ b/lib/Terminal/Location.php @@ -11,7 +11,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 object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass $address + * @property (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass) $address * @property null|string $configuration_overrides The ID of a configuration that will be used to customize all readers in this location. * @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. @@ -28,7 +28,7 @@ class Location extends \Stripe\ApiResource * address fields are required in each country, see the Manage locations guide. * - * @param null|array{address: array{city?: string, country: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: string, display_name: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{address: array{city?: string, country: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: string, display_name: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -50,7 +50,7 @@ public static function create($params = null, $options = null) /** * Deletes a Location object. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -109,7 +109,7 @@ public static function retrieve($id, $opts = null) * passed. Any parameters not provided will be left unchanged. * * @param string $id the ID of the resource to update - * @param null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: null|string, display_name?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: null|string, display_name?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Terminal/Reader.php b/lib/Terminal/Reader.php index aeea38fca..198e8d77a 100644 --- a/lib/Terminal/Reader.php +++ b/lib/Terminal/Reader.php @@ -11,7 +11,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|object{collect_inputs?: object{inputs: (object{custom_text: null|object{description: null|string, skip_button: null|string, submit_button: null|string, title: null|string}&\Stripe\StripeObject&\stdClass, email?: object{value: null|string}&\Stripe\StripeObject&\stdClass, numeric?: object{value: null|string}&\Stripe\StripeObject&\stdClass, phone?: object{value: null|string}&\Stripe\StripeObject&\stdClass, required: null|bool, selection?: object{choices: (object{style: null|string, value: string}&\Stripe\StripeObject&\stdClass)[], value: null|string}&\Stripe\StripeObject&\stdClass, signature?: object{value: null|string}&\Stripe\StripeObject&\stdClass, skipped?: bool, text?: object{value: null|string}&\Stripe\StripeObject&\stdClass, toggles: null|(object{default_value: null|string, description: null|string, title: null|string, value: null|string}&\Stripe\StripeObject&\stdClass)[], type: string}&\Stripe\StripeObject&\stdClass)[], metadata: null|StripeObject}&\Stripe\StripeObject&\stdClass, collect_payment_method?: object{collect_config?: object{enable_customer_cancellation?: bool, skip_tipping?: bool, tipping?: object{amount_eligible?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, payment_intent: string|\Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, stripe_account?: string}&\Stripe\StripeObject&\stdClass, confirm_payment_intent?: object{payment_intent: string|\Stripe\PaymentIntent, stripe_account?: string}&\Stripe\StripeObject&\stdClass, failure_code: null|string, failure_message: null|string, process_payment_intent?: object{payment_intent: string|\Stripe\PaymentIntent, process_config?: object{enable_customer_cancellation?: bool, skip_tipping?: bool, tipping?: object{amount_eligible?: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass, stripe_account?: string}&\Stripe\StripeObject&\stdClass, process_setup_intent?: object{generated_card?: string, process_config?: object{enable_customer_cancellation?: bool}&\Stripe\StripeObject&\stdClass, setup_intent: string|\Stripe\SetupIntent}&\Stripe\StripeObject&\stdClass, refund_payment?: object{amount?: int, charge?: string|\Stripe\Charge, metadata?: \Stripe\StripeObject, payment_intent?: string|\Stripe\PaymentIntent, reason?: string, refund?: string|\Stripe\Refund, refund_application_fee?: bool, refund_payment_config?: object{enable_customer_cancellation?: bool}&\Stripe\StripeObject&\stdClass, reverse_transfer?: bool, stripe_account?: string}&\Stripe\StripeObject&\stdClass, set_reader_display?: object{cart: null|object{currency: string, line_items: object{amount: int, description: string, quantity: int}&\Stripe\StripeObject&\stdClass[], tax: null|int, total: int}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass, status: string, type: string}&\Stripe\StripeObject&\stdClass $action The most recent action performed by the reader. + * @property null|(object{collect_inputs?: (object{inputs: ((object{custom_text: null|(object{description: null|string, skip_button: null|string, submit_button: null|string, title: null|string}&\Stripe\StripeObject&\stdClass), email?: (object{value: null|string}&\Stripe\StripeObject&\stdClass), numeric?: (object{value: null|string}&\Stripe\StripeObject&\stdClass), phone?: (object{value: null|string}&\Stripe\StripeObject&\stdClass), required: null|bool, selection?: (object{choices: ((object{style: null|string, value: string}&\Stripe\StripeObject&\stdClass))[], value: null|string}&\Stripe\StripeObject&\stdClass), signature?: (object{value: null|string}&\Stripe\StripeObject&\stdClass), skipped?: bool, text?: (object{value: null|string}&\Stripe\StripeObject&\stdClass), toggles: null|((object{default_value: null|string, description: null|string, title: null|string, value: null|string}&\Stripe\StripeObject&\stdClass))[], type: string}&\Stripe\StripeObject&\stdClass))[], metadata: null|\Stripe\StripeObject}&\Stripe\StripeObject&\stdClass), collect_payment_method?: (object{collect_config?: (object{enable_customer_cancellation?: bool, skip_tipping?: bool, tipping?: (object{amount_eligible?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), payment_intent: string|\Stripe\PaymentIntent, payment_method?: \Stripe\PaymentMethod, stripe_account?: string}&\Stripe\StripeObject&\stdClass), confirm_payment_intent?: (object{payment_intent: string|\Stripe\PaymentIntent, stripe_account?: string}&\Stripe\StripeObject&\stdClass), failure_code: null|string, failure_message: null|string, process_payment_intent?: (object{payment_intent: string|\Stripe\PaymentIntent, process_config?: (object{enable_customer_cancellation?: bool, skip_tipping?: bool, tipping?: (object{amount_eligible?: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass), stripe_account?: string}&\Stripe\StripeObject&\stdClass), process_setup_intent?: (object{generated_card?: string, process_config?: (object{enable_customer_cancellation?: bool}&\Stripe\StripeObject&\stdClass), setup_intent: string|\Stripe\SetupIntent}&\Stripe\StripeObject&\stdClass), refund_payment?: (object{amount?: int, charge?: string|\Stripe\Charge, metadata?: \Stripe\StripeObject, payment_intent?: string|\Stripe\PaymentIntent, reason?: string, refund?: string|\Stripe\Refund, refund_application_fee?: bool, refund_payment_config?: (object{enable_customer_cancellation?: bool}&\Stripe\StripeObject&\stdClass), reverse_transfer?: bool, stripe_account?: string}&\Stripe\StripeObject&\stdClass), set_reader_display?: (object{cart: null|(object{currency: string, line_items: (object{amount: int, description: string, quantity: int}&\Stripe\StripeObject&\stdClass)[], tax: null|int, total: int}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass), status: string, type: string}&\Stripe\StripeObject&\stdClass) $action The most recent action performed by the reader. * @property null|string $device_sw_version The current software version of the reader. * @property string $device_type Type of reader, one of bbpos_wisepad3, stripe_m2, stripe_s700, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, simulated_wisepos_e, or mobile_phone_reader. * @property null|string $ip_address The local IP address of the reader. @@ -43,7 +43,7 @@ class Reader extends \Stripe\ApiResource /** * Creates a new Reader object. * - * @param null|array{expand?: string[], label?: string, location?: string, metadata?: null|StripeObject, registration_code: string} $params + * @param null|array{expand?: string[], label?: string, location?: string, metadata?: null|\Stripe\StripeObject, registration_code: string} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -65,7 +65,7 @@ public static function create($params = null, $options = null) /** * Deletes a Reader object. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -124,7 +124,7 @@ public static function retrieve($id, $opts = null) * passed. Any parameters not provided will be left unchanged. * * @param string $id the ID of the resource to update - * @param null|array{expand?: string[], label?: null|string, metadata?: null|StripeObject} $params + * @param null|array{expand?: string[], label?: null|string, metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Terminal/ReaderCollectedData.php b/lib/Terminal/ReaderCollectedData.php index 4d996c56a..6c4f0d3b2 100644 --- a/lib/Terminal/ReaderCollectedData.php +++ b/lib/Terminal/ReaderCollectedData.php @@ -11,7 +11,7 @@ * @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 $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode. - * @property null|object{data: null|string}&\Stripe\StripeObject&\stdClass $magstripe The magstripe data collected by the reader. + * @property null|(object{data: null|string}&\Stripe\StripeObject&\stdClass) $magstripe The magstripe data collected by the reader. * @property string $type The type of data collected by the reader. */ class ReaderCollectedData extends \Stripe\ApiResource diff --git a/lib/TestHelpers/TestClock.php b/lib/TestHelpers/TestClock.php index 79008238a..163c9bb73 100644 --- a/lib/TestHelpers/TestClock.php +++ b/lib/TestHelpers/TestClock.php @@ -17,7 +17,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 null|string $name The custom name supplied at creation. * @property string $status The status of the Test Clock. - * @property object{advancing?: object{target_frozen_time: int}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $status_details + * @property (object{advancing?: (object{target_frozen_time: int}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $status_details */ class TestClock extends \Stripe\ApiResource { @@ -52,7 +52,7 @@ public static function create($params = null, $options = null) /** * Deletes a test clock. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Token.php b/lib/Token.php index e4bd4b461..0b4902346 100644 --- a/lib/Token.php +++ b/lib/Token.php @@ -53,7 +53,7 @@ class Token extends ApiResource * href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection * is application, which includes Custom accounts. * - * @param null|array{account?: array{business_type?: string, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, ownership_declaration_shown_and_signed?: bool, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, tos_shown_and_accepted?: bool}, bank_account?: array{account_holder_name?: string, account_holder_type?: string, account_number: string, account_type?: string, country: string, currency?: string, payment_method?: string, routing_number?: string}, card?: string|array, customer?: string, cvc_update?: array{cvc: string}, expand?: string[], person?: array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|StripeObject, nationality?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, pii?: array{id_number?: string}} $params + * @param null|array{account?: array{business_type?: string, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, ownership_declaration_shown_and_signed?: bool, phone?: string, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, tos_shown_and_accepted?: bool}, bank_account?: array{account_holder_name?: string, account_holder_type?: string, account_number: string, account_type?: string, country: string, currency?: string, payment_method?: string, routing_number?: string}, card?: string|array, customer?: string, cvc_update?: array{cvc: string}, expand?: string[], person?: array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|\Stripe\StripeObject, nationality?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, pii?: array{id_number?: string}} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Topup.php b/lib/Topup.php index c5ea2fcaf..47468355f 100644 --- a/lib/Topup.php +++ b/lib/Topup.php @@ -43,7 +43,7 @@ class Topup extends ApiResource /** * Top up the balance of an account. * - * @param null|array{amount: int, currency: string, description?: string, expand?: string[], metadata?: null|StripeObject, source?: string, statement_descriptor?: string, transfer_group?: string} $params + * @param null|array{amount: int, currency: string, description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, source?: string, statement_descriptor?: string, transfer_group?: string} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -105,7 +105,7 @@ public static function retrieve($id, $opts = null) * design. * * @param string $id the ID of the resource to update - * @param null|array{description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/Transfer.php b/lib/Transfer.php index 26d54146a..d0ffdc5f9 100644 --- a/lib/Transfer.php +++ b/lib/Transfer.php @@ -116,7 +116,7 @@ public static function retrieve($id, $opts = null) * This request accepts only metadata as an argument. * * @param string $id the ID of the resource to update - * @param null|array{description?: string, expand?: string[], metadata?: null|StripeObject} $params + * @param null|array{description?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails diff --git a/lib/TransferReversal.php b/lib/TransferReversal.php index 88c97149d..36e8ebe47 100644 --- a/lib/TransferReversal.php +++ b/lib/TransferReversal.php @@ -26,7 +26,7 @@ * @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|\Stripe\Refund $destination_payment_refund Linked payment refund for the transfer reversal. - * @property null|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|\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|\Stripe\Refund $source_refund ID of the refund responsible for the transfer reversal. * @property string|\Stripe\Transfer $transfer ID of the transfer that was reversed. */ diff --git a/lib/Treasury/CreditReversal.php b/lib/Treasury/CreditReversal.php index 735f7f190..7823b5215 100644 --- a/lib/Treasury/CreditReversal.php +++ b/lib/Treasury/CreditReversal.php @@ -19,7 +19,7 @@ * @property string $network The rails used to reverse the funds. * @property string $received_credit The ReceivedCredit being reversed. * @property string $status Status of the CreditReversal - * @property object{posted_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{posted_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. */ class CreditReversal extends \Stripe\ApiResource diff --git a/lib/Treasury/DebitReversal.php b/lib/Treasury/DebitReversal.php index e26f1fc90..bdfd85ba7 100644 --- a/lib/Treasury/DebitReversal.php +++ b/lib/Treasury/DebitReversal.php @@ -14,13 +14,13 @@ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property null|string $financial_account The FinancialAccount to reverse funds from. * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - * @property null|object{issuing_dispute: null|string}&\Stripe\StripeObject&\stdClass $linked_flows Other flows linked to a DebitReversal. + * @property null|(object{issuing_dispute: null|string}&\Stripe\StripeObject&\stdClass) $linked_flows Other flows linked to a DebitReversal. * @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 $network The rails used to reverse the funds. * @property string $received_debit The ReceivedDebit being reversed. * @property string $status Status of the DebitReversal - * @property object{completed_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{completed_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. */ class DebitReversal extends \Stripe\ApiResource diff --git a/lib/Treasury/FinancialAccount.php b/lib/Treasury/FinancialAccount.php index b5d996e2a..cedf005bc 100644 --- a/lib/Treasury/FinancialAccount.php +++ b/lib/Treasury/FinancialAccount.php @@ -11,19 +11,19 @@ * @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|string[] $active_features The array of paths to active Features in the Features hash. - * @property object{cash: \Stripe\StripeObject, inbound_pending: \Stripe\StripeObject, outbound_pending: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass $balance Balance information for the FinancialAccount + * @property (object{cash: \Stripe\StripeObject, inbound_pending: \Stripe\StripeObject, outbound_pending: \Stripe\StripeObject}&\Stripe\StripeObject&\stdClass) $balance Balance information for the FinancialAccount * @property string $country Two-letter country code (ISO 3166-1 alpha-2). * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $display_name The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the nickname field, display_name is not internal metadata and will be exposed to connected accounts. * @property null|\Stripe\Treasury\FinancialAccountFeatures $features Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field. - * @property (object{aba?: object{account_holder_name: string, account_number?: null|string, account_number_last4: string, bank_name: string, routing_number: string}&\Stripe\StripeObject&\stdClass, supported_networks?: string[], type: string}&\Stripe\StripeObject&\stdClass)[] $financial_addresses The set of credentials that resolve to a FinancialAccount. + * @property ((object{aba?: (object{account_holder_name: string, account_number?: null|string, account_number_last4: string, bank_name: string, routing_number: string}&\Stripe\StripeObject&\stdClass), supported_networks?: string[], type: string}&\Stripe\StripeObject&\stdClass))[] $financial_addresses The set of credentials that resolve to a FinancialAccount. * @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 null|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|\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[] $pending_features The array of paths to pending Features in the Features hash. - * @property null|object{inbound_flows: null|string, outbound_flows: null|string}&\Stripe\StripeObject&\stdClass $platform_restrictions The set of functionalities that the platform can restrict on the FinancialAccount. + * @property null|(object{inbound_flows: null|string, outbound_flows: null|string}&\Stripe\StripeObject&\stdClass) $platform_restrictions The set of functionalities that the platform can restrict on the FinancialAccount. * @property null|string[] $restricted_features The array of paths to restricted Features in the Features hash. * @property string $status Status of this FinancialAccount. - * @property object{closed: null|object{reasons: string[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $status_details + * @property (object{closed: null|(object{reasons: string[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $status_details * @property string[] $supported_currencies The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase. */ class FinancialAccount extends \Stripe\ApiResource diff --git a/lib/Treasury/FinancialAccountFeatures.php b/lib/Treasury/FinancialAccountFeatures.php index 9f5ec2783..00b5af0cc 100644 --- a/lib/Treasury/FinancialAccountFeatures.php +++ b/lib/Treasury/FinancialAccountFeatures.php @@ -9,13 +9,13 @@ * Stripe or the platform can control Features via the requested field. * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $card_issuing Toggle settings for enabling/disabling a feature - * @property object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $deposit_insurance Toggle settings for enabling/disabling a feature - * @property object{aba?: object{bank?: string, requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $financial_addresses Settings related to Financial Addresses features on a Financial Account - * @property object{ach?: object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $inbound_transfers InboundTransfers contains inbound transfers features for a FinancialAccount. - * @property object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass $intra_stripe_flows Toggle settings for enabling/disabling a feature - * @property object{ach?: object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass, us_domestic_wire?: object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $outbound_payments Settings related to Outbound Payments features on a Financial Account - * @property object{ach?: object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass, us_domestic_wire?: object{requested: bool, status: string, status_details: (object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass)[]}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $outbound_transfers OutboundTransfers contains outbound transfers features for a FinancialAccount. + * @property (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $card_issuing Toggle settings for enabling/disabling a feature + * @property (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $deposit_insurance Toggle settings for enabling/disabling a feature + * @property (object{aba?: (object{bank?: string, requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $financial_addresses Settings related to Financial Addresses features on a Financial Account + * @property (object{ach?: (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $inbound_transfers InboundTransfers contains inbound transfers features for a FinancialAccount. + * @property (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass) $intra_stripe_flows Toggle settings for enabling/disabling a feature + * @property (object{ach?: (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass), us_domestic_wire?: (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $outbound_payments Settings related to Outbound Payments features on a Financial Account + * @property (object{ach?: (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass), us_domestic_wire?: (object{requested: bool, status: string, status_details: ((object{code: string, resolution: null|string, restriction?: string}&\Stripe\StripeObject&\stdClass))[]}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $outbound_transfers OutboundTransfers contains outbound transfers features for a FinancialAccount. */ class FinancialAccountFeatures extends \Stripe\ApiResource { diff --git a/lib/Treasury/InboundTransfer.php b/lib/Treasury/InboundTransfer.php index 6711fca4b..9df131b17 100644 --- a/lib/Treasury/InboundTransfer.php +++ b/lib/Treasury/InboundTransfer.php @@ -16,18 +16,18 @@ * @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|object{code: string}&\Stripe\StripeObject&\stdClass $failure_details Details about this InboundTransfer's failure. Only set when status is failed. + * @property null|(object{code: string}&\Stripe\StripeObject&\stdClass) $failure_details Details about this InboundTransfer's failure. Only set when status is failed. * @property string $financial_account The FinancialAccount that received the funds. * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - * @property object{received_debit: null|string}&\Stripe\StripeObject&\stdClass $linked_flows + * @property (object{received_debit: null|string}&\Stripe\StripeObject&\stdClass) $linked_flows * @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 null|string $origin_payment_method The origin payment method to be debited for an InboundTransfer. - * @property null|object{billing_details: object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass, type: string, us_bank_account?: object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, network: string, routing_number: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $origin_payment_method_details Details about the PaymentMethod for an InboundTransfer. + * @property null|(object{billing_details: (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass), type: string, us_bank_account?: (object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, network: string, routing_number: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $origin_payment_method_details Details about the PaymentMethod for an InboundTransfer. * @property null|bool $returned Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state. * @property string $statement_descriptor Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor. * @property string $status Status of the InboundTransfer: processing, succeeded, failed, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been "confirmed" and a transaction is created and posted. The status changes to failed if the transfer fails. - * @property object{canceled_at?: null|int, failed_at: null|int, succeeded_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{canceled_at?: null|int, failed_at: null|int, succeeded_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. */ class InboundTransfer extends \Stripe\ApiResource diff --git a/lib/Treasury/OutboundPayment.php b/lib/Treasury/OutboundPayment.php index ffef2712f..ba830f5b3 100644 --- a/lib/Treasury/OutboundPayment.php +++ b/lib/Treasury/OutboundPayment.php @@ -20,18 +20,18 @@ * @property null|string $customer ID of the customer to whom an OutboundPayment is sent. * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. * @property null|string $destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data. - * @property null|object{billing_details: object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass, financial_account?: object{id: string, network: string}&\Stripe\StripeObject&\stdClass, type: string, us_bank_account?: object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, network: string, routing_number: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment. - * @property null|object{ip_address: null|string, present: bool}&\Stripe\StripeObject&\stdClass $end_user_details Details about the end user. + * @property null|(object{billing_details: (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass), financial_account?: (object{id: string, network: string}&\Stripe\StripeObject&\stdClass), type: string, us_bank_account?: (object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, network: string, routing_number: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment. + * @property null|(object{ip_address: null|string, present: bool}&\Stripe\StripeObject&\stdClass) $end_user_details Details about the end user. * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account. * @property string $financial_account The FinancialAccount that funds were pulled from. * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. * @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 null|object{code: string, transaction: string|\Stripe\Treasury\Transaction}&\Stripe\StripeObject&\stdClass $returned_details Details about a returned OutboundPayment. Only set when the status is returned. + * @property null|(object{code: string, transaction: string|\Stripe\Treasury\Transaction}&\Stripe\StripeObject&\stdClass) $returned_details Details about a returned OutboundPayment. Only set when the status is returned. * @property string $statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). * @property string $status Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned. - * @property object{canceled_at: null|int, failed_at: null|int, posted_at: null|int, returned_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions - * @property null|object{ach?: object{trace_id: string}&\Stripe\StripeObject&\stdClass, type: string, us_domestic_wire?: object{chips: null|string, imad: null|string, omad: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $tracking_details Details about network-specific tracking information if available. + * @property (object{canceled_at: null|int, failed_at: null|int, posted_at: null|int, returned_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions + * @property null|(object{ach?: (object{trace_id: string}&\Stripe\StripeObject&\stdClass), type: string, us_domestic_wire?: (object{chips: null|string, imad: null|string, omad: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $tracking_details Details about network-specific tracking information if available. * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. */ class OutboundPayment extends \Stripe\ApiResource diff --git a/lib/Treasury/OutboundTransfer.php b/lib/Treasury/OutboundTransfer.php index 6c4914a74..aa6bd7204 100644 --- a/lib/Treasury/OutboundTransfer.php +++ b/lib/Treasury/OutboundTransfer.php @@ -19,18 +19,18 @@ * @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|string $destination_payment_method The PaymentMethod used as the payment instrument for an OutboundTransfer. - * @property object{billing_details: object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass, type: string, us_bank_account?: object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, network: string, routing_number: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $destination_payment_method_details + * @property (object{billing_details: (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass), type: string, us_bank_account?: (object{account_holder_type: null|string, account_type: null|string, bank_name: null|string, fingerprint: null|string, last4: null|string, mandate?: string|\Stripe\Mandate, network: string, routing_number: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $destination_payment_method_details * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account. * @property string $financial_account The FinancialAccount that funds were pulled from. * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. * @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 null|object{ach?: null|object{addenda: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $network_details Details about the network used for the OutboundTransfer. - * @property null|object{code: string, transaction: string|\Stripe\Treasury\Transaction}&\Stripe\StripeObject&\stdClass $returned_details Details about a returned OutboundTransfer. Only set when the status is returned. + * @property null|(object{ach?: null|(object{addenda: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $network_details Details about the network used for the OutboundTransfer. + * @property null|(object{code: string, transaction: string|\Stripe\Treasury\Transaction}&\Stripe\StripeObject&\stdClass) $returned_details Details about a returned OutboundTransfer. Only set when the status is returned. * @property string $statement_descriptor Information about the OutboundTransfer to be sent to the recipient account. * @property string $status Current status of the OutboundTransfer: processing, failed, canceled, posted, returned. An OutboundTransfer is processing if it has been created and is pending. The status changes to posted once the OutboundTransfer has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundTransfer fails to arrive at its destination, its status will change to returned. - * @property object{canceled_at: null|int, failed_at: null|int, posted_at: null|int, returned_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions - * @property null|object{ach?: object{trace_id: string}&\Stripe\StripeObject&\stdClass, type: string, us_domestic_wire?: object{chips: null|string, imad: null|string, omad: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $tracking_details Details about network-specific tracking information if available. + * @property (object{canceled_at: null|int, failed_at: null|int, posted_at: null|int, returned_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions + * @property null|(object{ach?: (object{trace_id: string}&\Stripe\StripeObject&\stdClass), type: string, us_domestic_wire?: (object{chips: null|string, imad: null|string, omad: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $tracking_details Details about network-specific tracking information if available. * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. */ class OutboundTransfer extends \Stripe\ApiResource diff --git a/lib/Treasury/ReceivedCredit.php b/lib/Treasury/ReceivedCredit.php index 4a4ed3010..cfd37afe6 100644 --- a/lib/Treasury/ReceivedCredit.php +++ b/lib/Treasury/ReceivedCredit.php @@ -16,12 +16,12 @@ * @property null|string $failure_code Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. * @property null|string $financial_account The FinancialAccount that received the funds. * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - * @property object{balance?: string, billing_details: object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass, financial_account?: object{id: string, network: string}&\Stripe\StripeObject&\stdClass, issuing_card?: string, type: string, us_bank_account?: object{bank_name: null|string, last4: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $initiating_payment_method_details - * @property object{credit_reversal: null|string, issuing_authorization: null|string, issuing_transaction: null|string, source_flow: null|string, source_flow_details?: null|object{credit_reversal?: \Stripe\Treasury\CreditReversal, outbound_payment?: \Stripe\Treasury\OutboundPayment, payout?: \Stripe\Payout, type: string}&\Stripe\StripeObject&\stdClass, source_flow_type: null|string}&\Stripe\StripeObject&\stdClass $linked_flows + * @property (object{balance?: string, billing_details: (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass), financial_account?: (object{id: string, network: string}&\Stripe\StripeObject&\stdClass), issuing_card?: string, type: string, us_bank_account?: (object{bank_name: null|string, last4: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $initiating_payment_method_details + * @property (object{credit_reversal: null|string, issuing_authorization: null|string, issuing_transaction: null|string, source_flow: null|string, source_flow_details?: null|(object{credit_reversal?: \Stripe\Treasury\CreditReversal, outbound_payment?: \Stripe\Treasury\OutboundPayment, payout?: \Stripe\Payout, type: string}&\Stripe\StripeObject&\stdClass), source_flow_type: null|string}&\Stripe\StripeObject&\stdClass) $linked_flows * @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 $network The rails used to send the funds. - * @property null|object{ach?: null|object{addenda: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $network_details Details specific to the money movement rails. - * @property null|object{deadline: null|int, restricted_reason: null|string}&\Stripe\StripeObject&\stdClass $reversal_details Details describing when a ReceivedCredit may be reversed. + * @property null|(object{ach?: null|(object{addenda: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $network_details Details specific to the money movement rails. + * @property null|(object{deadline: null|int, restricted_reason: null|string}&\Stripe\StripeObject&\stdClass) $reversal_details Details describing when a ReceivedCredit may be reversed. * @property string $status Status of the ReceivedCredit. ReceivedCredits are created either succeeded (approved) or failed (declined). If a ReceivedCredit is declined, the failure reason can be found in the failure_code field. * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. */ diff --git a/lib/Treasury/ReceivedDebit.php b/lib/Treasury/ReceivedDebit.php index b95339a3b..8bcea15bb 100644 --- a/lib/Treasury/ReceivedDebit.php +++ b/lib/Treasury/ReceivedDebit.php @@ -16,12 +16,12 @@ * @property null|string $failure_code Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen. * @property null|string $financial_account The FinancialAccount that funds were pulled from. * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - * @property object{balance?: string, billing_details: object{address: object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass, email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass, financial_account?: object{id: string, network: string}&\Stripe\StripeObject&\stdClass, issuing_card?: string, type: string, us_bank_account?: object{bank_name: null|string, last4: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $initiating_payment_method_details - * @property object{debit_reversal: null|string, inbound_transfer: null|string, issuing_authorization: null|string, issuing_transaction: null|string, payout: null|string, received_credit_capital_withholding?: null|string}&\Stripe\StripeObject&\stdClass $linked_flows + * @property (object{balance?: string, billing_details: (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\Stripe\StripeObject&\stdClass), email: null|string, name: null|string}&\Stripe\StripeObject&\stdClass), financial_account?: (object{id: string, network: string}&\Stripe\StripeObject&\stdClass), issuing_card?: string, type: string, us_bank_account?: (object{bank_name: null|string, last4: null|string, routing_number: null|string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $initiating_payment_method_details + * @property (object{debit_reversal: null|string, inbound_transfer: null|string, issuing_authorization: null|string, issuing_transaction: null|string, payout: null|string, received_credit_capital_withholding?: null|string}&\Stripe\StripeObject&\stdClass) $linked_flows * @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 $network The network used for the ReceivedDebit. - * @property null|object{ach?: null|object{addenda: null|string}&\Stripe\StripeObject&\stdClass, type: string}&\Stripe\StripeObject&\stdClass $network_details Details specific to the money movement rails. - * @property null|object{deadline: null|int, restricted_reason: null|string}&\Stripe\StripeObject&\stdClass $reversal_details Details describing when a ReceivedDebit might be reversed. + * @property null|(object{ach?: null|(object{addenda: null|string}&\Stripe\StripeObject&\stdClass), type: string}&\Stripe\StripeObject&\stdClass) $network_details Details specific to the money movement rails. + * @property null|(object{deadline: null|int, restricted_reason: null|string}&\Stripe\StripeObject&\stdClass) $reversal_details Details describing when a ReceivedDebit might be reversed. * @property string $status Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code. * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. */ diff --git a/lib/Treasury/Transaction.php b/lib/Treasury/Transaction.php index dd287894e..24a7c645e 100644 --- a/lib/Treasury/Transaction.php +++ b/lib/Treasury/Transaction.php @@ -10,18 +10,18 @@ * @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 cents) transferred. - * @property object{cash: int, inbound_pending: int, outbound_pending: int}&\Stripe\StripeObject&\stdClass $balance_impact Change to a FinancialAccount's balance + * @property (object{cash: int, inbound_pending: int, outbound_pending: int}&\Stripe\StripeObject&\stdClass) $balance_impact Change to a FinancialAccount's 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 $description An arbitrary string attached to the object. Often useful for displaying to users. - * @property null|Collection<\Stripe\Treasury\TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. + * @property null|\Stripe\Collection<\Stripe\Treasury\TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. * @property string $financial_account The FinancialAccount associated with this object. * @property null|string $flow ID of the flow that created the Transaction. - * @property null|object{credit_reversal?: \Stripe\Treasury\CreditReversal, debit_reversal?: \Stripe\Treasury\DebitReversal, inbound_transfer?: \Stripe\Treasury\InboundTransfer, issuing_authorization?: \Stripe\Issuing\Authorization, outbound_payment?: \Stripe\Treasury\OutboundPayment, outbound_transfer?: \Stripe\Treasury\OutboundTransfer, received_credit?: \Stripe\Treasury\ReceivedCredit, received_debit?: \Stripe\Treasury\ReceivedDebit, type: string}&\Stripe\StripeObject&\stdClass $flow_details Details of the flow that created the Transaction. + * @property null|(object{credit_reversal?: \Stripe\Treasury\CreditReversal, debit_reversal?: \Stripe\Treasury\DebitReversal, inbound_transfer?: \Stripe\Treasury\InboundTransfer, issuing_authorization?: \Stripe\Issuing\Authorization, outbound_payment?: \Stripe\Treasury\OutboundPayment, outbound_transfer?: \Stripe\Treasury\OutboundTransfer, received_credit?: \Stripe\Treasury\ReceivedCredit, received_debit?: \Stripe\Treasury\ReceivedDebit, type: string}&\Stripe\StripeObject&\stdClass) $flow_details Details of the flow that created the Transaction. * @property string $flow_type Type of the flow that created the Transaction. * @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 $status Status of the Transaction. - * @property object{posted_at: null|int, void_at: null|int}&\Stripe\StripeObject&\stdClass $status_transitions + * @property (object{posted_at: null|int, void_at: null|int}&\Stripe\StripeObject&\stdClass) $status_transitions */ class Transaction extends \Stripe\ApiResource { diff --git a/lib/Treasury/TransactionEntry.php b/lib/Treasury/TransactionEntry.php index a6854b234..8b94eec2b 100644 --- a/lib/Treasury/TransactionEntry.php +++ b/lib/Treasury/TransactionEntry.php @@ -9,13 +9,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 object{cash: int, inbound_pending: int, outbound_pending: int}&\Stripe\StripeObject&\stdClass $balance_impact Change to a FinancialAccount's balance + * @property (object{cash: int, inbound_pending: int, outbound_pending: int}&\Stripe\StripeObject&\stdClass) $balance_impact Change to a FinancialAccount's 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 int $effective_at When the TransactionEntry will impact the FinancialAccount's balance. * @property string $financial_account The FinancialAccount associated with this object. * @property null|string $flow Token of the flow associated with the TransactionEntry. - * @property null|object{credit_reversal?: \Stripe\Treasury\CreditReversal, debit_reversal?: \Stripe\Treasury\DebitReversal, inbound_transfer?: \Stripe\Treasury\InboundTransfer, issuing_authorization?: \Stripe\Issuing\Authorization, outbound_payment?: \Stripe\Treasury\OutboundPayment, outbound_transfer?: \Stripe\Treasury\OutboundTransfer, received_credit?: \Stripe\Treasury\ReceivedCredit, received_debit?: \Stripe\Treasury\ReceivedDebit, type: string}&\Stripe\StripeObject&\stdClass $flow_details Details of the flow associated with the TransactionEntry. + * @property null|(object{credit_reversal?: \Stripe\Treasury\CreditReversal, debit_reversal?: \Stripe\Treasury\DebitReversal, inbound_transfer?: \Stripe\Treasury\InboundTransfer, issuing_authorization?: \Stripe\Issuing\Authorization, outbound_payment?: \Stripe\Treasury\OutboundPayment, outbound_transfer?: \Stripe\Treasury\OutboundTransfer, received_credit?: \Stripe\Treasury\ReceivedCredit, received_debit?: \Stripe\Treasury\ReceivedDebit, type: string}&\Stripe\StripeObject&\stdClass) $flow_details Details of the flow associated with the TransactionEntry. * @property string $flow_type Type of the flow associated with the TransactionEntry. * @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\Treasury\Transaction $transaction The Transaction associated with this object. diff --git a/lib/UsageRecordSummary.php b/lib/UsageRecordSummary.php index 05ad9aa32..edafea89a 100644 --- a/lib/UsageRecordSummary.php +++ b/lib/UsageRecordSummary.php @@ -11,7 +11,7 @@ * @property string $object String representing the object's type. Objects of the same type share the same value. * @property null|string $invoice The invoice in which this usage period has been billed for. * @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 object{end: null|int, start: null|int}&\Stripe\StripeObject&\stdClass $period + * @property (object{end: null|int, start: null|int}&\Stripe\StripeObject&\stdClass) $period * @property string $subscription_item The ID of the subscription item this summary is describing. * @property int $total_usage The total usage within this usage period. */ diff --git a/lib/V2/Billing/MeterEventAdjustment.php b/lib/V2/Billing/MeterEventAdjustment.php index bc03076c8..6c63cdcb8 100644 --- a/lib/V2/Billing/MeterEventAdjustment.php +++ b/lib/V2/Billing/MeterEventAdjustment.php @@ -7,7 +7,7 @@ /** * @property string $id The unique id of this meter event adjustment. * @property string $object String representing the object's type. Objects of the same type share the same value of the object field. - * @property object{identifier: string}&\Stripe\StripeObject&\stdClass $cancel Specifies which event to cancel. + * @property (object{identifier: string}&\Stripe\StripeObject&\stdClass) $cancel Specifies which event to cancel. * @property int $created The time the adjustment was created. * @property string $event_name The name of the meter event. Corresponds with the event_name field on a meter. * @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. diff --git a/lib/V2/EventDestination.php b/lib/V2/EventDestination.php index 540abc665..166a23905 100644 --- a/lib/V2/EventDestination.php +++ b/lib/V2/EventDestination.php @@ -7,21 +7,21 @@ /** * @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 of the object field. - * @property null|object{aws_account_id: string, aws_event_source_arn: string, aws_event_source_status: string}&\Stripe\StripeObject&\stdClass $amazon_eventbridge Amazon EventBridge configuration. + * @property null|(object{aws_account_id: string, aws_event_source_arn: string, aws_event_source_status: string}&\Stripe\StripeObject&\stdClass) $amazon_eventbridge Amazon EventBridge configuration. * @property int $created Time at which the object was created. * @property string $description An optional description of what the event destination is used for. * @property string[] $enabled_events The list of events to enable for this endpoint. * @property string $event_payload Payload type of events being subscribed to. * @property null|string[] $events_from Where events should be routed from. * @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 null|StripeObject $metadata Metadata. + * @property null|\Stripe\StripeObject $metadata Metadata. * @property string $name Event destination name. * @property null|string $snapshot_api_version If using the snapshot event payload, the API version events are rendered as. * @property string $status Status. It can be set to either enabled or disabled. - * @property null|object{disabled: null|object{reason: string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $status_details Additional information about event destination status. + * @property null|(object{disabled: null|(object{reason: string}&\Stripe\StripeObject&\stdClass)}&\Stripe\StripeObject&\stdClass) $status_details Additional information about event destination status. * @property string $type Event destination type. * @property int $updated Time at which the object was last updated. - * @property null|object{signing_secret: null|string, url: null|string}&\Stripe\StripeObject&\stdClass $webhook_endpoint Webhook endpoint configuration. + * @property null|(object{signing_secret: null|string, url: null|string}&\Stripe\StripeObject&\stdClass) $webhook_endpoint Webhook endpoint configuration. */ class EventDestination extends \Stripe\ApiResource { diff --git a/lib/WebhookEndpoint.php b/lib/WebhookEndpoint.php index e5763b160..8ca592b23 100644 --- a/lib/WebhookEndpoint.php +++ b/lib/WebhookEndpoint.php @@ -43,7 +43,7 @@ class WebhookEndpoint extends ApiResource * href="https://dashboard.stripe.com/account/webhooks">webhooks settings * section of the Dashboard. * - * @param null|array{api_version?: string, connect?: bool, description?: null|string, enabled_events: string[], expand?: string[], metadata?: null|StripeObject, url: string} $params + * @param null|array{api_version?: string, connect?: bool, description?: null|string, enabled_events: string[], expand?: string[], metadata?: null|\Stripe\StripeObject, url: string} $params * @param null|array|string $options * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -67,7 +67,7 @@ public static function create($params = null, $options = null) * href="https://dashboard.stripe.com/account/webhooks">webhook endpoint * management page of the Stripe dashboard. * - * @param null|array{{}} $params + * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails @@ -126,7 +126,7 @@ public static function retrieve($id, $opts = null) * enabled_events, and the status of your endpoint. * * @param string $id the ID of the resource to update - * @param null|array{description?: null|string, disabled?: bool, enabled_events?: string[], expand?: string[], metadata?: null|StripeObject, url?: string} $params + * @param null|array{description?: null|string, disabled?: bool, enabled_events?: string[], expand?: string[], metadata?: null|\Stripe\StripeObject, url?: string} $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails