models library

Classes

Account
Account
AccountAcssDebitPayments
capability_param
AccountAddressKana
japan_address_kana_specs
AccountAnnualRevenue
AccountAnnualRevenue
AccountApplicationAuthorizedEvent
Occurs whenever a user authorizes an application. Sent to the related application only.
AccountApplicationDeauthorizedEvent
Occurs whenever a user deauthorizes an application. Sent to the related application only.
AccountBacsDebitPayments
bacs_debit_payments_specs
AccountBacsDebitPaymentsSettings
AccountBacsDebitPaymentsSettings
AccountBankAccountOwnershipVerification
documents_param
AccountBranding
branding_settings_specs
AccountBrandingSettings
AccountBrandingSettings
AccountBusinessProfile
Business information about the account.
AccountBusinessProfileAnnualRevenue
The applicant's gross annual revenue for its preceding fiscal year.
AccountBusinessProfileSupportAddress
A publicly available mailing address for sending support issues to.
AccountCapabilities
AccountCapabilities
AccountCapabilityFutureRequirements
AccountCapabilityFutureRequirements
AccountCapabilityRequirements
AccountCapabilityRequirements
AccountCardIssuing
card_issuing_settings_specs
AccountCardIssuingSettings
AccountCardIssuingSettings
AccountCardPayments
card_payments_settings_specs
AccountCardPaymentsSettings
AccountCardPaymentsSettings
AccountCompany
company_specs
AccountCreateOptions
AccountCreateOptionsBusinessProfile
business_profile_specs
AccountCreateOptionsSettings
settings_specs
AccountCreateOptionsTosAcceptance
tos_acceptance_specs
AccountDashboardSettings
AccountDashboardSettings
AccountDeclineChargeOn
AccountDeclineChargeOn
AccountDeclineOn
decline_charge_on_specs
AccountDob
date_of_birth_specs
AccountDocument
verification_document_specs
AccountDocuments
documents_specs
AccountExternalAccountCreatedEvent
Occurs whenever an external account is created.
AccountExternalAccountCreatedEventObject
AccountExternalAccountDeletedEvent
Occurs whenever an external account is deleted.
AccountExternalAccounts
ExternalAccountList
AccountExternalAccountUpdatedEvent
Occurs whenever an external account is updated.
AccountFutureRequirements
AccountFutureRequirements
AccountId
A Account ID.
AccountIndividual
individual_specs
AccountIndividualVerification
person_verification_specs
AccountInvoices
invoices_settings_specs
AccountInvoicesSettings
AccountInvoicesSettings
AccountLink
AccountLinkCollectionOptions
collection_options_params
AccountLinkCreateOptions
AccountMonthlyEstimatedRevenue
AccountMonthlyEstimatedRevenue
AccountOrId
A Account or its ID.
AccountOwnershipDeclaration
company_ownership_declaration
AccountPayments
payments_settings_specs
AccountPaymentsSettings
AccountPaymentsSettings
AccountPayouts
payout_settings_specs
AccountPayoutSettings
AccountPayoutSettings
AccountRejectOptions
AccountRelationship
individual_relationship_specs
AccountRequirements
AccountRequirements
AccountRequirementsAlternative
AccountRequirementsAlternative
AccountRequirementsError
AccountRequirementsError
AccountsAccountHolder
accountholder_params
AccountSchedule
transfer_schedule_specs
AccountsCreated
AccountsCreatedRangeQuerySpecs
range_query_specs
AccountSepaDebitPaymentsSettings
AccountSepaDebitPaymentsSettings
AccountSession
ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession
AccountSessionAccountOnboarding
account_config_param
AccountSessionComponents
account_session_create_components_param
AccountSessionCreateOptions
AccountSessionFeatures
payments_features_param
AccountSessionPaymentDetails
payments_config_param
AccountSessionPayouts
payouts_config_param
AccountSessionPayoutsFeatures
payouts_features_param
AccountSettings
Options for customizing how the account functions within Stripe.
AccountSupportAddress
address_specs
AccountTermsOfService
AccountTermsOfService
AccountTosAcceptance
AccountTOSAcceptance
AccountTreasurySettings
AccountTreasurySettings
AccountUnificationAccountController
AccountUnificationAccountController
AccountUpdatedEvent
Occurs whenever an account status or property has changed.
AccountUpdateOptions
AccountUpdateOptionsSettings
settings_specs_update
AccountVerification
verification_specs
Address
Address
ApiErrors
APIErrors
ApplePayDomain
ApplePayDomain
ApplePayDomainCreateOptions
Application
Application
ApplicationFee
PlatformFee
ApplicationFeeCreatedEvent
Occurs whenever an application fee is created on a charge.
ApplicationFeeId
A ApplicationFee ID.
ApplicationFeeOrId
A ApplicationFee or its ID.
ApplicationFeeRefundedEvent
Occurs whenever an application fee is refunded, whether from refunding a charge or from [refunding the application fee directly](#fee_refunds). This includes partial refunds.
ApplicationFeeRefunds
FeeRefundList
ApplicationFeeRefundUpdatedEvent
Occurs whenever an application fee refund is updated.
ApplicationId
A Application ID.
ApplicationOrId
A Application or its ID.
AppsSecret
SecretServiceResourceSecret
AppsSecretCreateOptions
AppsSecretDeleteWhereOptions
AuthorizationAmountDetails
amount_details_specs
AuthorizationFlight
flight_specs
AuthorizationFuel
fuel_specs
AuthorizationLodging
lodging_specs
AuthorizationMerchantData
merchant_data_specs
AuthorizationNetworkData
network_data_specs
AuthorizationPurchaseDetails
purchase_details_specs
AuthorizationReceiptItem
receipt_specs
AuthorizationSegmentsItem
flight_segment_specs
AuthorizationVerificationData
verification_data_specs
AutomaticTax
AutomaticTax
AutomaticTaxLiability
The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
Balance
Balance
BalanceAmount
BalanceAmount
BalanceAmountBySourceType
BalanceAmountBySourceType
BalanceAmountNet
BalanceAmountNet
BalanceAvailableEvent
Occurs whenever your Stripe balance has been updated (e.g., when a charge is available to be paid out). By default, Stripe automatically transfers funds in your balance to your bank account on a daily basis. This event is not fired for negative transactions.
BalanceDetail
BalanceDetail
BalanceTransaction
BalanceTransaction
BalanceTransactionId
A BalanceTransaction ID.
BalanceTransactionOrId
A BalanceTransaction or its ID.
BalanceTransactionSource
BalanceTransactionSourceId
A BalanceTransactionSource ID.
BalanceTransactionSourceOrId
A BalanceTransactionSource or its ID.
BankAccount
BankAccount
BankAccountCustomer
BankAccountCustomerId
A BankAccountCustomer ID.
BankAccountCustomerOrId
A BankAccountCustomer or its ID.
BankAccountFutureRequirements
Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
BankAccountVerifyOptions
BankConnectionsResourceAccountholder
BankConnectionsResourceAccountholder
BankConnectionsResourceBalance
BankConnectionsResourceBalance
BankConnectionsResourceBalanceApiResourceCashBalance
BankConnectionsResourceBalanceAPIResourceCashBalance
BankConnectionsResourceBalanceApiResourceCreditBalance
BankConnectionsResourceBalanceAPIResourceCreditBalance
BankConnectionsResourceBalanceRefresh
BankConnectionsResourceBalanceRefresh
BankConnectionsResourceLinkAccountSessionFilters
BankConnectionsResourceLinkAccountSessionFilters
BankConnectionsResourceOwnershipRefresh
BankConnectionsResourceOwnershipRefresh
BankConnectionsResourceTransactionRefresh
BankConnectionsResourceTransactionRefresh
BankConnectionsResourceTransactionResourceStatusTransitions
BankConnectionsResourceTransactionResourceStatusTransitions
BillingDetails
billing_details
BillingMeter
BillingMeter
BillingMeterCreateOptions
BillingMeterEvent
BillingMeterEvent
BillingMeterEventAdjustment
BillingMeterEventAdjustment
BillingMeterEventAdjustmentCreateOptions
BillingMeterEventCreateOptions
BillingMeterEventSummary
BillingMeterEventSummary
BillingMeterResourceAggregationSettings
BillingMeterResourceAggregationSettings
BillingMeterResourceBillingMeterStatusTransitions
BillingMeterResourceBillingMeterStatusTransitions
BillingMeterResourceBillingMeterValue
BillingMeterResourceBillingMeterValue
BillingMeterResourceCustomerMappingSettings
BillingMeterResourceCustomerMappingSettings
BillingMeterUpdateOptions
BillingPortalConfiguration
PortalConfiguration
BillingPortalConfigurationApplication
BillingPortalConfigurationApplicationId
A BillingPortalConfigurationApplication ID.
BillingPortalConfigurationApplicationOrId
A BillingPortalConfigurationApplication or its ID.
BillingPortalConfigurationCreatedEvent
Occurs whenever a portal configuration is created.
BillingPortalConfigurationCreateOptions
BillingPortalConfigurationId
A BillingPortalConfiguration ID.
BillingPortalConfigurationOrId
A BillingPortalConfiguration or its ID.
BillingPortalConfigurationUpdatedEvent
Occurs whenever a portal configuration is updated.
BillingPortalConfigurationUpdateOptions
BillingPortalConfigurationUpdateOptionsBusinessProfile
business_profile_update_param
BillingPortalConfigurationUpdateOptionsFeatures
features_updating_param
BillingPortalConfigurationUpdateOptionsFeaturesCustomerUpdate
customer_update_updating_param
BillingPortalConfigurationUpdateOptionsFeaturesSubscriptionCancel
subscription_cancel_updating_param
BillingPortalConfigurationUpdateOptionsFeaturesSubscriptionCancelCancellationReason
subscription_cancellation_reason_updating_param
BillingPortalConfigurationUpdateOptionsFeaturesSubscriptionUpdate
subscription_update_updating_param
BillingPortalSession
PortalSession
BillingPortalSessionCreatedEvent
Occurs whenever a portal session is created.
BillingPortalSessionCreateOptions
BillingPortalSessionFlow
Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
BillingPortalSessionFlowSubscriptionCancel
Configuration when `flow.type=subscription_cancel`.
BillingPortalSessionFlowSubscriptionCancelRetention
Specify a retention strategy to be used in the cancellation flow.
BillingPortalSessionFlowSubscriptionCancelRetentionCouponOffer
Configuration when `retention.type=coupon_offer`.
BillingPortalSessionFlowSubscriptionUpdate
Configuration when `flow.type=subscription_update`.
BillingPortalSessionFlowSubscriptionUpdateConfirm
Configuration when `flow.type=subscription_update_confirm`.
CalculationAddress
postal_address
CalculationCustomerDetails
customer_details
CalculationLineItemsItem
calculation_line_item
CalculationShippingCost
shipping_cost
CancellationDetails
CancellationDetails
Capability
AccountCapability
CapabilityUpdatedEvent
Occurs whenever a capability has new requirements or a new status.
CapabilityUpdateOptions
Card
Card
CardCustoms
customs_param
CardholderAddress
required_address
CardholderBilling
billing_specs
CardholderCardIssuing
card_issuing_param
CardholderCompany
company_param
CardholderIndividual
individual_param
CardholderSpendingControls
authorization_controls_param_v2
CardholderSpendingLimitsItem
spending_limits_param
CardIssuingAccountTermsOfService
CardIssuingAccountTermsOfService
CardOwner
owner
CardPin
encrypted_pin_param
CardShipping
shipping_specs
CardSpendingControls
authorization_controls_param
CardUpdateOptions
CashBalance
cash_balance
CashBalanceFundsAvailableEvent
Occurs whenever there is a positive remaining cash balance after Stripe automatically reconciles new funds into the cash balance. If you enabled manual reconciliation, this webhook will fire whenever there are new funds into the cash balance.
CashBalanceUpdateOptions
Charge
Charge
ChargeCapturedEvent
Occurs whenever a previously uncaptured charge is captured.
ChargeCaptureOptions
ChargeCreateOptions
ChargeCreateOptionsShipping
optional_fields_shipping
ChargeCreateOptionsTransferData
transfer_data_specs
ChargeDestination
destination_specs
ChargeDisputeClosedEvent
Occurs when a dispute is closed and the dispute status changes to `lost`, `warning_closed`, or `won`.
ChargeDisputeCreatedEvent
Occurs whenever a customer disputes a charge with their bank.
ChargeDisputeFundsReinstatedEvent
Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](/docs/disputes#disputes-on-partially-refunded-payments).
ChargeDisputeFundsWithdrawnEvent
Occurs when funds are removed from your account due to a dispute.
ChargeDisputeUpdatedEvent
Occurs when the dispute is updated (usually with evidence).
ChargeExpiredEvent
Occurs whenever an uncaptured charge expires.
ChargeFailedEvent
Occurs whenever a failed charge attempt occurs.
ChargeFraudDetails
Information on fraud assessments for the charge.
ChargeId
A Charge ID.
ChargeOrId
A Charge or its ID.
ChargeOutcome
Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
ChargePaymentMethodDetails
Details about the payment method at the time of the transaction.
ChargePendingEvent
Occurs whenever a pending charge is created.
ChargeRefundedEvent
Occurs whenever a charge is refunded, including partial refunds.
ChargeRefunds
RefundList
ChargeRefundUpdatedEvent
Occurs whenever a refund is updated, on selected payment methods.
ChargeShipping
Shipping information for the charge.
ChargeSource
ChargeSucceededEvent
Occurs whenever a charge is successful.
ChargeTransferData
An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
ChargeUpdatedEvent
Occurs whenever a charge description or metadata is updated, or upon an asynchronous capture.
ChargeUpdateOptions
ChargeUpdateOptionsFraudDetails
fraud_details
CheckoutAcssDebitMandateOptions
CheckoutAcssDebitMandateOptions
CheckoutAcssDebitPaymentMethodOptions
CheckoutAcssDebitPaymentMethodOptions
CheckoutAffirmPaymentMethodOptions
CheckoutAffirmPaymentMethodOptions
CheckoutAfterpayClearpayPaymentMethodOptions
CheckoutAfterpayClearpayPaymentMethodOptions
CheckoutAlipayPaymentMethodOptions
CheckoutAlipayPaymentMethodOptions
CheckoutAuBecsDebitPaymentMethodOptions
CheckoutAuBecsDebitPaymentMethodOptions
CheckoutBacsDebitPaymentMethodOptions
CheckoutBacsDebitPaymentMethodOptions
CheckoutBancontactPaymentMethodOptions
CheckoutBancontactPaymentMethodOptions
CheckoutBoletoPaymentMethodOptions
CheckoutBoletoPaymentMethodOptions
CheckoutCardInstallmentsOptions
CheckoutCardInstallmentsOptions
CheckoutCardPaymentMethodOptions
CheckoutCardPaymentMethodOptions
CheckoutCashappPaymentMethodOptions
CheckoutCashappPaymentMethodOptions
CheckoutCustomerBalanceBankTransferPaymentMethodOptions
CheckoutCustomerBalanceBankTransferPaymentMethodOptions
CheckoutCustomerBalancePaymentMethodOptions
CheckoutCustomerBalancePaymentMethodOptions
CheckoutEpsPaymentMethodOptions
CheckoutEpsPaymentMethodOptions
CheckoutFpxPaymentMethodOptions
CheckoutFpxPaymentMethodOptions
CheckoutGiropayPaymentMethodOptions
CheckoutGiropayPaymentMethodOptions
CheckoutGrabPayPaymentMethodOptions
CheckoutGrabPayPaymentMethodOptions
CheckoutIdealPaymentMethodOptions
CheckoutIdealPaymentMethodOptions
CheckoutKlarnaPaymentMethodOptions
CheckoutKlarnaPaymentMethodOptions
CheckoutKonbiniPaymentMethodOptions
CheckoutKonbiniPaymentMethodOptions
CheckoutLinkPaymentMethodOptions
CheckoutLinkPaymentMethodOptions
CheckoutOxxoPaymentMethodOptions
CheckoutOxxoPaymentMethodOptions
CheckoutP24PaymentMethodOptions
CheckoutP24PaymentMethodOptions
CheckoutPaynowPaymentMethodOptions
CheckoutPaynowPaymentMethodOptions
CheckoutPaypalPaymentMethodOptions
CheckoutPaypalPaymentMethodOptions
CheckoutPixPaymentMethodOptions
CheckoutPixPaymentMethodOptions
CheckoutSepaDebitPaymentMethodOptions
CheckoutSepaDebitPaymentMethodOptions
CheckoutSession
Session
CheckoutSessionAfterExpiration
When set, provides configuration for actions to take if this Checkout Session expires.
CheckoutSessionAfterExpirationRecovery
When set, configuration used to recover the Checkout Session on expiry.
CheckoutSessionAsyncPaymentFailedEvent
Occurs when a payment intent using a delayed payment method fails.
CheckoutSessionAsyncPaymentSucceededEvent
Occurs when a payment intent using a delayed payment method finally succeeds.
CheckoutSessionCompletedEvent
Occurs when a Checkout Session has been successfully completed.
CheckoutSessionConsent
Results of `consent_collection` for this session.
CheckoutSessionConsentCollection
When set, provides configuration for the Checkout Session to gather active consent from customers.
CheckoutSessionConsentCollectionPaymentMethodReuseAgreement
If set to `hidden`, it will hide legal text related to the reuse of a payment method.
CheckoutSessionCreateOptions
CheckoutSessionCurrencyConversion
Currency conversion details for automatic currency conversion sessions
CheckoutSessionCustomerDetails
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.
CheckoutSessionExpiredEvent
Occurs when a Checkout Session is expired.
CheckoutSessionInvoiceCreation
Details on the state of invoice creation for the Checkout Session.
CheckoutSessionLineItems
PaymentPagesCheckoutSessionListLineItems
CheckoutSessionPaymentMethodConfigurationDetails
Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
CheckoutSessionPaymentMethodOptions
Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
CheckoutSessionShippingAddressCollection
When set, provides configuration for Checkout to collect a shipping address from a customer.
CheckoutSessionShippingCost
The details of the customer cost of shipping, including the customer chosen ShippingRate.
CheckoutSessionTotalDetails
Tax and discount details for the computed total amount.
CheckoutSofortPaymentMethodOptions
CheckoutSofortPaymentMethodOptions
CheckoutSwishPaymentMethodOptions
CheckoutSwishPaymentMethodOptions
CheckoutUsBankAccountPaymentMethodOptions
CheckoutUsBankAccountPaymentMethodOptions
ClimateOrder
ClimateRemovalsOrders
ClimateOrderCanceledEvent
Occurs when a Climate order is canceled.
ClimateOrderCreatedEvent
Occurs when a Climate order is created.
ClimateOrderCreateOptions
ClimateOrderDelayedEvent
Occurs when a Climate order is delayed.
ClimateOrderDeliveredEvent
Occurs when a Climate order is delivered.
ClimateOrderProductSubstitutedEvent
Occurs when a Climate order's product is substituted for another.
ClimateOrderUpdateOptions
ClimateProduct
ClimateRemovalsProducts
ClimateProductCreatedEvent
Occurs when a Climate product is created.
ClimateProductId
A ClimateProduct ID.
ClimateProductOrId
A ClimateProduct or its ID.
ClimateProductPricingUpdatedEvent
Occurs when a Climate product is updated.
ClimateRemovalsBeneficiary
ClimateRemovalsBeneficiary
ClimateRemovalsLocation
ClimateRemovalsLocation
ClimateRemovalsOrderDeliveries
ClimateRemovalsOrderDeliveries
ClimateRemovalsProductsPrice
ClimateRemovalsProductsPrice
ClimateSupplier
ClimateRemovalsSuppliers
ConfigurationAud
currency_specific_config
ConfigurationBbposWiseposE
bbpos_wise_pose
ConfigurationBusinessProfile
business_profile_create_param
ConfigurationCancellationReason
subscription_cancellation_reason_creation_param
ConfigurationCustomerUpdate
customer_update_creation_param
ConfigurationFeatures
features_creation_param
ConfigurationSubscriptionCancel
subscription_cancel_creation_param
ConfigurationSubscriptionUpdate
subscription_update_creation_param
ConfigurationTipping
tipping
ConfirmationToken
ConfirmationTokensResourceConfirmationToken
ConfirmationTokenCreateOptions
ConfirmationTokenMandateData
Data used for generating a Mandate.
ConfirmationTokenPaymentMethodPreview
Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
ConfirmationTokenShipping
Shipping information collected on this ConfirmationToken.
ConfirmationTokensResourceMandateData
ConfirmationTokensResourceMandateData
ConfirmationTokensResourceMandateDataResourceCustomerAcceptance
ConfirmationTokensResourceMandateDataResourceCustomerAcceptance
ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceOnline
If this is a Mandate accepted online, this hash contains details about the online acceptance.
ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline
ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline
ConfirmationTokensResourcePaymentMethodPreview
ConfirmationTokensResourcePaymentMethodPreview
ConfirmationTokensResourceShipping
ConfirmationTokensResourceShipping
ConnectAccountReference
ConnectAccountReference
ConnectCollectionTransfer
ConnectCollectionTransfer
ConnectEmbeddedAccountConfig
ConnectEmbeddedAccountConfig
ConnectEmbeddedAccountSessionCreateComponents
ConnectEmbeddedAccountSessionCreateComponents
ConnectEmbeddedBaseConfigClaim
ConnectEmbeddedBaseConfigClaim
ConnectEmbeddedPaymentsConfig
ConnectEmbeddedPaymentsConfig
ConnectEmbeddedPaymentsFeatures
ConnectEmbeddedPaymentsFeatures
ConnectEmbeddedPayoutsConfig
ConnectEmbeddedPayoutsConfig
ConnectEmbeddedPayoutsFeatures
ConnectEmbeddedPayoutsFeatures
CountrySpec
CountrySpec
CountrySpecVerificationFieldDetails
CountrySpecVerificationFieldDetails
CountrySpecVerificationFields
CountrySpecVerificationFields
Coupon
Coupon
CouponAppliesTo
CouponAppliesTo
CouponCreatedEvent
Occurs whenever a coupon is created.
CouponCreateOptions
CouponCurrencyOption
CouponCurrencyOption
CouponDeletedEvent
Occurs whenever a coupon is deleted.
CouponUpdatedEvent
Occurs whenever a coupon is updated.
CouponUpdateOptions
CreditNote
CreditNote
CreditNoteCreatedEvent
Occurs whenever a credit note is created.
CreditNoteCreateOptions
CreditNoteId
A CreditNote ID.
CreditNoteLineItem
CreditNoteLineItem
CreditNoteLines
CreditNoteLinesList
CreditNoteLinesItem
credit_note_line_item_params
CreditNoteOrId
A CreditNote or its ID.
CreditNoteShippingCost
credit_note_shipping_cost
CreditNoteTaxAmount
CreditNoteTaxAmount
CreditNoteTaxAmountsItem
tax_amount_with_tax_rate_param
CreditNoteUpdatedEvent
Occurs whenever a credit note is updated.
CreditNoteUpdateOptions
CreditNoteVoidedEvent
Occurs whenever a credit note is voided.
CurrencyOption
CurrencyOption
CurrencyOptionCustomUnitAmount
When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
Customer
Customer
CustomerAcceptance
customer_acceptance
CustomerBalanceCustomerBalanceSettings
CustomerBalanceCustomerBalanceSettings
CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft
CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft
CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance
CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance
CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction
CustomerBalanceTransaction
CustomerBalanceTransaction
CustomerBalanceTransactionCreateOptions
CustomerBalanceTransactionId
A CustomerBalanceTransaction ID.
CustomerBalanceTransactionOrId
A CustomerBalanceTransaction or its ID.
CustomerBalanceTransactionUpdateOptions
CustomerBankTransfer
bank_transfer_params
CustomerCashBalance
cash_balance_param
CustomerCashBalanceTransaction
CustomerCashBalanceTransaction
CustomerCashBalanceTransactionCreatedEvent
Occurs whenever a new customer cash balance transactions is created.
CustomerCashBalanceTransactionId
A CustomerCashBalanceTransaction ID.
CustomerCashBalanceTransactionOrId
A CustomerCashBalanceTransaction or its ID.
CustomerCreatedEvent
Occurs whenever a new customer is created.
CustomerCreateFundingInstructionsOptions
CustomerCreateOptions
CustomerDeletedEvent
Occurs whenever a customer is deleted.
CustomerDiscount
Describes the current discount active on the customer, if there is one.
CustomerDiscountCreatedEvent
Occurs whenever a coupon is attached to a customer.
CustomerDiscountDeletedEvent
Occurs whenever a coupon is removed from a customer.
CustomerDiscountUpdatedEvent
Occurs whenever a customer is switched from one coupon to another.
CustomerFundCashBalanceOptions
CustomerId
A Customer ID.
CustomerInvoiceSettings
customer_param
CustomerOrId
A Customer or its ID.
CustomerSession
CustomerSessionResourceCustomerSession
CustomerSessionComponents
components
CustomerSessionCreateOptions
CustomerSessionResourceComponents
CustomerSessionResourceComponents
CustomerSessionResourceComponentsResourceBuyButton
CustomerSessionResourceComponentsResourceBuyButton
CustomerSessionResourceComponentsResourcePricingTable
CustomerSessionResourceComponentsResourcePricingTable
CustomerSettings
balance_settings_param
CustomerShipping
customer_shipping
CustomerSourceCreatedEvent
Occurs whenever a new source is created for a customer.
CustomerSourceDeletedEvent
Occurs whenever a source is removed from a customer.
CustomerSourceExpiringEvent
Occurs whenever a card or source will expire at the end of the month.
CustomerSourceExpiringEventObject
CustomerSources
ApmsSourcesSourceList
CustomerSourceUpdatedEvent
Occurs whenever a source's details are changed.
CustomerSubscriptionCreatedEvent
Occurs whenever a customer is signed up for a new plan.
CustomerSubscriptionDeletedEvent
Occurs whenever a customer's subscription ends.
CustomerSubscriptionPausedEvent
Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](/docs/billing/subscriptions/pause) is paused.
CustomerSubscriptionPendingUpdateAppliedEvent
Occurs whenever a customer's subscription's pending update is applied, and the subscription is updated.
CustomerSubscriptionPendingUpdateExpiredEvent
Occurs whenever a customer's subscription's pending update expires before the related invoice is paid.
CustomerSubscriptionResumedEvent
Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](/docs/api/subscriptions/resume), not when [payment collection](/docs/billing/subscriptions/pause) is resumed.
CustomerSubscriptions
SubscriptionList
CustomerSubscriptionTrialWillEndEvent
Occurs three days before a subscription's trial period is scheduled to end, or when a trial is ended immediately (using `trial_end=now`).
CustomerSubscriptionUpdatedEvent
Occurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active).
CustomerTax
CustomerTax
CustomerTaxIdCreatedEvent
Occurs whenever a tax ID is created for a customer.
CustomerTaxIdDataItem
data_params
CustomerTaxIdDeletedEvent
Occurs whenever a tax ID is deleted from a customer.
CustomerTaxIds
TaxIDsList
CustomerTaxIdUpdatedEvent
Occurs whenever a customer's tax ID is updated.
CustomerTaxLocation
The customer's location as identified by Stripe Tax.
CustomerUpdatedEvent
Occurs whenever any property of a customer changes.
CustomerUpdateOptions
CustomUnitAmount
CustomUnitAmount
DeletedAccount
DeletedAccount
DeletedApplePayDomain
DeletedApplePayDomain
DeletedApplication
DeletedApplication
DeletedBankAccount
DeletedBankAccount
DeletedCard
DeletedCard
DeletedCoupon
DeletedCoupon
DeletedCustomer
DeletedCustomer
DeletedDiscount
DeletedDiscount
DeletedExternalAccount
DeletedInvoice
DeletedInvoice
DeletedInvoiceitem
DeletedInvoiceItem
DeletedPaymentSource
DeletedPerson
DeletedPerson
DeletedPlan
DeletedPlan
DeletedPrice
DeletedPrice
DeletedProduct
DeletedProduct
DeletedRadarValueList
RadarListDeletedList
DeletedRadarValueListItem
RadarListDeletedListItem
DeletedSubscriptionItem
DeletedSubscriptionItem
DeletedTaxId
deleted_tax_id
DeletedTerminalConfiguration
TerminalConfigurationDeletedConfiguration
DeletedTerminalLocation
TerminalLocationDeletedLocation
DeletedTerminalReader
TerminalReaderDeletedReader
DeletedTestHelpersTestClock
DeletedTestClock
DeletedWebhookEndpoint
NotificationWebhookEndpointDeleted
Discount
Discount
DiscountId
A Discount ID.
DiscountOrId
A Discount or its ID.
DiscountsResourceDiscountAmount
DiscountsResourceDiscountAmount
DiscountsResourceDiscountAmountDiscount
DiscountsResourceDiscountAmountDiscountId
A DiscountsResourceDiscountAmountDiscount ID.
DiscountsResourceDiscountAmountDiscountOrId
A DiscountsResourceDiscountAmountDiscount or its ID.
Dispute
Dispute
DisputeCanceled
canceled
DisputeDuplicate
duplicate
DisputeEvidence
DisputeEvidence
DisputeEvidenceDetails
DisputeEvidenceDetails
DisputeFraudulent
fraudulent
DisputeMerchandiseNotAsDescribed
merchandise_not_as_described
DisputeNotReceived
not_received
DisputeOther
other
DisputePaymentMethodDetails
DisputePaymentMethodDetails
DisputePaymentMethodDetailsCard
Card specific dispute details.
DisputeServiceNotAsDescribed
service_not_as_described
DisputeTreasury
treasury_param
DisputeUpdateOptions
EmailSent
EmailSent
EphemeralKey
EphemeralKey
EphemeralKeyCreateOptions
Event
NotificationEvent
EventRequest
Information on the API request that triggers the event.
ExchangeRate
ExchangeRate
ExternalAccount
ExternalAccountCreateOptions
ExternalAccountDocuments
external_account_documents_param
ExternalAccountRequirements
ExternalAccountRequirements
ExternalAccountUpdateOptions
Fee
Fee
FeeRefund
FeeRefund
FeeRefundCreateOptions
FeeRefundUpdateOptions
File
File
FileCreatedEvent
Occurs whenever a new Stripe-generated file is available for your account.
FileCreateOptions
FileId
A File ID.
FileLink
FileLinkCreateOptions
FileLinkData
file_link_creation_params
FileResourceFileLinkList
FileLinkUpdateOptions
FileOrId
A File or its ID.
FinancialAccountCardIssuing
access
FinancialAccountFeatures
feature_access
FinancialAccountFinancialAddresses
financial_addresses
FinancialAccountInboundTransfers
inbound_transfers
FinancialAccountOutboundPayments
outbound_payments
FinancialAccountPlatformRestrictions
platform_restrictions
FinancialConnectionsAccount
BankConnectionsResourceLinkedAccount
FinancialConnectionsAccountCreatedEvent
Occurs when a new Financial Connections account is created.
FinancialConnectionsAccountDeactivatedEvent
Occurs when a Financial Connections account's status is updated from `active` to `inactive`.
FinancialConnectionsAccountDisconnectedEvent
Occurs when a Financial Connections account is disconnected.
FinancialConnectionsAccountOwner
BankConnectionsResourceOwner
FinancialConnectionsAccountOwnership
BankConnectionsResourceOwnership
FinancialConnectionsAccountOwnershipId
A FinancialConnectionsAccountOwnership ID.
FinancialConnectionsAccountOwnershipOrId
A FinancialConnectionsAccountOwnership or its ID.
FinancialConnectionsAccountOwnershipOwners
BankConnectionsResourceOwnerList
FinancialConnectionsAccountReactivatedEvent
Occurs when a Financial Connections account's status is updated from `inactive` to `active`.
FinancialConnectionsAccountRefreshedBalanceEvent
Occurs when an Account’s `balance_refresh` status transitions from `pending` to either `succeeded` or `failed`.
FinancialConnectionsAccountRefreshedOwnershipEvent
Occurs when an Account’s `ownership_refresh` status transitions from `pending` to either `succeeded` or `failed`.
FinancialConnectionsAccountRefreshedTransactionsEvent
Occurs when an Account’s `transaction_refresh` status transitions from `pending` to either `succeeded` or `failed`.
FinancialConnectionsAccountRefreshOptions
FinancialConnectionsAccountSubscribeOptions
FinancialConnectionsSession
BankConnectionsResourceLinkAccountSession
FinancialConnectionsSessionAccounts
BankConnectionsResourceLinkedAccountList
FinancialConnectionsSessionCreateOptions
FinancialConnectionsTransaction
BankConnectionsResourceTransaction
FinancialReportingFinanceReportRunRunParameters
FinancialReportingFinanceReportRunRunParameters
ForwardedRequestContext
ForwardedRequestContext
ForwardedRequestDetails
ForwardedRequestDetails
ForwardedRequestHeader
ForwardedRequestHeader
ForwardedResponseDetails
ForwardedResponseDetails
ForwardingRequest
ForwardingRequest
ForwardingRequestCreateOptions
FundingInstructions
CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions
FundingInstructionsBankTransfer
FundingInstructionsBankTransfer
FundingInstructionsBankTransferAbaRecord
FundingInstructionsBankTransferABARecord
FundingInstructionsBankTransferFinancialAddress
FundingInstructionsBankTransferFinancialAddress
FundingInstructionsBankTransferIbanRecord
FundingInstructionsBankTransferIbanRecord
FundingInstructionsBankTransferSortCodeRecord
FundingInstructionsBankTransferSortCodeRecord
FundingInstructionsBankTransferSpeiRecord
FundingInstructionsBankTransferSpeiRecord
FundingInstructionsBankTransferSwiftRecord
FundingInstructionsBankTransferSwiftRecord
FundingInstructionsBankTransferZenginRecord
FundingInstructionsBankTransferZenginRecord
GelatoDataDocumentReportDateOfBirth
GelatoDataDocumentReportDateOfBirth
GelatoDataDocumentReportExpirationDate
GelatoDataDocumentReportExpirationDate
GelatoDataDocumentReportIssuedDate
GelatoDataDocumentReportIssuedDate
GelatoDataIdNumberReportDate
GelatoDataIdNumberReportDate
GelatoDataVerifiedOutputsDate
GelatoDataVerifiedOutputsDate
GelatoDocumentReport
GelatoDocumentReport
GelatoDocumentReportError
Details on the verification error. Present when status is `unverified`.
GelatoIdNumberReport
GelatoIdNumberReport
GelatoIdNumberReportError
Details on the verification error. Present when status is `unverified`.
GelatoReportDocumentOptions
GelatoReportDocumentOptions
GelatoSelfieReport
GelatoSelfieReport
GelatoSelfieReportError
Details on the verification error. Present when status is `unverified`.
GelatoSessionDocumentOptions
GelatoSessionDocumentOptions
GelatoSessionLastError
GelatoSessionLastError
GelatoVerificationReportOptions
GelatoVerificationReportOptions
GelatoVerificationSessionOptions
GelatoVerificationSessionOptions
GelatoVerifiedOutputs
GelatoVerifiedOutputs
GetAccountsAccountCapabilitiesResponse
ListAccountCapability
GetAccountsAccountPersonsResponse
PersonList
GetAccountsResponse
AccountList
GetApplePayDomainsResponse
ApplePayDomainList
GetApplicationFeesResponse
PlatformEarningList
GetAppsSecretsResponse
SecretServiceResourceSecretList
GetBalanceTransactionsResponse
BalanceTransactionsList
GetBillingMetersIdEventSummariesResponse
BillingMeterResourceBillingMeterEventSummaryList
GetBillingMetersResponse
BillingMeterResourceBillingMeterList
GetBillingPortalConfigurationsResponse
PortalPublicResourceConfigurationList
GetChargesResponse
ChargeList
GetChargesSearchResponse
SearchResult
GetCheckoutSessionsResponse
PaymentPagesCheckoutSessionList
GetClimateOrdersResponse
ClimateRemovalsOrdersList
GetClimateProductsResponse
ClimateRemovalsProductsList
GetClimateSuppliersResponse
ClimateRemovalsSuppliersList
GetCountrySpecsResponse
CountrySpecList
GetCouponsResponse
CouponsResourceCouponList
GetCreditNotesResponse
CreditNotesList
GetCustomersCustomerBalanceTransactionsResponse
CustomerBalanceTransactionList
GetCustomersCustomerCashBalanceTransactionsResponse
CustomerCashBalanceTransactionList
GetCustomersCustomerPaymentMethodsResponse
CustomerPaymentMethodResourceList
GetCustomersResponse
CustomerResourceCustomerList
GetCustomersSearchResponse
SearchResult
GetDisputesResponse
DisputeList
GetEventsResponse
NotificationEventList
GetExchangeRatesResponse
ExchangeRateList
GetFilesResponse
FileResourceFileList
GetFinancialConnectionsTransactionsResponse
BankConnectionsResourceTransactionList
GetForwardingRequestsResponse
ForwardingRequestList
GetIdentityVerificationReportsResponse
GelatoVerificationReportList
GetIdentityVerificationSessionsResponse
GelatoVerificationSessionList
GetInvoiceitemsResponse
InvoicesItemsList
GetInvoicesResponse
InvoicesResourceList
GetInvoicesSearchResponse
SearchResult
GetIssuingAuthorizationsResponse
IssuingAuthorizationList
GetIssuingCardholdersResponse
IssuingCardholderList
GetIssuingCardsResponse
IssuingCardList
GetIssuingDisputesResponse
IssuingDisputeList
GetIssuingPersonalizationDesignsResponse
IssuingPersonalizationDesignList
GetIssuingPhysicalBundlesResponse
IssuingPhysicalBundleList
GetIssuingTokensResponse
IssuingNetworkTokenList
GetIssuingTransactionsResponse
IssuingTransactionList
GetPaymentIntentsResponse
PaymentFlowsPaymentIntentList
GetPaymentIntentsSearchResponse
SearchResult
GetPaymentLinksResponse
PaymentLinksResourcePaymentLinkList
GetPaymentMethodConfigurationsResponse
PaymentMethodConfigResourcePaymentMethodConfigurationsList
GetPaymentMethodDomainsResponse
PaymentMethodDomainResourcePaymentMethodDomainList
GetPayoutsResponse
PayoutList
GetPlansResponse
PlanList
GetPricesResponse
PriceList
GetPricesSearchResponse
SearchResult
GetProductsResponse
ProductList
GetProductsSearchResponse
SearchResult
GetPromotionCodesResponse
PromotionCodesResourcePromotionCodeList
GetQuotesResponse
QuotesResourceQuoteList
GetRadarEarlyFraudWarningsResponse
RadarEarlyFraudWarningList
GetRadarValueListsResponse
RadarListListList
GetReportingReportRunsResponse
FinancialReportingFinanceReportRunList
GetReportingReportTypesResponse
FinancialReportingFinanceReportTypeList
GetReviewsResponse
RadarReviewList
GetSetupAttemptsResponse
PaymentFlowsSetupIntentSetupAttemptList
GetSetupIntentsResponse
PaymentFlowsSetupIntentList
GetShippingRatesResponse
ShippingResourcesShippingRateList
GetSigmaScheduledQueryRunsResponse
SigmaScheduledQueryRunList
GetSourcesSourceSourceTransactionsResponse
ApmsSourcesSourceTransactionList
GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponse
UsageEventsResourceUsageRecordSummaryList
GetSubscriptionSchedulesResponse
SubscriptionSchedulesResourceScheduleList
GetSubscriptionsSearchResponse
SearchResult
GetTaxCodesResponse
TaxProductResourceTaxCodeList
GetTaxRatesResponse
TaxRatesList
GetTaxRegistrationsResponse
TaxProductRegistrationsResourceTaxRegistrationList
GetTerminalConfigurationsConfigurationResponse
GetTerminalConfigurationsResponse
TerminalConfigurationConfigurationList
GetTerminalLocationsLocationResponse
GetTerminalLocationsResponse
TerminalLocationLocationList
GetTerminalReadersReaderResponse
GetTerminalReadersResponse
TerminalReaderRetrieveReader
GetTestHelpersTestClocksResponse
BillingClocksResourceBillingClockList
GetTopupsResponse
TopupList
GetTransfersResponse
TransferList
GetTreasuryCreditReversalsResponse
TreasuryReceivedCreditsResourceCreditReversalList
GetTreasuryDebitReversalsResponse
TreasuryReceivedDebitsResourceDebitReversalList
GetTreasuryFinancialAccountsResponse
TreasuryFinancialAccountsResourceFinancialAccountList
GetTreasuryInboundTransfersResponse
TreasuryInboundTransfersResourceInboundTransferList
GetTreasuryOutboundPaymentsResponse
TreasuryOutboundPaymentsResourceOutboundPaymentList
GetTreasuryOutboundTransfersResponse
TreasuryOutboundTransfersResourceOutboundTransferList
GetTreasuryReceivedCreditsResponse
TreasuryReceivedCreditsResourceReceivedCreditList
GetTreasuryReceivedDebitsResponse
TreasuryReceivedDebitsResourceReceivedDebitList
GetTreasuryTransactionsResponse
TreasuryTransactionsResourceTransactionList
GetWebhookEndpointsResponse
NotificationWebhookEndpointList
IdentityVerificationReport
GelatoVerificationReport
IdentityVerificationReportId
A IdentityVerificationReport ID.
IdentityVerificationReportOrId
A IdentityVerificationReport or its ID.
IdentityVerificationSession
GelatoVerificationSession
IdentityVerificationSessionCanceledEvent
Occurs whenever a VerificationSession is canceled
IdentityVerificationSessionCreatedEvent
Occurs whenever a VerificationSession is created
IdentityVerificationSessionCreateOptions
IdentityVerificationSessionProcessingEvent
Occurs whenever a VerificationSession transitions to processing
IdentityVerificationSessionRedactedEvent
Occurs whenever a VerificationSession is redacted.
IdentityVerificationSessionRedaction
Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
IdentityVerificationSessionRequiresInputEvent
Occurs whenever a VerificationSession transitions to require user input
IdentityVerificationSessionUpdateOptions
IdentityVerificationSessionVerifiedEvent
Occurs whenever a VerificationSession transitions to verified
InboundTransferFailureDetails
failure_details_params
InboundTransfers
InboundTransfers
InboundTransfersPaymentMethodDetailsUsBankAccount
inbound_transfers_payment_method_details_us_bank_account
InternalCard
internal_card
Invoice
Invoice
InvoiceAccountTaxIdsItem
InvoiceAccountTaxIdsItemId
A InvoiceAccountTaxIdsItem ID.
InvoiceAccountTaxIdsItemOrId
A InvoiceAccountTaxIdsItem or its ID.
InvoiceAcssDebit
invoice_payment_method_options_param
InvoiceBancontact
invoice_payment_method_options_param
InvoiceBankTransfer
bank_transfer_param
InvoiceCard
invoice_payment_method_options_param
InvoiceCreatedEvent
Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](/docs/subscriptions/webhooks).
InvoiceCreateOptions
InvoiceCreateOptionsFromInvoice
from_invoice
InvoiceCreateOptionsRendering
rendering_param
InvoiceCustomerBalance
invoice_payment_method_options_param
InvoiceDeletedEvent
Occurs whenever a draft invoice is deleted.
InvoiceFinalizationFailedEvent
Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](/docs/api/invoices/object#invoice_object-last_finalization_error) for details.
InvoiceFinalizedEvent
Occurs whenever a draft invoice is finalized and updated to be an open invoice.
InvoiceFinalizeInvoiceOptions
InvoiceFromInvoice
Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
InvoiceId
A Invoice ID.
InvoiceInstallments
installments_param
InvoiceInstallmentsCard
invoice_installments_card
Invoiceitem
InvoiceItem
InvoiceitemCreatedEvent
Occurs whenever an invoice item is created.
InvoiceItemCreateOptions
InvoiceitemDeletedEvent
Occurs whenever an invoice item is deleted.
InvoiceItemDiscountsItem
discounts_data_param
InvoiceitemId
A Invoiceitem ID.
InvoiceitemOrId
A Invoiceitem or its ID.
InvoiceitemPlan
If the invoice item is a proration, the plan of the subscription that the proration was computed for.
InvoiceitemPlanProduct
InvoiceitemPlanProductId
A InvoiceitemPlanProduct ID.
InvoiceitemPlanProductOrId
A InvoiceitemPlanProduct or its ID.
InvoiceitemPlanTransformUsage
Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
InvoiceitemPrice
The price of the invoice item.
InvoiceItemPriceData
one_time_price_data
InvoiceitemPriceRecurring
The recurring components of a price such as `interval` and `usage_type`.
InvoiceItemThresholdReason
InvoiceItemThresholdReason
InvoiceItemUpdateOptions
InvoiceLineItemPeriod
InvoiceLineItemPeriod
InvoiceLineItemPriceData
one_time_price_data_with_product_data
InvoiceLineItemTaxAmountsItem
tax_amount_param
InvoiceLineItemTaxRateData
tax_rate_data_param
InvoiceLineItemUpdateOptions
InvoiceLines
InvoiceLinesList
InvoiceMandateOptions
mandate_options_param
InvoiceMandateOptionsCard
invoice_mandate_options_card
InvoiceMarkedUncollectibleEvent
Occurs whenever an invoice is marked uncollectible.
InvoiceOrId
A Invoice or its ID.
InvoicePaidEvent
Occurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.
InvoicePaymentActionRequiredEvent
Occurs whenever an invoice payment attempt requires further user action to complete.
InvoicePaymentFailedEvent
Occurs whenever an invoice payment attempt fails, due either to a declined payment or to the lack of a stored payment method.
InvoicePaymentMethodOptions
payment_method_options
InvoicePaymentMethodOptionsAcssDebit
invoice_payment_method_options_acss_debit
InvoicePaymentMethodOptionsAcssDebitMandateOptions
invoice_payment_method_options_acss_debit_mandate_options
InvoicePaymentMethodOptionsBancontact
invoice_payment_method_options_bancontact
InvoicePaymentMethodOptionsCard
invoice_payment_method_options_card
InvoicePaymentMethodOptionsCustomerBalance
invoice_payment_method_options_customer_balance
InvoicePaymentMethodOptionsCustomerBalanceBankTransfer
invoice_payment_method_options_customer_balance_bank_transfer
InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer
InvoicePaymentMethodOptionsUsBankAccount
invoice_payment_method_options_us_bank_account
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptions
invoice_payment_method_options_us_bank_account_linked_account_options
InvoicePaymentSettings
payment_settings
InvoicePaymentSucceededEvent
Occurs whenever an invoice payment attempt succeeds.
InvoicePayOptions
InvoicePdf
rendering_pdf_param
InvoicePlan
installment_plan
InvoiceRendering
The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
InvoiceRenderingOptions
This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering.
InvoiceRenderingPdf
Invoice pdf rendering options
InvoiceSentEvent
Occurs whenever an invoice email is sent out.
InvoiceSettingCustomerSetting
InvoiceSettingCustomerSetting
InvoiceSettingCustomField
InvoiceSettingCustomField
InvoiceSettingQuoteSetting
InvoiceSettingQuoteSetting
InvoiceSettingRenderingOptions
InvoiceSettingRenderingOptions
InvoiceSettingSubscriptionSchedulePhaseSetting
InvoiceSettingSubscriptionSchedulePhaseSetting
InvoiceSettingSubscriptionScheduleSetting
InvoiceSettingSubscriptionScheduleSetting
InvoiceShippingDetails
recipient_shipping_with_optional_fields_address
InvoicesPaymentMethodOptions
InvoicesPaymentMethodOptions
InvoicesPaymentSettings
InvoicesPaymentSettings
InvoicesResourceFromInvoice
InvoicesResourceFromInvoice
InvoicesResourceInvoiceRendering
InvoicesResourceInvoiceRendering
InvoicesResourceInvoiceTaxId
InvoicesResourceInvoiceTaxID
InvoicesResourceLineItemsCreditedItems
InvoicesResourceLineItemsCreditedItems
InvoicesResourceLineItemsProrationDetails
InvoicesResourceLineItemsProrationDetails
InvoicesResourceShippingCost
InvoicesResourceShippingCost
InvoicesResourceStatusTransitions
InvoicesResourceStatusTransitions
InvoiceSubscriptionDetails
Details about the subscription that created this invoice.
InvoiceTaxAmount
InvoiceTaxAmount
InvoiceThresholdReason
InvoiceThresholdReason
InvoiceTransferData
InvoiceTransferData
InvoiceUpcomingEvent
Occurs X number of days before a subscription is scheduled to create an invoice that is automatically charged—where X is determined by your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). Note: The received `Invoice` object will not have an invoice ID.
InvoiceUpdatedEvent
Occurs whenever an invoice changes (e.g., the invoice amount).
InvoiceUpdateOptions
InvoiceUsBankAccount
invoice_payment_method_options_param
InvoiceVoidedEvent
Occurs whenever an invoice is voided.
IssuingAuthorization
IssuingAuthorization
IssuingAuthorizationAmountDetails
Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
IssuingAuthorizationApproveOptions
IssuingAuthorizationAuthenticationExemption
IssuingAuthorizationAuthenticationExemption
IssuingAuthorizationCaptureOptions
IssuingAuthorizationCreatedEvent
Occurs whenever an authorization is created.
IssuingAuthorizationCreateOptions
IssuingAuthorizationId
A IssuingAuthorization ID.
IssuingAuthorizationIncrementOptions
IssuingAuthorizationMerchantData
IssuingAuthorizationMerchantData
IssuingAuthorizationNetworkData
Details about the authorization, such as identifiers, set by the card network.
IssuingAuthorizationOrId
A IssuingAuthorization or its ID.
IssuingAuthorizationPendingRequest
The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.
IssuingAuthorizationRequest
IssuingAuthorizationRequest
IssuingAuthorizationRequestEvent
Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](/docs/issuing/purchases/authorizations#authorization-handling).
IssuingAuthorizationReverseOptions
IssuingAuthorizationThreeDSecure
IssuingAuthorizationThreeDSecure
IssuingAuthorizationTreasury
[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).
IssuingAuthorizationUpdatedEvent
Occurs whenever an authorization is updated.
IssuingAuthorizationVerificationData
IssuingAuthorizationVerificationData
IssuingCard
IssuingCard
IssuingCardApplePay
IssuingCardApplePay
IssuingCardAuthorizationControls
IssuingCardAuthorizationControls
IssuingCardCreatedEvent
Occurs whenever a card is created.
IssuingCardCreateOptions
IssuingCardGooglePay
IssuingCardGooglePay
IssuingCardholder
IssuingCardholder
IssuingCardholderAddress
IssuingCardholderAddress
IssuingCardholderAuthorizationControls
IssuingCardholderAuthorizationControls
IssuingCardholderCardIssuing
IssuingCardholderCardIssuing
IssuingCardholderCompany
Additional information about a `company` cardholder.
IssuingCardholderCreatedEvent
Occurs whenever a cardholder is created.
IssuingCardholderCreateOptions
IssuingCardholderId
A IssuingCardholder ID.
IssuingCardholderIdDocument
IssuingCardholderIdDocument
IssuingCardholderIndividual
Additional information about an `individual` cardholder.
IssuingCardholderIndividualCardIssuing
Information related to the card_issuing program for this cardholder.
IssuingCardholderIndividualCardIssuingUserTermsAcceptance
Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.
IssuingCardholderIndividualDob
IssuingCardholderIndividualDOB
IssuingCardholderIndividualVerification
Government-issued ID document for this cardholder.
IssuingCardholderIndividualVerificationDocument
An identifying document, either a passport or local ID card.
IssuingCardholderOrId
A IssuingCardholder or its ID.
IssuingCardholderRequirements
IssuingCardholderRequirements
IssuingCardholderSpendingControls
Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
IssuingCardholderSpendingLimit
IssuingCardholderSpendingLimit
IssuingCardholderUpdatedEvent
Occurs whenever a cardholder is updated.
IssuingCardholderUpdateOptions
IssuingCardholderUserTermsAcceptance
IssuingCardholderUserTermsAcceptance
IssuingCardholderVerification
IssuingCardholderVerification
IssuingCardId
A IssuingCard ID.
IssuingCardOrId
A IssuingCard or its ID.
IssuingCardShipping
Where and how the card will be shipped.
IssuingCardShippingCustoms
Additional information that may be required for clearing customs.
IssuingCardSpendingLimit
IssuingCardSpendingLimit
IssuingCardUpdatedEvent
Occurs whenever a card is updated.
IssuingCardUpdateOptions
IssuingCardWallets
Information relating to digital wallets (like Apple Pay and Google Pay).
IssuingDispute
IssuingDispute
IssuingDisputeCanceledEvidence
IssuingDisputeCanceledEvidence
IssuingDisputeClosedEvent
Occurs whenever a dispute is won, lost or expired.
IssuingDisputeCreatedEvent
Occurs whenever a dispute is created.
IssuingDisputeCreateOptions
IssuingDisputeCreateOptionsEvidence
evidence_param
IssuingDisputeDuplicateEvidence
IssuingDisputeDuplicateEvidence
IssuingDisputeEvidence
IssuingDisputeEvidence
IssuingDisputeFraudulentEvidence
IssuingDisputeFraudulentEvidence
IssuingDisputeFundsReinstatedEvent
Occurs whenever funds are reinstated to your account for an Issuing dispute.
IssuingDisputeId
A IssuingDispute ID.
IssuingDisputeMerchandiseNotAsDescribedEvidence
IssuingDisputeMerchandiseNotAsDescribedEvidence
IssuingDisputeNotReceivedEvidence
IssuingDisputeNotReceivedEvidence
IssuingDisputeOrId
A IssuingDispute or its ID.
IssuingDisputeOtherEvidence
IssuingDisputeOtherEvidence
IssuingDisputeServiceNotAsDescribedEvidence
IssuingDisputeServiceNotAsDescribedEvidence
IssuingDisputeSubmittedEvent
Occurs whenever a dispute is submitted.
IssuingDisputeTreasury
[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
IssuingDisputeUpdatedEvent
Occurs whenever a dispute is updated.
IssuingDisputeUpdateOptions
IssuingNetworkTokenAddress
IssuingNetworkTokenAddress
IssuingNetworkTokenDevice
IssuingNetworkTokenDevice
IssuingNetworkTokenMastercard
IssuingNetworkTokenMastercard
IssuingNetworkTokenNetworkData
IssuingNetworkTokenNetworkData
IssuingNetworkTokenVisa
IssuingNetworkTokenVisa
IssuingNetworkTokenWalletProvider
IssuingNetworkTokenWalletProvider
IssuingPersonalizationDesign
IssuingPersonalizationDesign
IssuingPersonalizationDesignCarrierText
Hash containing carrier text, for use with physical bundles that support carrier text.
IssuingPersonalizationDesignCreateOptions
IssuingPersonalizationDesignId
A IssuingPersonalizationDesign ID.
IssuingPersonalizationDesignOrId
A IssuingPersonalizationDesign or its ID.
IssuingPersonalizationDesignPreferences
IssuingPersonalizationDesignPreferences
IssuingPersonalizationDesignRejectionReasons
IssuingPersonalizationDesignRejectionReasons
IssuingPersonalizationDesignRejectOptions
IssuingPersonalizationDesignUpdateOptions
IssuingPhysicalBundle
IssuingPhysicalBundle
IssuingPhysicalBundleFeatures
IssuingPhysicalBundleFeatures
IssuingPhysicalBundleId
A IssuingPhysicalBundle ID.
IssuingPhysicalBundleOrId
A IssuingPhysicalBundle or its ID.
IssuingToken
IssuingNetworkToken
IssuingTokenCreatedEvent
Occurs whenever an issuing digital wallet token is created.
IssuingTokenId
A IssuingToken ID.
IssuingTokenOrId
A IssuingToken or its ID.
IssuingTokenUpdatedEvent
Occurs whenever an issuing digital wallet token is updated.
IssuingTokenUpdateOptions
IssuingTransaction
IssuingTransaction
IssuingTransactionAmountDetails
IssuingTransactionAmountDetails
IssuingTransactionCreatedEvent
Occurs whenever an issuing transaction is created.
IssuingTransactionCreateForceCaptureOptions
IssuingTransactionFlightData
IssuingTransactionFlightData
IssuingTransactionFlightDataLeg
IssuingTransactionFlightDataLeg
IssuingTransactionFuelData
IssuingTransactionFuelData
IssuingTransactionId
A IssuingTransaction ID.
IssuingTransactionLodgingData
IssuingTransactionLodgingData
IssuingTransactionNetworkData
Details about the transaction, such as processing dates, set by the card network.
IssuingTransactionOrId
A IssuingTransaction or its ID.
IssuingTransactionPurchaseDetails
Additional purchase information that is optionally provided by the merchant.
IssuingTransactionPurchaseDetailsFlight
Information about the flight that was purchased with this transaction.
IssuingTransactionPurchaseDetailsFuel
Information about fuel that was purchased with this transaction.
IssuingTransactionPurchaseDetailsLodging
Information about lodging that was purchased with this transaction.
IssuingTransactionReceiptData
IssuingTransactionReceiptData
IssuingTransactionRefundOptions
IssuingTransactionTreasury
[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
IssuingTransactionUpdatedEvent
Occurs whenever an issuing transaction is updated.
Item
LineItem
LegalEntityCompany
LegalEntityCompany
LegalEntityCompanyAddressKana
The Kana variation of the company's primary address (Japan only).
LegalEntityCompanyVerification
Information on the verification state of the company.
LegalEntityCompanyVerificationDocument
LegalEntityCompanyVerificationDocument
LegalEntityDob
LegalEntityDOB
LegalEntityJapanAddress
LegalEntityJapanAddress
LegalEntityPersonVerification
LegalEntityPersonVerification
LegalEntityPersonVerificationDocument
LegalEntityPersonVerificationDocument
LegalEntityUboDeclaration
LegalEntityUBODeclaration
Level3
Level3
Level3LineItems
Level3LineItems
LineItem
InvoiceLineItem
LineItemsDiscountAmount
LineItemsDiscountAmount
LineItemsTaxAmount
LineItemsTaxAmount
LinkedAccountOptionsUsBankAccount
linked_account_options_us_bank_account
LocationAddress
create_location_address_param
LoginLink
LoginLinkCreateOptions
Mandate
Mandate
MandateAcssDebit
mandate_acss_debit
MandateAuBecsDebit
mandate_au_becs_debit
MandateBacsDebit
mandate_bacs_debit
MandateId
A Mandate ID.
MandateOrId
A Mandate or its ID.
MandatePaymentMethodDetails
mandate_payment_method_details
MandatePaypal
mandate_paypal
MandateSepaDebit
mandate_sepa_debit
MandateSingleUse
mandate_single_use
MandateUpdatedEvent
Occurs whenever a Mandate is updated.
MandateUsBankAccount
mandate_us_bank_account
MeterEventAdjustmentCancel
event_adjustment_cancel_settings_param
Networks
networks
NotificationEventData
NotificationEventData
NotificationEventRequest
NotificationEventRequest
OnlineAcceptance
online_acceptance
OrderBeneficiary
beneficiary_params
OutboundPaymentDestinationPaymentMethodData
payment_method_data
OutboundPaymentDestinationPaymentMethodOptions
payment_method_options
OutboundPaymentEndUserDetails
end_user_details_params
OutboundPaymentReturnedDetails
returned_details_params
OutboundPaymentsPaymentMethodDetails
OutboundPaymentsPaymentMethodDetails
OutboundPaymentsPaymentMethodDetailsFinancialAccount
outbound_payments_payment_method_details_financial_account
OutboundPaymentsPaymentMethodDetailsUsBankAccount
outbound_payments_payment_method_details_us_bank_account
OutboundPaymentUsBankAccount
payment_method_options_param
OutboundTransfersPaymentMethodDetails
OutboundTransfersPaymentMethodDetails
OutboundTransfersPaymentMethodDetailsUsBankAccount
outbound_transfers_payment_method_details_us_bank_account
PackageDimensions
PackageDimensions
PaymentFlowsAmountDetails
PaymentFlowsAmountDetails
PaymentFlowsAmountDetailsResourceTip
PaymentFlowsAmountDetailsResourceTip
PaymentFlowsAutomaticPaymentMethodsPaymentIntent
PaymentFlowsAutomaticPaymentMethodsPaymentIntent
PaymentFlowsAutomaticPaymentMethodsSetupIntent
PaymentFlowsAutomaticPaymentMethodsSetupIntent
PaymentFlowsInstallmentOptions
PaymentFlowsInstallmentOptions
PaymentFlowsPrivatePaymentMethodsAlipayDetails
PaymentFlowsPrivatePaymentMethodsAlipayDetails
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization
PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization
PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercapture
PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticapture
PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture
PaymentFlowsPrivatePaymentMethodsKlarnaDob
PaymentFlowsPrivatePaymentMethodsKlarnaDOB
PaymentIntent
PaymentIntent
PaymentIntentAcssDebit
payment_method_param
PaymentIntentAffirm
payment_method_options_param
PaymentIntentAfterpayClearpay
payment_method_options_param
PaymentIntentAlipay
payment_method_options_param
PaymentIntentAmountCapturableUpdatedEvent
Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://stripe.com/docs/api/payment\_intents/capture)
PaymentIntentApplyCustomerBalanceOptions
PaymentIntentAuBecsDebit
param
PaymentIntentBacsDebit
param
PaymentIntentBancontact
payment_method_options_param
PaymentIntentBillingDetails
billing_details_inner_params
PaymentIntentBlik
payment_intent_payment_method_options_param
PaymentIntentBoleto
payment_method_options_param
PaymentIntentCanceledEvent
Occurs when a PaymentIntent is canceled.
PaymentIntentCancelOptions
PaymentIntentCaptureOptions
PaymentIntentCard
payment_intent_param
PaymentIntentCardMandateOptions
mandate_options_param
PaymentIntentCardPresent
payment_method_options_param
PaymentIntentCardProcessing
PaymentIntentCardProcessing
PaymentIntentCartesBancaires
cartes_bancaires_network_options_param
PaymentIntentCashapp
payment_intent_payment_method_options_param
PaymentIntentConfirmOptions
PaymentIntentConfirmOptionsMandateData
PaymentIntentCreatedEvent
Occurs when a new PaymentIntent is created.
PaymentIntentCreateOptions
PaymentIntentCreateOptionsPaymentMethodOptions
payment_method_options_param
PaymentIntentCreateOptionsPaymentMethodOptionsAcssDebit
payment_intent_payment_method_options_param
PaymentIntentCreateOptionsPaymentMethodOptionsAuBecsDebit
payment_intent_payment_method_options_param
PaymentIntentCreateOptionsPaymentMethodOptionsKlarna
payment_method_options_param
PaymentIntentCreateOptionsPaymentMethodOptionsSepaDebit
payment_intent_payment_method_options_param
PaymentIntentCreateOptionsPaymentMethodOptionsSofort
payment_method_options_param
PaymentIntentCreateOptionsPaymentMethodOptionsUsBankAccount
payment_intent_payment_method_options_param
PaymentIntentCreateOptionsPaymentMethodOptionsUsBankAccountMandateOptions
mandate_options_param
PaymentIntentCustomerAcceptance
customer_acceptance_param
PaymentIntentEps
param
PaymentIntentFinancialConnections
linked_account_options_param
PaymentIntentFpx
param
PaymentIntentId
A PaymentIntent ID.
PaymentIntentIdeal
param
PaymentIntentIncrementAuthorizationOptions
PaymentIntentKlarna
param
PaymentIntentKonbini
payment_method_options_param
payment_intent_payment_method_options_param
PaymentIntentMandateData
secret_key_param
PaymentIntentMandateDataClientKeyParam
client_key_param
PaymentIntentMandateDataClientKeyParamCustomerAcceptance
customer_acceptance_param
PaymentIntentMandateDataClientKeyParamCustomerAcceptanceOnline
online_param
PaymentIntentMandateOptions
payment_intent_payment_method_options_mandate_options_param
PaymentIntentMobilepay
payment_method_options_param
PaymentIntentNetworkOptions
network_options_param
PaymentIntentNetworks
networks_options_param
PaymentIntentNextAction
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.
PaymentIntentNextActionAlipayHandleRedirect
PaymentIntentNextActionAlipayHandleRedirect
PaymentIntentNextActionBoleto
payment_intent_next_action_boleto
PaymentIntentNextActionCardAwaitNotification
PaymentIntentNextActionCardAwaitNotification
PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode
PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode
PaymentIntentNextActionCashappQrCode
PaymentIntentNextActionCashappQRCode
PaymentIntentNextActionDisplayBankTransferInstructions
PaymentIntentNextActionDisplayBankTransferInstructions
PaymentIntentNextActionDisplayOxxoDetails
PaymentIntentNextActionDisplayOxxoDetails
PaymentIntentNextActionKonbini
payment_intent_next_action_konbini
PaymentIntentNextActionKonbiniFamilymart
payment_intent_next_action_konbini_familymart
PaymentIntentNextActionKonbiniLawson
payment_intent_next_action_konbini_lawson
PaymentIntentNextActionKonbiniMinistop
payment_intent_next_action_konbini_ministop
PaymentIntentNextActionKonbiniSeicomart
payment_intent_next_action_konbini_seicomart
PaymentIntentNextActionKonbiniStores
payment_intent_next_action_konbini_stores
PaymentIntentNextActionPaynowDisplayQrCode
PaymentIntentNextActionPaynowDisplayQrCode
PaymentIntentNextActionPixDisplayQrCode
PaymentIntentNextActionPixDisplayQrCode
PaymentIntentNextActionPromptpayDisplayQrCode
PaymentIntentNextActionPromptpayDisplayQrCode
PaymentIntentNextActionRedirectToUrl
PaymentIntentNextActionRedirectToUrl
PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode
PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode
PaymentIntentNextActionSwishQrCode
PaymentIntentNextActionSwishQRCode
PaymentIntentNextActionVerifyWithMicrodeposits
PaymentIntentNextActionVerifyWithMicrodeposits
PaymentIntentNextActionWechatPayDisplayQrCode
PaymentIntentNextActionWechatPayDisplayQrCode
PaymentIntentNextActionWechatPayRedirectToAndroidApp
PaymentIntentNextActionWechatPayRedirectToAndroidApp
PaymentIntentNextActionWechatPayRedirectToIosApp
PaymentIntentNextActionWechatPayRedirectToIOSApp
PaymentIntentOnline
online_param
PaymentIntentOrId
A PaymentIntent or its ID.
PaymentIntentP24
param
PaymentIntentPartiallyFundedEvent
Occurs when funds are applied to a customer_balance PaymentIntent and the 'amount_remaining' changes.
PaymentIntentPaymentFailedEvent
Occurs when a PaymentIntent has failed the attempt to create a payment method or a payment.
PaymentIntentPaymentMethodData
payment_method_data_params
PaymentIntentPaymentMethodOptions
Payment-method-specific configuration for this PaymentIntent.
PaymentIntentPaymentMethodOptionsAcssDebit
payment_intent_payment_method_options_acss_debit
PaymentIntentPaymentMethodOptionsAuBecsDebit
payment_intent_payment_method_options_au_becs_debit
PaymentIntentPaymentMethodOptionsBlik
payment_intent_payment_method_options_blik
PaymentIntentPaymentMethodOptionsCard
payment_intent_payment_method_options_card
PaymentIntentPaymentMethodOptionsCardInstallments
Installment details for this payment (Mexico only). For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
PaymentIntentPaymentMethodOptionsCardInstallmentsPlan
Installment plan selected for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardMandateOptions
Configuration options for setting up an eMandate for cards issued in India.
PaymentIntentPaymentMethodOptionsEps
payment_intent_payment_method_options_eps
payment_intent_payment_method_options_link
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit
payment_intent_payment_method_options_mandate_options_acss_debit
PaymentIntentPaymentMethodOptionsMobilepay
payment_intent_payment_method_options_mobilepay
PaymentIntentPaymentMethodOptionsSepaDebit
payment_intent_payment_method_options_sepa_debit
PaymentIntentPaymentMethodOptionsSwish
payment_intent_payment_method_options_swish
PaymentIntentPaymentMethodOptionsUsBankAccount
payment_intent_payment_method_options_us_bank_account
PaymentIntentPix
payment_method_options_param
PaymentIntentProcessing
If present, this property tells you about the processing state of the payment.
PaymentIntentProcessingCustomerNotification
PaymentIntentProcessingCustomerNotification
PaymentIntentProcessingEvent
Occurs when a PaymentIntent has started processing.
PaymentIntentRequiresActionEvent
Occurs when a PaymentIntent transitions to requires_action state
PaymentIntentSepaDebit
param
PaymentIntentSofort
param
PaymentIntentSource
PaymentIntentSourceId
A PaymentIntentSource ID.
PaymentIntentSourceOrId
A PaymentIntentSource or its ID.
PaymentIntentSucceededEvent
Occurs when a PaymentIntent has successfully completed payment.
PaymentIntentSwish
payment_intent_payment_method_options_param
PaymentIntentThreeDSecure
payment_method_options_param
PaymentIntentTransferData
The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
PaymentIntentTypeSpecificPaymentMethodOptionsClient
PaymentIntentTypeSpecificPaymentMethodOptionsClient
PaymentIntentUpdateOptions
PaymentIntentUsBankAccount
payment_method_param
PaymentIntentVerifyMicrodepositsOptions
PaymentLink
PaymentLinkAfterCompletion
after_completion_params
PaymentLinkCompletedSessions
completed_sessions_params
PaymentLinkCreatedEvent
Occurs when a payment link is created.
PaymentLinkCreateOptions
PaymentLinkCreateOptionsInvoiceCreation
invoice_creation_create_params
PaymentLinkCreateOptionsPaymentIntentData
payment_intent_data_params
PaymentLinkCreateOptionsRestrictions
restrictions_params
PaymentLinkCreateOptionsSubscriptionData
subscription_data_params
PaymentLinkId
A PaymentLink ID.
PaymentLinkInvoiceCreation
Configuration for creating invoice for payment mode payment links.
PaymentLinkInvoiceCreationInvoiceData
Configuration for the invoice. Default invoice values will be used if unspecified.
PaymentLinkInvoiceData
invoice_settings_params
PaymentLinkLineItemsItem
line_items_create_params
PaymentLinkOrId
A PaymentLink or its ID.
PaymentLinkPaymentIntentData
Indicates the parameters to be passed to PaymentIntent creation during checkout.
PaymentLinkRestrictions
Settings that restrict the usage of a payment link.
PaymentLinksResourceAfterCompletion
PaymentLinksResourceAfterCompletion
PaymentLinksResourceAutomaticTax
PaymentLinksResourceAutomaticTax
PaymentLinksResourceCompletedSessions
PaymentLinksResourceCompletedSessions
PaymentLinksResourceCompletionBehaviorConfirmationPage
PaymentLinksResourceCompletionBehaviorConfirmationPage
PaymentLinksResourceCompletionBehaviorRedirect
PaymentLinksResourceCompletionBehaviorRedirect
PaymentLinksResourceConsentCollection
PaymentLinksResourceConsentCollection
PaymentLinksResourceCustomFields
PaymentLinksResourceCustomFields
PaymentLinksResourceCustomFieldsDropdown
PaymentLinksResourceCustomFieldsDropdown
PaymentLinksResourceCustomFieldsDropdownOption
PaymentLinksResourceCustomFieldsDropdownOption
PaymentLinksResourceCustomFieldsLabel
PaymentLinksResourceCustomFieldsLabel
PaymentLinksResourceCustomFieldsNumeric
PaymentLinksResourceCustomFieldsNumeric
PaymentLinksResourceCustomFieldsText
PaymentLinksResourceCustomFieldsText
PaymentLinksResourceCustomText
PaymentLinksResourceCustomText
PaymentLinksResourceCustomTextAfterSubmit
Custom text that should be displayed after the payment confirmation button.
PaymentLinksResourceCustomTextPosition
PaymentLinksResourceCustomTextPosition
PaymentLinksResourceInvoiceCreation
PaymentLinksResourceInvoiceCreation
PaymentLinksResourceInvoiceSettings
PaymentLinksResourceInvoiceSettings
PaymentLinksResourcePaymentIntentData
PaymentLinksResourcePaymentIntentData
PaymentLinksResourcePaymentMethodReuseAgreement
PaymentLinksResourcePaymentMethodReuseAgreement
PaymentLinksResourcePhoneNumberCollection
PaymentLinksResourcePhoneNumberCollection
PaymentLinksResourceRestrictions
PaymentLinksResourceRestrictions
PaymentLinksResourceShippingAddressCollection
PaymentLinksResourceShippingAddressCollection
PaymentLinksResourceShippingOption
PaymentLinksResourceShippingOption
PaymentLinksResourceSubscriptionData
PaymentLinksResourceSubscriptionData
PaymentLinksResourceSubscriptionDataInvoiceSettings
PaymentLinksResourceSubscriptionDataInvoiceSettings
PaymentLinksResourceTaxIdCollection
PaymentLinksResourceTaxIdCollection
PaymentLinksResourceTransferData
PaymentLinksResourceTransferData
PaymentLinkSubscriptionData
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`.
PaymentLinkSubscriptionDataTrialSettings
Settings related to subscription trials.
PaymentLinkUpdatedEvent
Occurs when a payment link is updated.
PaymentLinkUpdateOptions
PaymentLinkUpdateOptionsLineItemsItem
line_items_update_params
PaymentLinkUpdateOptionsPaymentIntentData
payment_intent_data_update_params
PaymentLinkUpdateOptionsSubscriptionData
subscription_data_update_params
PaymentMethod
PaymentMethod
PaymentMethodAcssDebit
payment_method_acss_debit
PaymentMethodAttachedEvent
Occurs whenever a new payment method is attached to a customer.
PaymentMethodAttachOptions
PaymentMethodAuBecsDebit
payment_method_au_becs_debit
PaymentMethodAutomaticallyUpdatedEvent
Occurs whenever a payment method's details are automatically updated by the network.
PaymentMethodBacsDebit
payment_method_bacs_debit
PaymentMethodBoleto
payment_method_boleto
PaymentMethodCard
payment_method_card
PaymentMethodCardCardDetailsParams
card_details_params
PaymentMethodCardChecks
Checks on Card address and CVC if provided.
PaymentMethodCardPresent
payment_method_card_present
PaymentMethodCardPresentNetworks
payment_method_card_present_networks
PaymentMethodCardThreeDSecureUsage
Contains details on how this Card may be used for 3D Secure authentication.
PaymentMethodCardTokenParams
token_params
PaymentMethodCardWallet
If this Card is part of a card wallet, this contains the details of the card wallet.
PaymentMethodCardWalletMasterpass
payment_method_card_wallet_masterpass
PaymentMethodCardWalletVisaCheckout
payment_method_card_wallet_visa_checkout
PaymentMethodCashapp
payment_method_cashapp
PaymentMethodConfigBizPaymentMethodConfigurationDetails
PaymentMethodConfigBizPaymentMethodConfigurationDetails
PaymentMethodConfigResourceDisplayPreference
PaymentMethodConfigResourceDisplayPreference
PaymentMethodConfigResourcePaymentMethodProperties
PaymentMethodConfigResourcePaymentMethodProperties
PaymentMethodConfiguration
PaymentMethodConfigResourcePaymentMethodConfiguration
PaymentMethodConfigurationAcssDebit
payment_method_param
PaymentMethodConfigurationCreateOptions
PaymentMethodConfigurationDisplayPreference
display_preference_param
PaymentMethodConfigurationUpdateOptions
PaymentMethodCreateOptions
PaymentMethodDetachedEvent
Occurs whenever a payment method is detached from a customer.
PaymentMethodDetails
payment_method_details
PaymentMethodDetailsAchCreditTransfer
payment_method_details_ach_credit_transfer
PaymentMethodDetailsAchDebit
payment_method_details_ach_debit
PaymentMethodDetailsAcssDebit
payment_method_details_acss_debit
PaymentMethodDetailsAfterpayClearpay
payment_method_details_afterpay_clearpay
PaymentMethodDetailsAuBecsDebit
payment_method_details_au_becs_debit
PaymentMethodDetailsBacsDebit
payment_method_details_bacs_debit
PaymentMethodDetailsBancontact
payment_method_details_bancontact
PaymentMethodDetailsBoleto
payment_method_details_boleto
PaymentMethodDetailsCard
payment_method_details_card
PaymentMethodDetailsCardChecks
payment_method_details_card_checks
PaymentMethodDetailsCardInstallments
Installment details for this payment (Mexico only). For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
PaymentMethodDetailsCardInstallmentsPlan
payment_method_details_card_installments_plan
PaymentMethodDetailsCardNetworkToken
If this card has network token credentials, this contains the details of the network token credentials.
PaymentMethodDetailsCardPresent
payment_method_details_card_present
PaymentMethodDetailsCardPresentOffline
Details about payments collected offline.
PaymentMethodDetailsCardPresentReceipt
A collection of fields required to be displayed on receipts. Only required for EMV transactions.
PaymentMethodDetailsCardThreeDSecure
Populated if this transaction used 3D Secure authentication.
PaymentMethodDetailsCardWallet
If this Card is part of a card wallet, this contains the details of the card wallet.
PaymentMethodDetailsCardWalletMasterpass
payment_method_details_card_wallet_masterpass
PaymentMethodDetailsCardWalletVisaCheckout
payment_method_details_card_wallet_visa_checkout
PaymentMethodDetailsCashapp
payment_method_details_cashapp
PaymentMethodDetailsEps
payment_method_details_eps
PaymentMethodDetailsFpx
payment_method_details_fpx
PaymentMethodDetailsGiropay
payment_method_details_giropay
PaymentMethodDetailsGrabpay
payment_method_details_grabpay
PaymentMethodDetailsIdeal
payment_method_details_ideal
PaymentMethodDetailsInteracPresent
payment_method_details_interac_present
PaymentMethodDetailsInteracPresentReceipt
A collection of fields required to be displayed on receipts. Only required for EMV transactions.
PaymentMethodDetailsKlarna
payment_method_details_klarna
PaymentMethodDetailsKonbini
payment_method_details_konbini
PaymentMethodDetailsKonbiniStore
If the payment succeeded, this contains the details of the convenience store where the payment was completed.
payment_method_details_link
PaymentMethodDetailsMobilepay
payment_method_details_mobilepay
PaymentMethodDetailsMultibanco
payment_method_details_multibanco
PaymentMethodDetailsOxxo
payment_method_details_oxxo
PaymentMethodDetailsP24
payment_method_details_p24
PaymentMethodDetailsPaynow
payment_method_details_paynow
PaymentMethodDetailsPaypal
payment_method_details_paypal
PaymentMethodDetailsPaypalSellerProtection
The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
PaymentMethodDetailsPix
payment_method_details_pix
PaymentMethodDetailsPromptpay
payment_method_details_promptpay
PaymentMethodDetailsSepaCreditTransfer
payment_method_details_sepa_credit_transfer
PaymentMethodDetailsSepaDebit
payment_method_details_sepa_debit
PaymentMethodDetailsSofort
payment_method_details_sofort
PaymentMethodDetailsSwish
payment_method_details_swish
PaymentMethodDetailsUsBankAccount
payment_method_details_us_bank_account
PaymentMethodDetailsWechatPay
payment_method_details_wechat_pay
PaymentMethodDomain
PaymentMethodDomainResourcePaymentMethodDomain
PaymentMethodDomainCreateOptions
PaymentMethodDomainResourcePaymentMethodStatus
PaymentMethodDomainResourcePaymentMethodStatus
PaymentMethodDomainResourcePaymentMethodStatusDetails
PaymentMethodDomainResourcePaymentMethodStatusDetails
PaymentMethodDomainUpdateOptions
PaymentMethodEps
payment_method_eps
PaymentMethodFpx
payment_method_fpx
PaymentMethodId
A PaymentMethod ID.
PaymentMethodIdeal
payment_method_ideal
PaymentMethodInteracPresent
payment_method_interac_present
PaymentMethodKlarna
payment_method_klarna
payment_method_link
PaymentMethodNetworks
networks_params
PaymentMethodOptionsAffirm
payment_method_options_affirm
PaymentMethodOptionsAfterpayClearpay
payment_method_options_afterpay_clearpay
PaymentMethodOptionsAlipay
payment_method_options_alipay
PaymentMethodOptionsBacsDebit
payment_method_options_bacs_debit
PaymentMethodOptionsBancontact
payment_method_options_bancontact
PaymentMethodOptionsBoleto
payment_method_options_boleto
PaymentMethodOptionsCardInstallments
payment_method_options_card_installments
PaymentMethodOptionsCardMandateOptions
payment_method_options_card_mandate_options
PaymentMethodOptionsCardPresent
payment_method_options_card_present
PaymentMethodOptionsCashapp
payment_method_options_cashapp
PaymentMethodOptionsCustomerBalance
payment_method_options_customer_balance
PaymentMethodOptionsCustomerBalanceBankTransfer
payment_method_options_customer_balance_bank_transfer
PaymentMethodOptionsCustomerBalanceEuBankAccount
payment_method_options_customer_balance_eu_bank_account
PaymentMethodOptionsFpx
payment_method_options_fpx
PaymentMethodOptionsGiropay
payment_method_options_giropay
PaymentMethodOptionsGrabpay
payment_method_options_grabpay
PaymentMethodOptionsIdeal
payment_method_options_ideal
PaymentMethodOptionsKlarna
payment_method_options_klarna
PaymentMethodOptionsKonbini
payment_method_options_konbini
PaymentMethodOptionsOxxo
payment_method_options_oxxo
PaymentMethodOptionsP24
payment_method_options_p24
PaymentMethodOptionsPaynow
payment_method_options_paynow
PaymentMethodOptionsPaypal
payment_method_options_paypal
PaymentMethodOptionsPix
payment_method_options_pix
PaymentMethodOptionsPromptpay
payment_method_options_promptpay
PaymentMethodOptionsSofort
payment_method_options_sofort
PaymentMethodOptionsUsBankAccountMandateOptions
payment_method_options_us_bank_account_mandate_options
PaymentMethodOptionsWechatPay
payment_method_options_wechat_pay
PaymentMethodOptionsZip
payment_method_options_zip
PaymentMethodOrId
A PaymentMethod or its ID.
PaymentMethodP24
payment_method_p24
PaymentMethodPaypal
payment_method_paypal
PaymentMethodSepaDebit
payment_method_sepa_debit
PaymentMethodSepaDebitGeneratedFrom
Information about the object that generated this PaymentMethod.
PaymentMethodSofort
payment_method_sofort
PaymentMethodUpdatedEvent
Occurs whenever a payment method is updated via the [PaymentMethod update API](https://stripe.com/docs/api/payment_methods/update).
PaymentMethodUpdateOptions
PaymentMethodUpdateOptionsCard
update_api_param
PaymentMethodUpdateOptionsCardNetworks
networks_update_api_param
PaymentMethodUsBankAccount
payment_method_us_bank_account
PaymentMethodUsBankAccountBlocked
payment_method_us_bank_account_blocked
PaymentMethodUsBankAccountNetworks
Contains information about US bank account networks that can be used.
PaymentMethodUsBankAccountStatusDetails
Contains information about the future reusability of this PaymentMethod.
PaymentPagesCheckoutSessionAfterExpiration
PaymentPagesCheckoutSessionAfterExpiration
PaymentPagesCheckoutSessionAfterExpirationRecovery
PaymentPagesCheckoutSessionAfterExpirationRecovery
PaymentPagesCheckoutSessionAutomaticTax
PaymentPagesCheckoutSessionAutomaticTax
PaymentPagesCheckoutSessionConsent
PaymentPagesCheckoutSessionConsent
PaymentPagesCheckoutSessionConsentCollection
PaymentPagesCheckoutSessionConsentCollection
PaymentPagesCheckoutSessionCurrencyConversion
PaymentPagesCheckoutSessionCurrencyConversion
PaymentPagesCheckoutSessionCustomerDetails
PaymentPagesCheckoutSessionCustomerDetails
PaymentPagesCheckoutSessionCustomFields
PaymentPagesCheckoutSessionCustomFields
PaymentPagesCheckoutSessionCustomFieldsDropdown
PaymentPagesCheckoutSessionCustomFieldsDropdown
PaymentPagesCheckoutSessionCustomFieldsLabel
PaymentPagesCheckoutSessionCustomFieldsLabel
PaymentPagesCheckoutSessionCustomFieldsNumeric
PaymentPagesCheckoutSessionCustomFieldsNumeric
PaymentPagesCheckoutSessionCustomFieldsOption
PaymentPagesCheckoutSessionCustomFieldsOption
PaymentPagesCheckoutSessionCustomFieldsText
PaymentPagesCheckoutSessionCustomFieldsText
PaymentPagesCheckoutSessionCustomText
PaymentPagesCheckoutSessionCustomText
PaymentPagesCheckoutSessionCustomTextPosition
PaymentPagesCheckoutSessionCustomTextPosition
PaymentPagesCheckoutSessionInvoiceCreation
PaymentPagesCheckoutSessionInvoiceCreation
PaymentPagesCheckoutSessionInvoiceSettings
PaymentPagesCheckoutSessionInvoiceSettings
PaymentPagesCheckoutSessionPaymentMethodReuseAgreement
PaymentPagesCheckoutSessionPaymentMethodReuseAgreement
PaymentPagesCheckoutSessionPhoneNumberCollection
PaymentPagesCheckoutSessionPhoneNumberCollection
PaymentPagesCheckoutSessionShippingAddressCollection
PaymentPagesCheckoutSessionShippingAddressCollection
PaymentPagesCheckoutSessionShippingCost
PaymentPagesCheckoutSessionShippingCost
PaymentPagesCheckoutSessionShippingOption
PaymentPagesCheckoutSessionShippingOption
PaymentPagesCheckoutSessionTaxId
PaymentPagesCheckoutSessionTaxID
PaymentPagesCheckoutSessionTaxIdCollection
PaymentPagesCheckoutSessionTaxIDCollection
PaymentPagesCheckoutSessionTotalDetails
PaymentPagesCheckoutSessionTotalDetails
PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown
PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown
PaymentSource
PaymentSourceCreateOptions
PaymentSourceId
A PaymentSource ID.
PaymentSourceOrId
A PaymentSource or its ID.
Payout
Payout
PayoutCanceledEvent
Occurs whenever a payout is canceled.
PayoutCreatedEvent
Occurs whenever a payout is created.
PayoutCreateOptions
PayoutDestination
PayoutDestinationId
A PayoutDestination ID.
PayoutDestinationOrId
A PayoutDestination or its ID.
PayoutFailedEvent
Occurs whenever a payout attempt fails.
PayoutId
A Payout ID.
PayoutOrId
A Payout or its ID.
PayoutPaidEvent
Occurs whenever a payout is expected to be available in the destination account. If the payout fails, a `payout.failed` notification is also sent, at a later time.
PayoutReconciliationCompletedEvent
Occurs whenever balance transactions paid out in an automatic payout can be queried.
PayoutReverseOptions
PayoutUpdatedEvent
Occurs whenever a payout is updated.
PaypalSellerProtection
paypal_seller_protection
Period
Period
Person
Person
PersonAccount
settings_terms_of_service_specs
PersonAdditionalTosAcceptance
PersonAdditionalTOSAcceptance
PersonAdditionalTosAcceptances
PersonAdditionalTOSAcceptances
PersonalizationDesignCarrierText
carrier_text_param
PersonalizationDesignPreferences
preferences_param
PersonalizationDesignRejectionReasons
rejection_reasons_param
PersonalizationDesignsPreferences
preferences_list_param
PersonCompanyAuthorization
documents_param
PersonCreatedEvent
Occurs whenever a person associated with an account is created.
PersonCreateOptions
PersonDeletedEvent
Occurs whenever a person associated with an account is deleted.
PersonDocuments
person_documents_specs
PersonFutureRequirements
Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
PersonRelationship
PersonRelationship
PersonRequirements
PersonRequirements
PersonsRelationship
all_people_relationship_specs
PersonUpdatedEvent
Occurs whenever a person associated with an account is updated.
Plan
Plan
PlanCreatedEvent
Occurs whenever a plan is created.
PlanCreateOptions
PlanDeletedEvent
Occurs whenever a plan is deleted.
PlanProduct
PlanProductInlineProductParams
inline_product_params
PlanTier
PlanTier
PlanTiersItem
tier
PlanUpdatedEvent
Occurs whenever a plan is updated.
PlanUpdateOptions
PlatformTaxFee
PlatformTax
PortalBusinessProfile
PortalBusinessProfile
PortalCustomerUpdate
PortalCustomerUpdate
PortalFeatures
PortalFeatures
PortalFlowsAfterCompletionHostedConfirmation
PortalFlowsAfterCompletionHostedConfirmation
PortalFlowsAfterCompletionRedirect
PortalFlowsAfterCompletionRedirect
PortalFlowsCouponOffer
PortalFlowsCouponOffer
PortalFlowsFlow
PortalFlowsFlow
PortalFlowsFlowAfterCompletion
PortalFlowsFlowAfterCompletion
PortalFlowsFlowSubscriptionCancel
PortalFlowsFlowSubscriptionCancel
PortalFlowsFlowSubscriptionUpdate
PortalFlowsFlowSubscriptionUpdate
PortalFlowsFlowSubscriptionUpdateConfirm
PortalFlowsFlowSubscriptionUpdateConfirm
PortalFlowsRetention
PortalFlowsRetention
PortalFlowsSubscriptionUpdateConfirmDiscount
PortalFlowsSubscriptionUpdateConfirmDiscount
PortalFlowsSubscriptionUpdateConfirmItem
PortalFlowsSubscriptionUpdateConfirmItem
PortalInvoiceList
PortalInvoiceList
PortalLoginPage
PortalLoginPage
PortalPaymentMethodUpdate
PortalPaymentMethodUpdate
PortalSubscriptionCancel
PortalSubscriptionCancel
PortalSubscriptionCancellationReason
PortalSubscriptionCancellationReason
PortalSubscriptionPause
PortalSubscriptionPause
PortalSubscriptionUpdate
PortalSubscriptionUpdate
PortalSubscriptionUpdateProduct
PortalSubscriptionUpdateProduct
PostCustomersCustomerSourcesIdResponse
PostTaxIdsOptions
Price
Price
PriceCreatedEvent
Occurs whenever a price is created.
PriceCreateOptions
PriceCurrencyOptionsValue
currency_option
PriceCustomUnitAmount
custom_unit_amount
PriceDeletedEvent
Occurs whenever a price is deleted.
PriceId
A Price ID.
PriceOrId
A Price or its ID.
PriceRecurring
recurring
PricesRecurring
all_prices_recurring_params
PriceTier
PriceTier
PriceUpdatedEvent
Occurs whenever a price is updated.
PriceUpdateOptions
Product
Product
ProductCreatedEvent
Occurs whenever a product is created.
ProductCreateOptions
ProductDefaultPriceData
price_data_without_product
ProductDeletedEvent
Occurs whenever a product is deleted.
ProductFeaturesItem
features
ProductMarketingFeature
ProductMarketingFeature
ProductUpdatedEvent
Occurs whenever a product is updated.
ProductUpdateOptions
PromotionCode
PromotionCode
PromotionCodeCreatedEvent
Occurs whenever a promotion code is created.
PromotionCodeCreateOptions
PromotionCodeCurrencyOption
PromotionCodeCurrencyOption
PromotionCodeCurrencyOptionsValue
currency_option
PromotionCodeId
A PromotionCode ID.
PromotionCodeOrId
A PromotionCode or its ID.
PromotionCodeRestrictions
restrictions_params
PromotionCodesResourceRestrictions
PromotionCodesResourceRestrictions
PromotionCodeUpdatedEvent
Occurs whenever a promotion code is updated.
PromotionCodeUpdateOptions
PromotionCodeUpdateOptionsRestrictions
restrictions_params
Quote
Quote
QuoteAcceptedEvent
Occurs whenever a quote is accepted.
QuoteCanceledEvent
Occurs whenever a quote is canceled.
QuoteCreatedEvent
Occurs whenever a quote is created.
QuoteCreateOptions
QuoteCreateOptionsFromQuote
from_quote_params
QuoteCreateOptionsTransferData
transfer_data_specs
QuoteFinalizedEvent
Occurs whenever a quote is finalized.
QuoteFinalizeQuoteOptions
QuoteFromQuote
Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.
QuoteId
A Quote ID.
QuoteInvoice
QuoteInvoiceId
A QuoteInvoice ID.
QuoteInvoiceOrId
A QuoteInvoice or its ID.
QuoteInvoiceSettings
quote_param
QuoteLineItemsItem
line_item_create_params
QuoteOrId
A Quote or its ID.
QuotePriceData
price_data
QuotesResourceAutomaticTax
QuotesResourceAutomaticTax
QuotesResourceComputed
QuotesResourceComputed
QuotesResourceComputedRecurring
The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.
QuotesResourceFromQuote
QuotesResourceFromQuote
QuotesResourceRecurring
QuotesResourceRecurring
QuotesResourceStatusTransitions
QuotesResourceStatusTransitions
QuotesResourceSubscriptionDataSubscriptionData
QuotesResourceSubscriptionDataSubscriptionData
QuotesResourceTotalDetails
QuotesResourceTotalDetails
QuotesResourceTotalDetailsResourceBreakdown
QuotesResourceTotalDetailsResourceBreakdown
QuotesResourceTransferData
QuotesResourceTransferData
QuotesResourceUpfront
QuotesResourceUpfront
QuoteSubscriptionData
subscription_data_create_params
QuoteTransferData
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.
QuoteUpdateOptions
QuoteUpdateOptionsLineItemsItem
line_item_update_params
QuoteUpdateOptionsSubscriptionData
subscription_data_update_params
RadarEarlyFraudWarning
RadarEarlyFraudWarning
RadarEarlyFraudWarningCreatedEvent
Occurs whenever an early fraud warning is created.
RadarEarlyFraudWarningUpdatedEvent
Occurs whenever an early fraud warning is updated.
RadarRadarOptions
RadarRadarOptions
RadarReviewResourceLocation
RadarReviewResourceLocation
RadarReviewResourceSession
RadarReviewResourceSession
RadarValueList
RadarListList
RadarValueListCreateOptions
RadarValueListItem
RadarListListItem
RadarValueListItemCreateOptions
RadarValueListListItems
RadarListListItemList
RadarValueListUpdateOptions
ReaderCardPresent
card_present
ReaderCart
cart
ReaderProcessConfig
process_config
ReceivedCreditInitiatingPaymentMethodDetails
source_params
ReceivedCreditsLinkedFlows
linked_flows_param
ReceivedCreditUsBankAccount
us_bank_account_source_params
ReceivedPaymentMethodDetailsFinancialAccount
received_payment_method_details_financial_account
Recurring
Recurring
Refund
Refund
RefundCreatedEvent
Occurs whenever a refund from a customer's cash balance is created.
RefundCreateOptions
RefundDestinationDetails
refund_destination_details
RefundDestinationDetailsCard
refund_destination_details_card
RefundDestinationDetailsGeneric
refund_destination_details_generic
RefundId
A Refund ID.
RefundNextAction
RefundNextAction
RefundNextActionDisplayDetails
Contains the refund details.
RefundOrId
A Refund or its ID.
RefundUpdatedEvent
Occurs whenever a refund from a customer's cash balance is updated.
RegistrationAt
europe
RegistrationCa
canada
RegistrationCountryOptions
country_options
RegistrationUs
united_states
ReportingReportRun
reporting_report_run
ReportingReportRunCreateOptions
ReportingReportRunFailedEvent
Occurs whenever a requested `ReportRun` failed to complete.
ReportingReportRunSucceededEvent
Occurs whenever a requested `ReportRun` completed successfully.
ReportingReportType
reporting_report_type
ReportingReportTypeUpdatedEvent
Occurs whenever a `ReportType` is updated (typically to indicate that a new day's data has come available).
ReportRunParameters
run_parameter_specs
Request
request_param
ReserveTransaction
ReserveTransaction
Review
RadarReview
ReviewClosedEvent
Occurs whenever a review is closed. The review's `reason` field indicates why: `approved`, `disputed`, `refunded`, or `refunded_as_fraud`.
ReviewId
A Review ID.
ReviewOpenedEvent
Occurs whenever a review is opened.
ReviewOrId
A Review or its ID.
Rule
RadarRule
RuleId
A Rule ID.
RuleOrId
A Rule or its ID.
ScheduledQueryRun
ScheduledQueryRun
SchedulesPhaseAutomaticTax
SchedulesPhaseAutomaticTax
SecretServiceResourceScope
SecretServiceResourceScope
SepaDebitGeneratedFrom
sepa_debit_generated_from
SessionAccountHolder
accountholder_params
SessionAcssDebit
payment_method_options_param
SessionAdjustableQuantity
adjustable_quantity_params
SessionAfterCompletion
flow_data_after_completion_param
SessionAfterExpiration
after_expiration_params
SessionAutomaticTax
automatic_tax_params
SessionBankTransfer
bank_transfer_param
SessionBoleto
payment_method_options_param
SessionCard
payment_method_options_param
SessionConsentCollection
consent_collection_params
SessionCurrencyOptionsValue
currency_option
SessionCustomerBalance
payment_method_options_param
SessionCustomerUpdate
customer_update_params
SessionCustomFieldsItem
custom_field_param
SessionCustomText
custom_text_param
SessionDeliveryEstimate
delivery_estimate
SessionDiscountsItem
subscription_update_confirm_discount_params
SessionDropdown
custom_field_dropdown_param
SessionEuBankTransfer
eu_bank_transfer_params
SessionFilters
filters_params
SessionFinancialConnections
linked_account_options_param
SessionFixedAmount
fixed_amount
SessionFlowData
flow_data_param
SessionHostedConfirmation
after_completion_hosted_confirmation_param
SessionInvoiceCreation
invoice_creation_params
SessionInvoiceData
invoice_data_params
SessionInvoiceSettings
invoice_settings_params
SessionItemsItem
subscription_update_confirm_item_params
SessionKonbini
payment_method_options_param
SessionLabel
custom_field_label_param
SessionLiability
param
SessionLineItemsItem
line_item_params
SessionMandateOptions
mandate_options_param
SessionNumeric
custom_field_numeric_param
SessionP24
payment_method_options_param
SessionPaymentIntentData
payment_intent_data_params
SessionPaymentMethodOptions
payment_method_options_param
SessionPaypal
payment_method_options_param
SessionPix
payment_method_options_param
SessionPriceData
price_data_with_product_data
SessionProductData
product_data
SessionRecovery
recovery_params
SessionRecurring
recurring_adhoc
SessionRenderingOptions
rendering_options_param
SessionRetention
retention_param
SessionsCustomerDetails
customer_details_params
SessionSetupIntentData
setup_intent_data_param
SessionShipping
shipping
SessionShippingAddress
address
SessionShippingOptionsItem
shipping_option_params
SessionShippingRateData
method_params
SessionSubscriptionCancel
flow_data_subscription_cancel_param
SessionSubscriptionData
subscription_data_params
SessionSubscriptionUpdateConfirm
flow_data_subscription_update_confirm_param
SessionSwish
payment_method_options_param
SessionTransferData
transfer_data_specs
SessionTrialSettings
trial_settings_config
SessionUsBankAccount
payment_method_options_param
SessionWechatPay
payment_method_options_param
SettingsDefaults
defaults_param
SettingsHeadOffice
head_office_param
SetupAttempt
PaymentFlowsSetupIntentSetupAttempt
SetupAttemptId
A SetupAttempt ID.
SetupAttemptOrId
A SetupAttempt or its ID.
SetupAttemptPaymentMethodDetails
SetupAttemptPaymentMethodDetails
SetupAttemptPaymentMethodDetailsBancontact
setup_attempt_payment_method_details_bancontact
SetupAttemptPaymentMethodDetailsCard
setup_attempt_payment_method_details_card
SetupAttemptPaymentMethodDetailsCardChecks
setup_attempt_payment_method_details_card_checks
SetupAttemptPaymentMethodDetailsCardPresent
setup_attempt_payment_method_details_card_present
SetupAttemptPaymentMethodDetailsCardThreeDSecure
Populated if this authorization used 3D Secure authentication.
SetupAttemptPaymentMethodDetailsCardWallet
If this Card is part of a card wallet, this contains the details of the card wallet.
SetupAttemptPaymentMethodDetailsIdeal
setup_attempt_payment_method_details_ideal
SetupAttemptPaymentMethodDetailsSofort
setup_attempt_payment_method_details_sofort
SetupIntent
SetupIntent
SetupIntentAcssDebit
setup_intent_payment_method_options_param
SetupIntentCanceledEvent
Occurs when a SetupIntent is canceled.
SetupIntentCancelOptions
SetupIntentCard
setup_intent_param
SetupIntentConfirmOptions
SetupIntentCreatedEvent
Occurs when a new SetupIntent is created.
SetupIntentCreateOptions
SetupIntentCreateOptionsPaymentMethodOptions
payment_method_options_param
SetupIntentId
A SetupIntent ID.
setup_intent_payment_method_options_param
SetupIntentMandateOptions
setup_intent_mandate_options_param
SetupIntentNextAction
If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
SetupIntentNextActionRedirectToUrl
SetupIntentNextActionRedirectToUrl
SetupIntentNextActionVerifyWithMicrodeposits
SetupIntentNextActionVerifyWithMicrodeposits
SetupIntentOrId
A SetupIntent or its ID.
SetupIntentPaymentMethodOptions
Payment method-specific configuration for this SetupIntent.
SetupIntentPaymentMethodOptionsAcssDebit
setup_intent_payment_method_options_acss_debit
SetupIntentPaymentMethodOptionsCard
setup_intent_payment_method_options_card
SetupIntentPaymentMethodOptionsCardMandateOptions
Configuration options for setting up an eMandate for cards issued in India.
setup_intent_payment_method_options_link
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit
setup_intent_payment_method_options_mandate_options_acss_debit
SetupIntentPaymentMethodOptionsPaypal
setup_intent_payment_method_options_paypal
SetupIntentPaymentMethodOptionsSepaDebit
setup_intent_payment_method_options_sepa_debit
SetupIntentPaymentMethodOptionsUsBankAccount
setup_intent_payment_method_options_us_bank_account
SetupIntentPaypal
payment_method_options_param
SetupIntentRequiresActionEvent
Occurs when a SetupIntent is in requires_action state.
SetupIntentSepaDebit
setup_intent_payment_method_options_param
SetupIntentSetupFailedEvent
Occurs when a SetupIntent has failed the attempt to setup a payment method.
SetupIntentSucceededEvent
Occurs when an SetupIntent has successfully setup a payment method.
SetupIntentThreeDSecure
setup_intent_payment_method_options_param
SetupIntentTypeSpecificPaymentMethodOptionsClient
SetupIntentTypeSpecificPaymentMethodOptionsClient
SetupIntentUpdateOptions
SetupIntentUsBankAccount
setup_intent_payment_method_options_param
Shipping
Shipping
ShippingRate
ShippingRate
ShippingRateCreateOptions
ShippingRateCurrencyOption
ShippingRateCurrencyOption
ShippingRateCurrencyOptionsValue
currency_option_update
ShippingRateDeliveryEstimate
The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
ShippingRateDeliveryEstimateBound
ShippingRateDeliveryEstimateBound
ShippingRateDeliveryEstimateMaximum
The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
ShippingRateFixedAmount
ShippingRateFixedAmount
ShippingRateId
A ShippingRate ID.
ShippingRateOrId
A ShippingRate or its ID.
ShippingRateUpdateOptions
SigmaScheduledQueryRunCreatedEvent
Occurs whenever a Sigma scheduled query run finishes.
SigmaScheduledQueryRunError
SigmaScheduledQueryRunError
Source
Source
SourceAcceptance
mandate_acceptance_params
SourceCanceledEvent
Occurs whenever a source is canceled.
SourceChargeableEvent
Occurs whenever a source transitions to chargeable.
SourceCodeVerificationFlow
SourceCodeVerificationFlow
SourceCreateOptions
SourceFailedEvent
Occurs whenever a source fails.
SourceItemsItem
order_item_specs
SourceMandate
mandate_params
SourceMandateNotification
SourceMandateNotification
SourceMandateNotificationAcssDebitData
SourceMandateNotificationAcssDebitData
SourceMandateNotificationBacsDebitData
SourceMandateNotificationBacsDebitData
SourceMandateNotificationEvent
Occurs whenever a source mandate notification method is set to manual.
SourceMandateNotificationSepaDebitData
SourceMandateNotificationSepaDebitData
SourceOffline
mandate_offline_acceptance_params
SourceOrder
SourceOrder
SourceOrderItem
SourceOrderItem
SourceOwner
Information about the owner of the payment instrument that may be used or required by particular source types.
SourceReceiver
receiver_params
SourceReceiverFlow
SourceReceiverFlow
SourceRedirectFlow
SourceRedirectFlow
SourceRefundAttributesRequiredEvent
Occurs whenever the refund attributes are required on a receiver source to process a refund or a mispayment.
SourceShipping
order_shipping
SourceTransaction
SourceTransaction
SourceTransactionAchCreditTransferData
SourceTransactionAchCreditTransferData
SourceTransactionChfCreditTransferData
SourceTransactionChfCreditTransferData
SourceTransactionCreatedEvent
Occurs whenever a source transaction is created.
SourceTransactionGbpCreditTransferData
SourceTransactionGbpCreditTransferData
SourceTransactionPaperCheckData
SourceTransactionPaperCheckData
SourceTransactionSepaCreditTransferData
SourceTransactionSepaCreditTransferData
SourceTransactionUpdatedEvent
Occurs whenever a source transaction is updated.
SourceTypeAchCreditTransfer
SourceTypeAchDebit
SourceTypeAcssDebit
SourceTypeAlipay
SourceTypeAuBecsDebit
SourceTypeBancontact
SourceTypeCard
SourceTypeCardPresent
SourceTypeEps
SourceTypeGiropay
SourceTypeIdeal
SourceTypeKlarna
SourceTypeMultibanco
SourceTypeP24
SourceTypeSepaCreditTransfer
SourceTypeSepaDebit
SourceTypeSofort
SourceTypeThreeDSecure
SourceTypeWechat
SourceUpdateOptions
SourceVerifyOptions
StripeEvent
StripeResource
Subscription
Subscription
SubscriptionAutomaticTax
SubscriptionAutomaticTax
SubscriptionBillingCycleAnchorConfig
The fixed values used to calculate the `billing_cycle_anchor`.
SubscriptionBillingThresholds
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
SubscriptionCancellationDetails
cancellation_details_param
SubscriptionCancelOptions
SubscriptionCard
subscription_payment_method_options_param
SubscriptionCreateOptions
SubscriptionCreateOptionsBillingCycleAnchorConfig
billing_cycle_anchor_config_param
SubscriptionCreateOptionsPaymentSettings
payment_settings
SubscriptionDetailsData
SubscriptionDetailsData
SubscriptionId
A Subscription ID.
SubscriptionInvoiceSettings
invoice_settings_param
SubscriptionItem
SubscriptionItem
SubscriptionItemBillingThresholds
Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
SubscriptionItemCreateOptions
SubscriptionItemDeleteOptions
SubscriptionItemId
A SubscriptionItem ID.
SubscriptionItemOrId
A SubscriptionItem or its ID.
SubscriptionItems
SubscriptionItemList
SubscriptionItemUpdateOptions
SubscriptionMandateOptions
mandate_options_param
SubscriptionOrId
A Subscription or its ID.
SubscriptionPauseCollection
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](/billing/subscriptions/pause-payment).
SubscriptionPaymentMethodOptions
payment_method_options
SubscriptionPaymentMethodOptionsCard
subscription_payment_method_options_card
SubscriptionPaymentSettings
Payment settings passed on to invoices created by the subscription.
SubscriptionPaymentSettingsPaymentMethodOptions
Payment-method-specific configuration to provide to invoices created by the subscription.
SubscriptionPaymentSettingsPaymentMethodOptionsCard
This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
SubscriptionPendingInvoiceItemInterval
Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
SubscriptionPendingUpdate
If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
SubscriptionResumeOptions
SubscriptionSchedule
SubscriptionSchedule
SubscriptionScheduleAbortedEvent
Occurs whenever a subscription schedule is canceled due to the underlying subscription being canceled because of delinquency.
SubscriptionScheduleAddInvoiceItem
SubscriptionScheduleAddInvoiceItem
SubscriptionScheduleAddInvoiceItemPrice
SubscriptionScheduleAddInvoiceItemPriceId
A SubscriptionScheduleAddInvoiceItemPrice ID.
SubscriptionScheduleAddInvoiceItemPriceOrId
A SubscriptionScheduleAddInvoiceItemPrice or its ID.
SubscriptionScheduleAddInvoiceItemsItem
add_invoice_item_entry
SubscriptionScheduleBillingThresholds
billing_thresholds_param
SubscriptionScheduleCanceledEvent
Occurs whenever a subscription schedule is canceled.
SubscriptionScheduleCancelOptions
SubscriptionScheduleCompletedEvent
Occurs whenever a new subscription schedule is completed.
SubscriptionScheduleConfigurationItem
SubscriptionScheduleConfigurationItem
SubscriptionScheduleConfigurationItemPlan
SubscriptionScheduleConfigurationItemPlanId
A SubscriptionScheduleConfigurationItemPlan ID.
SubscriptionScheduleConfigurationItemPlanOrId
A SubscriptionScheduleConfigurationItemPlan or its ID.
SubscriptionScheduleCreatedEvent
Occurs whenever a new subscription schedule is created.
SubscriptionScheduleCreateOptions
SubscriptionScheduleCurrentPhase
Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
SubscriptionScheduleDefaultSettings
default_settings_params
SubscriptionScheduleExpiringEvent
Occurs 7 days before a subscription schedule will expire.
SubscriptionScheduleId
A SubscriptionSchedule ID.
SubscriptionScheduleInvoiceSettings
subscription_schedule_default_settings_param
SubscriptionScheduleItemsItem
configuration_item_params
SubscriptionScheduleOrId
A SubscriptionSchedule or its ID.
SubscriptionSchedulePhaseConfiguration
SubscriptionSchedulePhaseConfiguration
SubscriptionSchedulePhaseConfigurationCoupon
SubscriptionSchedulePhaseConfigurationCouponId
A SubscriptionSchedulePhaseConfigurationCoupon ID.
SubscriptionSchedulePhaseConfigurationCouponOrId
A SubscriptionSchedulePhaseConfigurationCoupon or its ID.
SubscriptionSchedulePhasesItem
phase_configuration_params
SubscriptionScheduleReleasedEvent
Occurs whenever a new subscription schedule is released.
SubscriptionScheduleReleaseOptions
SubscriptionSchedulesResourceDefaultSettings
SubscriptionSchedulesResourceDefaultSettings
SubscriptionSchedulesResourceDefaultSettingsAutomaticTax
SubscriptionSchedulesResourceDefaultSettingsAutomaticTax
SubscriptionScheduleUpdatedEvent
Occurs whenever a subscription schedule is updated.
SubscriptionScheduleUpdateOptions
SubscriptionScheduleUpdateOptionsPhasesItem
phase_configuration_params
SubscriptionsResourceBillingCycleAnchorConfig
SubscriptionsResourceBillingCycleAnchorConfig
SubscriptionsResourcePauseCollection
SubscriptionsResourcePauseCollection
SubscriptionsResourcePaymentMethodOptions
SubscriptionsResourcePaymentMethodOptions
SubscriptionsResourcePaymentSettings
SubscriptionsResourcePaymentSettings
SubscriptionsResourcePendingUpdate
SubscriptionsResourcePendingUpdate
SubscriptionsTrialsResourceEndBehavior
SubscriptionsTrialsResourceEndBehavior
SubscriptionsTrialsResourceTrialSettings
SubscriptionsTrialsResourceTrialSettings
SubscriptionTransferData
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.
SubscriptionUpdateOptions
SubscriptionUpdateOptionsPauseCollection
pause_collection_param
TaxCalculation
TaxProductResourceTaxCalculation
TaxCalculationCreateOptions
TaxCalculationLineItem
TaxProductResourceTaxCalculationLineItem
TaxCalculationLineItems
TaxProductResourceTaxCalculationLineItemList
TaxCalculationShippingCost
The shipping cost details for the calculation.
TaxCode
TaxProductResourceTaxCode
TaxCodeId
A TaxCode ID.
TaxCodeOrId
A TaxCode or its ID.
TaxDeductedAtSource
TaxDeductedAtSource
TaxId
tax_id
TaxIdCreateOptions
TaxIdId
A TaxId ID.
TaxIdOrId
A TaxId or its ID.
TaxIDsOwner
TaxIDsOwner
TaxIdsOwner
owner_params
TaxIdVerification
Tax ID verification information.
TaxProductRegistrationsResourceCountryOptions
TaxProductRegistrationsResourceCountryOptions
TaxProductRegistrationsResourceCountryOptionsCanada
TaxProductRegistrationsResourceCountryOptionsCanada
TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard
TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard
TaxProductRegistrationsResourceCountryOptionsDefault
TaxProductRegistrationsResourceCountryOptionsDefault
TaxProductRegistrationsResourceCountryOptionsEurope
TaxProductRegistrationsResourceCountryOptionsEurope
TaxProductRegistrationsResourceCountryOptionsEuStandard
TaxProductRegistrationsResourceCountryOptionsEuStandard
TaxProductRegistrationsResourceCountryOptionsSimplified
TaxProductRegistrationsResourceCountryOptionsSimplified
TaxProductRegistrationsResourceCountryOptionsUnitedStates
TaxProductRegistrationsResourceCountryOptionsUnitedStates
TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax
TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax
TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax
TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax
TaxProductResourceCustomerDetails
TaxProductResourceCustomerDetails
TaxProductResourceCustomerDetailsAddress
The customer's postal address (for example, home or business location).
TaxProductResourceCustomerDetailsResourceTaxId
TaxProductResourceCustomerDetailsResourceTaxId
TaxProductResourceJurisdiction
TaxProductResourceJurisdiction
TaxProductResourceLineItemTaxBreakdown
TaxProductResourceLineItemTaxBreakdown
TaxProductResourceLineItemTaxBreakdownTaxRateDetails
Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
TaxProductResourceLineItemTaxRateDetails
TaxProductResourceLineItemTaxRateDetails
TaxProductResourcePostalAddress
TaxProductResourcePostalAddress
TaxProductResourceTaxBreakdown
TaxProductResourceTaxBreakdown
TaxProductResourceTaxCalculationShippingCost
TaxProductResourceTaxCalculationShippingCost
TaxProductResourceTaxRateDetails
TaxProductResourceTaxRateDetails
TaxProductResourceTaxSettingsDefaults
TaxProductResourceTaxSettingsDefaults
TaxProductResourceTaxSettingsHeadOffice
TaxProductResourceTaxSettingsHeadOffice
TaxProductResourceTaxSettingsStatusDetails
TaxProductResourceTaxSettingsStatusDetails
TaxProductResourceTaxSettingsStatusDetailsResourcePending
TaxProductResourceTaxSettingsStatusDetailsResourcePending
TaxProductResourceTaxTransactionLineItemResourceReversal
TaxProductResourceTaxTransactionLineItemResourceReversal
TaxProductResourceTaxTransactionResourceReversal
TaxProductResourceTaxTransactionResourceReversal
TaxProductResourceTaxTransactionShippingCost
TaxProductResourceTaxTransactionShippingCost
TaxRate
TaxRate
TaxRateCreatedEvent
Occurs whenever a new tax rate is created.
TaxRateCreateOptions
TaxRateId
A TaxRate ID.
TaxRateOrId
A TaxRate or its ID.
TaxRateUpdatedEvent
Occurs whenever a tax rate is updated.
TaxRateUpdateOptions
TaxRegistration
TaxProductRegistrationsResourceTaxRegistration
TaxRegistrationCreateOptions
TaxRegistrationUpdateOptions
TaxSettings
TaxProductResourceTaxSettings
TaxSettingsUpdatedEvent
Occurs whenever tax settings is updated.
TaxSettingsUpdateOptions
TaxTransaction
TaxProductResourceTaxTransaction
TaxTransactionCreateFromCalculationOptions
TaxTransactionCreateReversalOptions
TaxTransactionLineItem
TaxProductResourceTaxTransactionLineItem
TaxTransactionLineItemReversal
If `type=reversal`, contains information about what was reversed.
TaxTransactionLineItems
TaxProductResourceTaxTransactionLineItemList
TaxTransactionReversal
If `type=reversal`, contains information about what was reversed.
TerminalConfiguration
TerminalConfigurationConfiguration
TerminalConfigurationConfigurationResourceCurrencySpecificConfig
TerminalConfigurationConfigurationResourceCurrencySpecificConfig
TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig
TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig
TerminalConfigurationConfigurationResourceOfflineConfig
TerminalConfigurationConfigurationResourceOfflineConfig
TerminalConfigurationConfigurationResourceTipping
TerminalConfigurationConfigurationResourceTipping
TerminalConfigurationCreateOptions
TerminalConfigurationUpdateOptions
TerminalConnectionToken
TerminalConnectionToken
TerminalConnectionTokenCreateOptions
TerminalLocation
TerminalLocationLocation
TerminalLocationCreateOptions
TerminalLocationId
A TerminalLocation ID.
TerminalLocationOrId
A TerminalLocation or its ID.
TerminalLocationUpdateOptions
TerminalReader
TerminalReaderReader
TerminalReaderAction
The most recent action performed by the reader.
TerminalReaderActionFailedEvent
Occurs whenever an action sent to a Terminal reader failed.
TerminalReaderActionSucceededEvent
Occurs whenever an action sent to a Terminal reader was successful.
TerminalReaderCreateOptions
TerminalReaderPresentPaymentMethodOptions
TerminalReaderProcessPaymentIntentOptions
TerminalReaderProcessSetupIntentOptions
TerminalReaderReaderResourceCart
TerminalReaderReaderResourceCart
TerminalReaderReaderResourceLineItem
TerminalReaderReaderResourceLineItem
TerminalReaderReaderResourceProcessConfig
TerminalReaderReaderResourceProcessConfig
TerminalReaderReaderResourceProcessPaymentIntentAction
TerminalReaderReaderResourceProcessPaymentIntentAction
TerminalReaderReaderResourceProcessSetupConfig
TerminalReaderReaderResourceProcessSetupConfig
TerminalReaderReaderResourceProcessSetupIntentAction
TerminalReaderReaderResourceProcessSetupIntentAction
TerminalReaderReaderResourceReaderAction
TerminalReaderReaderResourceReaderAction
TerminalReaderReaderResourceRefundPaymentAction
TerminalReaderReaderResourceRefundPaymentAction
TerminalReaderReaderResourceRefundPaymentConfig
TerminalReaderReaderResourceRefundPaymentConfig
TerminalReaderReaderResourceSetReaderDisplayAction
TerminalReaderReaderResourceSetReaderDisplayAction
TerminalReaderReaderResourceTippingConfig
TerminalReaderReaderResourceTippingConfig
TerminalReaderRefundPaymentOptions
TerminalReaderSetReaderDisplayOptions
TerminalReaderUpdateOptions
TestHelpersTestClock
TestClock
TestHelpersTestClockAdvanceOptions
TestHelpersTestClockAdvancingEvent
Occurs whenever a test clock starts advancing.
TestHelpersTestClockCreatedEvent
Occurs whenever a test clock is created.
TestHelpersTestClockCreateOptions
TestHelpersTestClockDeletedEvent
Occurs whenever a test clock is deleted.
TestHelpersTestClockId
A TestHelpersTestClock ID.
TestHelpersTestClockInternalFailureEvent
Occurs whenever a test clock fails to advance its frozen time.
TestHelpersTestClockOrId
A TestHelpersTestClock or its ID.
TestHelpersTestClockReadyEvent
Occurs whenever a test clock transitions to a ready status.
ThreeDSecureDetails
three_d_secure_details
ThreeDSecureDetailsCharge
three_d_secure_details_charge
ThreeDSecureUsage
three_d_secure_usage
Token
Token
TokenAccount
connect_js_account_token_specs
TokenAdditionalTosAcceptances
person_additional_tos_acceptances_specs
TokenBankAccount
token_create_bank_account
TokenCard
TokenCardCreditCardSpecs
credit_card_specs
TokenCardNetworks
token_card_networks
TokenCompany
connect_js_account_token_company_specs
TokenCreateOptions
TokenCvcUpdate
cvc_params
TokenPerson
person_token_specs
TokenPii
pii_token_specs
TokenRelationship
relationship_specs
Topup
Topup
TopupCanceledEvent
Occurs whenever a top-up is canceled.
TopupCreatedEvent
Occurs whenever a top-up is created.
TopupCreateOptions
TopupFailedEvent
Occurs whenever a top-up fails.
TopupReversedEvent
Occurs whenever a top-up is reversed.
TopupSucceededEvent
Occurs whenever a top-up succeeds.
TransactionLineItemsItem
transaction_line_item_reversal
TransactionShippingCost
transaction_shipping_cost_reversal
TransactionsStatusTransitions
status_transition_timestamp_specs
TransactionsTransactionRefresh
transaction_refresh_params
Transfer
Transfer
TransferCreatedEvent
Occurs whenever a transfer is created.
TransferCreateOptions
TransferData
transfer_data
TransferId
A Transfer ID.
TransferOrId
A Transfer or its ID.
TransferReversal
TransferReversal
TransferReversalCreateOptions
TransferReversalId
A TransferReversal ID.
TransferReversalOrId
A TransferReversal or its ID.
TransferReversals
TransferReversalList
TransferReversedEvent
Occurs whenever a transfer is reversed, including partial reversals.
TransferSchedule
TransferSchedule
TransferUpdatedEvent
Occurs whenever a transfer's description or metadata is updated.
TransformQuantity
TransformQuantity
TransformUsage
TransformUsage
TreasuryCreditReversal
TreasuryReceivedCreditsResourceCreditReversal
TreasuryCreditReversalCreatedEvent
Occurs whenever an CreditReversal is submitted and created.
TreasuryCreditReversalCreateOptions
TreasuryCreditReversalPostedEvent
Occurs whenever an CreditReversal post is posted.
TreasuryDebitReversal
TreasuryReceivedDebitsResourceDebitReversal
TreasuryDebitReversalCompletedEvent
Occurs whenever a DebitReversal is completed.
TreasuryDebitReversalCreatedEvent
Occurs whenever a DebitReversal is created.
TreasuryDebitReversalCreateOptions
TreasuryDebitReversalInitialCreditGrantedEvent
Occurs whenever an initial credit is granted on a DebitReversal.
TreasuryDebitReversalLinkedFlows
Other flows linked to a DebitReversal.
TreasuryFinancialAccount
TreasuryFinancialAccountsResourceFinancialAccount
TreasuryFinancialAccountClosedEvent
Occurs whenever the status of the FinancialAccount becomes closed.
TreasuryFinancialAccountCreatedEvent
Occurs whenever a new FinancialAccount is created.
TreasuryFinancialAccountCreateOptions
TreasuryFinancialAccountFeatures
TreasuryFinancialAccountsResourceFinancialAccountFeatures
TreasuryFinancialAccountFeaturesStatusUpdatedEvent
Occurs whenever the statuses of any features within an existing FinancialAccount are updated.
TreasuryFinancialAccountPlatformRestrictions
The set of functionalities that the platform can restrict on the FinancialAccount.
TreasuryFinancialAccountsResourceAbaRecord
TreasuryFinancialAccountsResourceABARecord
TreasuryFinancialAccountsResourceAbaToggleSettings
TreasuryFinancialAccountsResourceAbaToggleSettings
TreasuryFinancialAccountsResourceAchToggleSettings
TreasuryFinancialAccountsResourceAchToggleSettings
TreasuryFinancialAccountsResourceBalance
TreasuryFinancialAccountsResourceBalance
TreasuryFinancialAccountsResourceClosedStatusDetails
TreasuryFinancialAccountsResourceClosedStatusDetails
TreasuryFinancialAccountsResourceFinancialAddress
TreasuryFinancialAccountsResourceFinancialAddress
TreasuryFinancialAccountsResourceFinancialAddressesFeatures
TreasuryFinancialAccountsResourceFinancialAddressesFeatures
TreasuryFinancialAccountsResourceInboundTransfers
TreasuryFinancialAccountsResourceInboundTransfers
TreasuryFinancialAccountsResourceOutboundPayments
TreasuryFinancialAccountsResourceOutboundPayments
TreasuryFinancialAccountsResourceOutboundTransfers
TreasuryFinancialAccountsResourceOutboundTransfers
TreasuryFinancialAccountsResourcePlatformRestrictions
TreasuryFinancialAccountsResourcePlatformRestrictions
TreasuryFinancialAccountsResourceStatusDetails
TreasuryFinancialAccountsResourceStatusDetails
TreasuryFinancialAccountsResourceToggleSettings
TreasuryFinancialAccountsResourceToggleSettings
TreasuryFinancialAccountsResourceTogglesSettingStatusDetails
TreasuryFinancialAccountsResourceTogglesSettingStatusDetails
TreasuryFinancialAccountUpdateFeaturesOptions
TreasuryFinancialAccountUpdateOptions
TreasuryInboundTransfer
TreasuryInboundTransfersResourceInboundTransfer
TreasuryInboundTransferCanceledEvent
Occurs whenever an InboundTransfer is canceled.
TreasuryInboundTransferCreatedEvent
Occurs whenever an InboundTransfer is created.
TreasuryInboundTransferCreateOptions
TreasuryInboundTransferFailedEvent
Occurs whenever an InboundTransfer has failed.
TreasuryInboundTransferFailOptions
TreasuryInboundTransferFailureDetails
Details about this InboundTransfer's failure. Only set when status is `failed`.
TreasuryInboundTransfersResourceFailureDetails
TreasuryInboundTransfersResourceFailureDetails
TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows
TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows
TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions
TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions
TreasuryInboundTransferSucceededEvent
Occurs whenever an InboundTransfer has succeeded.
TreasuryOutboundPayment
TreasuryOutboundPaymentsResourceOutboundPayment
TreasuryOutboundPaymentCanceledEvent
Occurs whenever an OutboundPayment is canceled.
TreasuryOutboundPaymentCreatedEvent
Occurs whenever a new OutboundPayment is successfully created.
TreasuryOutboundPaymentCreateOptions
TreasuryOutboundPaymentEndUserDetails
Details about the end user.
TreasuryOutboundPaymentExpectedArrivalDateUpdatedEvent
Occurs whenever the arrival date on an OutboundPayment updates.
TreasuryOutboundPaymentFailedEvent
Occurs whenever an OutboundPayment fails.
TreasuryOutboundPaymentPostedEvent
Occurs whenever an OutboundPayment posts.
TreasuryOutboundPaymentReturnedDetails
Details about a returned OutboundPayment. Only set when the status is `returned`.
TreasuryOutboundPaymentReturnedEvent
Occurs whenever an OutboundPayment was returned.
TreasuryOutboundPaymentReturnOutboundPaymentOptions
TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails
TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails
TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions
TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions
TreasuryOutboundPaymentsResourceReturnedStatus
TreasuryOutboundPaymentsResourceReturnedStatus
TreasuryOutboundTransfer
TreasuryOutboundTransfersResourceOutboundTransfer
TreasuryOutboundTransferCanceledEvent
Occurs whenever an OutboundTransfer is canceled.
TreasuryOutboundTransferCreatedEvent
Occurs whenever an OutboundTransfer is created.
TreasuryOutboundTransferCreateOptions
TreasuryOutboundTransferExpectedArrivalDateUpdatedEvent
Occurs whenever the arrival date on an OutboundTransfer updates.
TreasuryOutboundTransferFailedEvent
Occurs whenever an OutboundTransfer has failed.
TreasuryOutboundTransferPostedEvent
Occurs whenever an OutboundTransfer is posted.
TreasuryOutboundTransferReturnedEvent
Occurs whenever an OutboundTransfer is returned.
TreasuryOutboundTransfersResourceReturnedDetails
TreasuryOutboundTransfersResourceReturnedDetails
TreasuryOutboundTransfersResourceStatusTransitions
TreasuryOutboundTransfersResourceStatusTransitions
TreasuryReceivedCredit
TreasuryReceivedCreditsResourceReceivedCredit
TreasuryReceivedCreditCreatedEvent
Occurs whenever a received_credit is created as a result of funds being pushed by another account.
TreasuryReceivedCreditCreateOptions
TreasuryReceivedCreditFailedEvent
Occurs whenever a received_credit transitions to failed state. Only applicable for check deposits.
TreasuryReceivedCreditReversalDetails
Details describing when a ReceivedCredit may be reversed.
TreasuryReceivedCreditsResourceLinkedFlows
TreasuryReceivedCreditsResourceLinkedFlows
TreasuryReceivedCreditsResourceLinkedFlowsSourceFlowDetails
The expandable object of the source flow.
TreasuryReceivedCreditsResourceReversalDetails
TreasuryReceivedCreditsResourceReversalDetails
TreasuryReceivedCreditsResourceSourceFlowsDetails
TreasuryReceivedCreditsResourceSourceFlowsDetails
TreasuryReceivedCreditsResourceStatusTransitions
TreasuryReceivedCreditsResourceStatusTransitions
TreasuryReceivedCreditSucceededEvent
Occurs whenever a received_credit transitions to succeeded state. Only applicable for check deposits.
TreasuryReceivedDebit
TreasuryReceivedDebitsResourceReceivedDebit
TreasuryReceivedDebitCreatedEvent
Occurs whenever a received_debit is created as a result of funds being pulled by another account.
TreasuryReceivedDebitCreateOptions
TreasuryReceivedDebitsResourceDebitReversalLinkedFlows
TreasuryReceivedDebitsResourceDebitReversalLinkedFlows
TreasuryReceivedDebitsResourceLinkedFlows
TreasuryReceivedDebitsResourceLinkedFlows
TreasuryReceivedDebitsResourceReversalDetails
TreasuryReceivedDebitsResourceReversalDetails
TreasuryReceivedDebitsResourceStatusTransitions
TreasuryReceivedDebitsResourceStatusTransitions
TreasurySharedResourceBillingDetails
TreasurySharedResourceBillingDetails
TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails
TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails
TreasurySharedResourceInitiatingPaymentMethodDetailsUsBankAccount
TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount
TreasuryTransaction
TreasuryTransactionsResourceTransaction
TreasuryTransactionEntries
TreasuryTransactionsResourceTransactionEntryList
TreasuryTransactionEntry
TreasuryTransactionsResourceTransactionEntry
TreasuryTransactionFlowDetails
Details of the flow that created the Transaction.
TreasuryTransactionId
A TreasuryTransaction ID.
TreasuryTransactionOrId
A TreasuryTransaction or its ID.
TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions
TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions
TreasuryTransactionsResourceBalanceImpact
TreasuryTransactionsResourceBalanceImpact
TreasuryTransactionsResourceFlowDetails
TreasuryTransactionsResourceFlowDetails
UpcomingCustomerDetails
customer_details_param
UpcomingCustomerDetailsTax
tax_param
UpcomingDiscountsItem
discounts_data_param
UpcomingInvoiceItemsItem
invoice_item_preview_params
UpcomingSubscriptionItemsItem
subscription_item_update_params
UpcomingSubscriptionItemsItemBillingThresholds
item_billing_thresholds_param
UpcomingSubscriptionItemsItemPriceData
recurring_price_data
UsageRecord
UsageRecord
UsageRecordCreateOptions
UsageRecordSummary
UsageRecordSummary
UsBankAccountNetworks
us_bank_account_networks
VerificationSessionOptions
session_options_param
VerificationSessionRedaction
verification_session_redaction
WebhookEndpoint
NotificationWebhookEndpoint
WebhookEndpointCreateOptions
WebhookEndpointUpdateOptions

Extension Types

AccountBusinessType
AccountCapabilitiesAcssDebitPayments
AccountCreateOptionsBusinessType
AccountDelayDays
AccountFeaturesItem
AccountInterval
AccountLinkCollect
AccountLinkFutureRequirements
AccountLinkType
AccountRequirementsErrorCode
AccountStructure
AccountType
AccountUnificationAccountControllerType
AccountWeeklyAnchor
ApiErrorsCode
ApiErrorsType
AuthorizationCategory
AuthorizationType
AuthorizationUnit
AutomaticTaxLiabilityType
AutomaticTaxStatus
BalanceTransactionType
BankAccountAvailablePayoutMethodsItem
BankConnectionsResourceAccountholderType
BankConnectionsResourceBalanceRefreshStatus
BankConnectionsResourceBalanceType
BillingMeterEventAdjustmentStatus
BillingMeterEventTimeWindow
BillingMeterResourceAggregationSettingsFormula
BillingMeterStatus
BillingPortalSessionFlowType
BillingPortalSessionLocale
CalculationAddressSource
CancellationDetailsFeedback
CancellationDetailsReason
CapabilityStatus
CardCancellationReason
CardMandatePaymentMethodDetails
CardReplacementReason
ChargeUserReport
CheckoutAcssDebitMandateOptionsDefaultForItem
CheckoutAcssDebitMandateOptionsPaymentSchedule
CheckoutAcssDebitMandateOptionsTransactionType
CheckoutAcssDebitPaymentMethodOptionsCurrency
CheckoutAcssDebitPaymentMethodOptionsSetupFutureUsage
CheckoutAcssDebitPaymentMethodOptionsVerificationMethod
CheckoutCardPaymentMethodOptionsRequestThreeDSecure
CheckoutCustomerBalanceBankTransferPaymentMethodOptionsRequestedAddressTypesItem
CheckoutCustomerBalanceBankTransferPaymentMethodOptionsType
CheckoutLinkPaymentMethodOptionsSetupFutureUsage
CheckoutRevolutPayPaymentMethodOptions
CheckoutSessionBillingAddressCollection
CheckoutSessionConsentCollectionPaymentMethodReuseAgreementPosition
CheckoutSessionConsentCollectionPromotions
CheckoutSessionConsentCollectionTermsOfService
CheckoutSessionConsentPromotions
CheckoutSessionCreateOptionsLocale
CheckoutSessionCustomerCreation
CheckoutSessionCustomerDetailsTaxExempt
CheckoutSessionLocale
CheckoutSessionMode
CheckoutSessionPaymentStatus
CheckoutSessionRedirectOnCompletion
CheckoutSessionShippingAddressCollectionAllowedCountriesItem
CheckoutSessionStatus
CheckoutSessionSubmitType
CheckoutSessionUiMode
CheckoutUsBankAccountPaymentMethodOptionsVerificationMethod
ClimateOrderCancellationReason
ClimateOrderStatus
ClimateSupplierRemovalPathway
ConfirmationTokenPaymentMethodPreviewType
ConfirmationTokenSetupFutureUsage
ConnectEmbeddedAccountFeatures
ConnectEmbeddedBaseFeatures
CouponDuration
CreditNoteCreateOptionsReason
CreditNoteLineItemType
CreditNoteReason
CreditNoteStatus
CreditNoteTaxAmountTaxabilityReason
CreditNoteType
CurrencyOptionTaxBehavior
CustomerAcceptanceType
CustomerBalanceCustomerBalanceSettingsReconciliationMode
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransferNetwork
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferType
CustomerBalanceTransactionType
CustomerCashBalanceTransactionType
CustomerReconciliationMode
CustomerRequestedAddressTypesItem
CustomerTaxAutomaticTax
CustomerTaxExempt
CustomerTaxLocationSource
CustomerType
CustomerValidateLocation
DebitReversalsResolution
DebitReversalsStatus
DestinationDetailsUnimplemented
DisputeProductType
DisputeReturnStatus
DisputeStatus
EventType
ExternalAccountAccountHolderType
ExternalAccountAccountType
FileCreateOptionsPurpose
FileLinkExpiresAt
FilePurpose
FinancialAccountInboundFlows
FinancialConnectionsAccountCategory
FinancialConnectionsAccountPermissionsItem
FinancialConnectionsAccountStatus
FinancialConnectionsAccountSubcategory
FinancialConnectionsAccountSupportedPaymentMethodTypesItem
FinancialConnectionsSessionPrefetchItem
FinancialConnectionsTransactionStatus
ForwardingRequestReplacementsItem
FundingInstructionsBankTransferFinancialAddressSupportedNetworksItem
FundingInstructionsBankTransferFinancialAddressType
FundingInstructionsBankTransferType
GelatoDocumentReportErrorCode
GelatoDocumentReportStatus
GelatoDocumentReportType
GelatoIdNumberReportErrorCode
GelatoIdNumberReportIdNumberType
GelatoReportDocumentOptionsAllowedTypesItem
GelatoReportIdNumberOptions
GelatoSelfieReportErrorCode
GelatoSessionIdNumberOptions
GelatoSessionLastErrorCode
IdentityVerificationReportType
IdentityVerificationSessionRedactionStatus
IdentityVerificationSessionStatus
InboundTransfersPaymentMethodDetailsUsBankAccountAccountHolderType
InboundTransfersPaymentMethodDetailsUsBankAccountAccountType
InvoiceBillingReason
InvoiceCollectionMethod
InvoiceitemPlanAggregateUsage
InvoiceitemPlanBillingScheme
InvoiceitemPlanInterval
InvoiceitemPlanTiersMode
InvoiceitemPlanTransformUsageRound
InvoiceitemPlanUsageType
InvoiceitemPriceType
InvoiceMandateOptionsCardAmountType
InvoicePageSize
InvoicePaymentMethodOptionsBancontactPreferredLanguage
InvoicePaymentMethodOptionsCardRequestThreeDSecure
InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferCountry
InvoicePaymentMethodOptionsKonbini
InvoicePaymentMethodOptionsSepaDebit
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsPermissionsItem
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsPrefetchItem
InvoicePendingInvoiceItemsBehavior
InvoiceRenderingPdfPageSize
InvoicesPaymentSettingsPaymentMethodTypesItem
InvoicesResourceInvoiceTaxIdType
InvoicesStatus
InvoiceStatus
IssuingAuthorizationAuthenticationExemptionClaimedBy
IssuingAuthorizationAuthenticationExemptionType
IssuingAuthorizationAuthorizationMethod
IssuingAuthorizationRequestReason
IssuingAuthorizationStatus
IssuingAuthorizationThreeDSecureResult
IssuingAuthorizationVerificationDataAddressLine1Check
IssuingCardApplePayIneligibleReason
IssuingCardCancellationReason
IssuingCardholderPreferredLocalesItem
IssuingCardholderRequirementsDisabledReason
IssuingCardholderRequirementsPastDueItem
IssuingCardholderSpendingControlsAllowedCategoriesItem
IssuingCardholderStatus
IssuingCardholderType
IssuingCardReplacementReason
IssuingCardShippingCarrier
IssuingCardShippingService
IssuingCardShippingStatus
IssuingCardShippingType
IssuingCardSpendingLimitInterval
IssuingCardStatus
IssuingCardType
IssuingDisputeCanceledEvidenceProductType
IssuingDisputeCanceledEvidenceReturnStatus
IssuingDisputeEvidenceReason
IssuingDisputeStatus
IssuingNetworkTokenDeviceType
IssuingNetworkTokenWalletProviderCardNumberSource
IssuingNetworkTokenWalletProviderReasonCodesItem
IssuingNetworkTokenWalletProviderSuggestedDecision
IssuingPersonalizationDesignRejectionReasonsCardLogoItem
IssuingPersonalizationDesignRejectionReasonsCarrierTextItem
IssuingPersonalizationDesignStatus
IssuingPhysicalBundleStatus
IssuingPhysicalBundleType
IssuingTokenNetwork
IssuingTokenStatus
IssuingTokenWalletProvider
IssuingTransactionType
IssuingTransactionWallet
LegalEntityCompanyStructure
LineItemType
LinesSubscriptionBillingCycleAnchor
LinesSubscriptionTrialEnd
MandateAcssDebitPaymentSchedule
MandateAcssDebitTransactionType
MandateBacsDebitNetworkStatus
MandateBacsDebitRevocationReason
MandateCashapp
MandateMultiUse
MandateType
MeterEventTimeWindow
OfflineAcceptance
OutboundPaymentsPaymentMethodDetailsType
OutboundPaymentsPaymentMethodDetailsUsBankAccountNetwork
PaymentFlowsAutomaticPaymentMethodsPaymentIntentAllowRedirects
PaymentFlowsPrivatePaymentMethodsAlipay
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorizationStatus
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorizationStatus
PaymentIntentAccountType
PaymentIntentAresTransStatus
PaymentIntentBank
PaymentIntentBlikSetupFutureUsage
PaymentIntentCancellationReason
PaymentIntentCancelOptionsCancellationReason
PaymentIntentCaptureMethod
PaymentIntentCbAvalgo
PaymentIntentCollectionMethod
PaymentIntentCountry
PaymentIntentElectronicCommerceIndicator
PaymentIntentExemptionIndicator
PaymentIntentIdealBank
PaymentIntentNetwork
PaymentIntentNextActionVerifyWithMicrodepositsMicrodepositType
PaymentIntentOffSession
PaymentIntentP24Bank
PaymentIntentPaymentMethodOptionsCardMandateOptionsAmountType
PaymentIntentPaymentMethodOptionsCardMandateOptionsInterval
PaymentIntentPaymentMethodOptionsCardNetwork
PaymentIntentPaymentMethodOptionsCardRequestExtendedAuthorization
PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebit
PaymentIntentPaymentMethodOptionsUsBankAccountPreferredSettlementSpeed
PaymentIntentPreferredLanguage
PaymentIntentPreferredLocale
PaymentIntentPreferredSettlementSpeed
PaymentIntentSetupFutureUsage
PaymentIntentStatus
PaymentIntentType
PaymentIntentTypeSpecificPaymentMethodOptionsClientCaptureMethod
PaymentIntentUpdateOptionsSetupFutureUsage
PaymentIntentVersion
PaymentLinkBillingAddressCollection
PaymentLinkCustomerCreation
PaymentLinkPaymentIntentDataCaptureMethod
PaymentLinkPaymentMethodTypesItem
PaymentLinksResourceAfterCompletionType
PaymentLinksResourceCustomFieldsType
PaymentLinkSubmitType
PaymentMethodAffirm
PaymentMethodAfterpayClearpay
PaymentMethodBancontact
PaymentMethodBlik
PaymentMethodCardPresentReadMethod
PaymentMethodCardWalletAmexExpressCheckout
PaymentMethodCardWalletApplePay
PaymentMethodCardWalletGooglePay
PaymentMethodCardWalletSamsungPay
PaymentMethodCardWalletType
PaymentMethodConfigResourceDisplayPreferencePreference
PaymentMethodConfigResourceDisplayPreferenceValue
PaymentMethodCustomerBalance
PaymentMethodDetailsAffirm
PaymentMethodDetailsBancontactPreferredLanguage
PaymentMethodDetailsBlik
PaymentMethodDetailsCardPresentReceiptAccountType
PaymentMethodDetailsCardThreeDSecureAuthenticationFlow
PaymentMethodDetailsCardThreeDSecureElectronicCommerceIndicator
PaymentMethodDetailsCardThreeDSecureExemptionIndicator
PaymentMethodDetailsCardThreeDSecureResult
PaymentMethodDetailsCardThreeDSecureResultReason
PaymentMethodDetailsCardThreeDSecureVersion
PaymentMethodDetailsCardWalletAmexExpressCheckout
PaymentMethodDetailsCardWalletApplePay
PaymentMethodDetailsCardWalletGooglePay
PaymentMethodDetailsCardWalletSamsungPay
PaymentMethodDetailsCustomerBalance
PaymentMethodDetailsEpsBank
PaymentMethodDetailsFpxBank
PaymentMethodDetailsIdealBank
PaymentMethodDetailsIdealBic
PaymentMethodDetailsInteracPresentReceiptAccountType
PaymentMethodDetailsKonbiniStoreChain
PaymentMethodDetailsP24Bank
PaymentMethodDetailsPaypalSellerProtectionDisputeCategoriesItem
PaymentMethodDetailsPaypalSellerProtectionStatus
PaymentMethodDetailsRevolutPay
PaymentMethodDetailsSofortPreferredLanguage
PaymentMethodDetailsStripeAccount
PaymentMethodDetailsWechat
PaymentMethodDetailsZip
PaymentMethodGiropay
PaymentMethodGrabpay
PaymentMethodKonbini
PaymentMethodMobilepay
PaymentMethodOptionsInteracPresent
PaymentMethodOptionsRevolutPay
PaymentMethodOptionsWechatPayClient
PaymentMethodOxxo
PaymentMethodPaynow
PaymentMethodPix
PaymentMethodPreferred
PaymentMethodPromptpay
PaymentMethodRevolutPay
PaymentMethodsType
PaymentMethodSwish
PaymentMethodUpdateOptionsCardNetworksPreferred
PaymentMethodUsBankAccountBlockedNetworkCode
PaymentMethodUsBankAccountBlockedReason
PaymentMethodWechatPay
PaymentMethodZip
PayoutReconciliationStatus
PayoutSourceType
PayoutType
PersonPoliticalExposure
PlanAggregateUsage
PlanTiersMode
PlanUpTo
PortalCustomerUpdateAllowedUpdatesItem
PortalFlowsFlowAfterCompletionType
PortalSubscriptionCancellationReasonOptionsItem
PortalSubscriptionCancelMode
PortalSubscriptionCancelProrationBehavior
PortalSubscriptionUpdateDefaultAllowedUpdatesItem
ProductType
QuoteEffectiveDate
QuoteStatus
RadarValueListItemType
ReaderType
RefundDestinationDetailsCardType
RefundReason
RegistrationActiveFrom
RegistrationExpiresAt
RegistrationsStatus
ReportRunReportingCategory
ReportRunTimezone
ReviewClosedReason
ReviewOpenedReason
SecretServiceResourceScopeType
SessionAddress
SessionAmountTaxDisplay
SessionCaptureMethod
SessionClient
SessionLocale
SessionPaymentMethodTypesItem
SessionPaypalSetupFutureUsage
SessionPreferredLocale
SessionPromotions
SessionProrationBehavior
SessionSetupFutureUsage
SessionsStatus
SessionTermsOfService
SessionUiMode
SettingsTaxBehavior
SetupAttemptFlowDirectionsItem
SetupAttemptPaymentMethodDetailsAcssDebit
SetupAttemptPaymentMethodDetailsAuBecsDebit
SetupAttemptPaymentMethodDetailsBacsDebit
SetupAttemptPaymentMethodDetailsBoleto
SetupAttemptPaymentMethodDetailsCardWalletType
SetupAttemptPaymentMethodDetailsCashapp
SetupAttemptPaymentMethodDetailsKlarna
SetupAttemptPaymentMethodDetailsPaypal
SetupAttemptPaymentMethodDetailsSepaDebit
SetupAttemptPaymentMethodDetailsUsBankAccount
SetupIntentCancellationReason
SetupIntentCancelOptionsCancellationReason
SetupIntentPaymentMethodOptionsAcssDebitCurrency
SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit
SetupIntentStatus
ShippingRateCurrencyOptionTaxBehavior
ShippingRateDeliveryEstimateMaximumUnit
SourceFlow
SourceInterval
SourceItemsItemType
SourceNotificationMethod
SourceRefundAttributesMethod
SourceTransactionType
SourceType
SourceUsage
SubscriptionBillingCycleAnchor
SubscriptionFeedback
SubscriptionItemPaymentBehavior
SubscriptionPauseCollectionBehavior
SubscriptionPaymentSettingsSaveDefaultPaymentMethod
SubscriptionSaveDefaultPaymentMethod
SubscriptionScheduleEndBehavior
SubscriptionScheduleEndDate
SubscriptionSchedulePhaseConfigurationBillingCycleAnchor
SubscriptionSchedulePhaseConfigurationCollectionMethod
SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor
SubscriptionScheduleStartDate
SubscriptionScheduleStatus
SubscriptionScheduleTrialEnd
SubscriptionsStatus
SubscriptionStatus
SubscriptionsTrialsResourceEndBehaviorMissingPaymentMethod
SubscriptionTrialEnd
TaxCalculationShippingCostTaxBehavior
TaxIDsOwnerType
TaxIdVerificationStatus
TaxProductRegistrationsResourceCountryOptionsCanadaType
TaxProductRegistrationsResourceCountryOptionsEuropeType
TaxProductRegistrationsResourceCountryOptionsEuStandardPlaceOfSupplyScheme
TaxProductRegistrationsResourceCountryOptionsUnitedStatesType
TaxProductResourceCustomerDetailsAddressSource
TaxProductResourceCustomerDetailsTaxabilityOverride
TaxProductResourceJurisdictionLevel
TaxProductResourceLineItemTaxBreakdownSourcing
TaxProductResourceLineItemTaxBreakdownTaxabilityReason
TaxProductResourceLineItemTaxBreakdownTaxRateDetailsTaxType
TaxProductResourceTaxRateDetailsTaxType
TaxProductResourceTaxSettingsDefaultsTaxBehavior
TaxProductResourceTaxSettingsStatusDetailsResourceActive
TaxRateJurisdictionLevel
TaxRegistrationStatus
TaxSettingsStatus
TaxTransactionType
TerminalReaderActionStatus
TerminalReaderActionType
TerminalReaderDeviceType
TerminalReaderReaderResourceRefundPaymentActionReason
TerminalReaderStatus
TestHelpersTestClockStatus
TokenStatus
TopupsStatus
TopupStatus
TransactionEntriesOrderBy
TransactionMode
TransactionsOrderBy
TreasuryCreditReversalNetwork
TreasuryCreditReversalStatus
TreasuryDebitReversalNetwork
TreasuryDebitReversalStatus
TreasuryFinancialAccountActiveFeaturesItem
TreasuryFinancialAccountPlatformRestrictionsInboundFlows
TreasuryFinancialAccountsResourceAbaToggleSettingsStatus
TreasuryFinancialAccountsResourceClosedStatusDetailsReasonsItem
TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsCode
TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsResolution
TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsRestriction
TreasuryFinancialAccountStatus
TreasuryInboundTransferFailureDetailsCode
TreasuryInboundTransferStatus
TreasuryOutboundPaymentReturnedDetailsCode
TreasuryOutboundPaymentStatus
TreasuryReceivedCreditFailureCode
TreasuryReceivedCreditNetwork
TreasuryReceivedCreditReversalDetailsRestrictedReason
TreasuryReceivedCreditsResourceLinkedFlowsSourceFlowDetailsType
TreasuryReceivedCreditStatus
TreasuryReceivedDebitFailureCode
TreasuryReceivedDebitNetwork
TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetailsType
TreasuryTransactionEntryType
TreasuryTransactionFlowDetailsType
TreasuryTransactionStatus
UpcomingSubscriptionBillingCycleAnchor
UpcomingSubscriptionTrialEnd
UsageRecordAction
UsageRecordTimestamp
WebhookEndpointApiVersion
WebhookEndpointEnabledEventsItem

Exceptions / Errors

Error
An error response from the Stripe API