diff --git a/.latest-tag-stripe-openapi-sdk b/.latest-tag-stripe-openapi-sdk index 931be459..8ea7941f 100644 --- a/.latest-tag-stripe-openapi-sdk +++ b/.latest-tag-stripe-openapi-sdk @@ -1 +1 @@ -v1214 +v1254 diff --git a/lib/generated/account.ex b/lib/generated/account.ex index 051a83a7..d7e3fa3e 100644 --- a/lib/generated/account.ex +++ b/lib/generated/account.ex @@ -1,7 +1,7 @@ defmodule Stripe.Account do use Stripe.Entity - @moduledoc "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that\naccount has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links)\nfor a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express**\nbelow. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts)." + @moduledoc "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts)." ( defstruct [ :business_profile, @@ -28,7 +28,7 @@ defmodule Stripe.Account do :type ] - @typedoc "The `account` type.\n\n * `business_profile` Business information about the account.\n * `business_type` The business type.\n * `capabilities` \n * `charges_enabled` Whether the account can create live charges.\n * `company` \n * `controller` \n * `country` The account's country.\n * `created` Time at which the account was connected. Measured in seconds since the Unix epoch.\n * `default_currency` Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).\n * `details_submitted` Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.\n * `email` An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.\n * `external_accounts` External accounts (bank accounts and debit cards) currently attached to this account\n * `future_requirements` \n * `id` Unique identifier for the object.\n * `individual` \n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `payouts_enabled` Whether Stripe can send payouts to this account.\n * `requirements` \n * `settings` Options for customizing how the account functions within Stripe.\n * `tos_acceptance` \n * `type` The Stripe account type. Can be `standard`, `express`, or `custom`.\n" + @typedoc "The `account` type.\n\n * `business_profile` Business information about the account.\n * `business_type` The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.\n * `capabilities` \n * `charges_enabled` Whether the account can create live charges.\n * `company` \n * `controller` \n * `country` The account's country.\n * `created` Time at which the account was connected. Measured in seconds since the Unix epoch.\n * `default_currency` Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).\n * `details_submitted` Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.\n * `email` An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.\n * `external_accounts` External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.\n * `future_requirements` \n * `id` Unique identifier for the object.\n * `individual` \n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `payouts_enabled` Whether Stripe can send payouts to this account.\n * `requirements` \n * `settings` Options for customizing how the account functions within Stripe.\n * `tos_acceptance` \n * `type` The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.\n" @type t :: %__MODULE__{ business_profile: term | nil, business_type: binary | nil, @@ -78,7 +78,7 @@ defmodule Stripe.Account do ) ( - @typedoc "The Kana variation of the the individual's primary address (Japan only)." + @typedoc "The Kana variation of the individual's primary address (Japan only)." @type address_kana :: %{ optional(:city) => binary, optional(:country) => binary, @@ -91,7 +91,7 @@ defmodule Stripe.Account do ) ( - @typedoc "The Kanji variation of the company's primary address (Japan only)." + @typedoc "The Kanji variation of the individual's primary address (Japan only)." @type address_kanji :: %{ optional(:city) => binary, optional(:country) => binary, @@ -113,14 +113,28 @@ defmodule Stripe.Account do @type afterpay_clearpay_payments :: %{optional(:requested) => boolean} ) + ( + @typedoc "The amazon_pay_payments capability." + @type amazon_pay_payments :: %{optional(:requested) => boolean} + ) + + ( + @typedoc "The applicant's gross annual revenue for its preceding fiscal year." + @type annual_revenue :: %{ + optional(:amount) => integer, + optional(:currency) => binary, + optional(:fiscal_year_end) => binary + } + ) + ( @typedoc "The au_becs_debit_payments capability." @type au_becs_debit_payments :: %{optional(:requested) => boolean} ) ( - @typedoc "Settings specific to Bacs Direct Debit payments." - @type bacs_debit_payments :: %{optional(:display_name) => binary} + @typedoc "The bacs_debit_payments capability." + @type bacs_debit_payments :: %{optional(:requested) => boolean} ) ( @@ -129,7 +143,7 @@ defmodule Stripe.Account do ) ( - @typedoc "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check." + @typedoc "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check." @type bank_account_ownership_verification :: %{optional(:files) => list(binary)} ) @@ -161,6 +175,8 @@ defmodule Stripe.Account do ( @typedoc "Business information about the account." @type business_profile :: %{ + optional(:annual_revenue) => annual_revenue, + optional(:estimated_worker_count) => integer, optional(:mcc) => binary, optional(:monthly_estimated_revenue) => monthly_estimated_revenue, optional(:name) => binary, @@ -174,45 +190,55 @@ defmodule Stripe.Account do ) ( - @typedoc "Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive." + @typedoc "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts." @type capabilities :: %{ - optional(:link_payments) => link_payments, - optional(:card_issuing) => card_issuing, - optional(:treasury) => treasury, - optional(:oxxo_payments) => oxxo_payments, - optional(:affirm_payments) => affirm_payments, - optional(:promptpay_payments) => promptpay_payments, + optional(:boleto_payments) => boleto_payments, + optional(:gb_bank_transfer_payments) => gb_bank_transfer_payments, + optional(:mobilepay_payments) => mobilepay_payments, + optional(:revolut_pay_payments) => revolut_pay_payments, optional(:bank_transfer_payments) => bank_transfer_payments, - optional(:sofort_payments) => sofort_payments, optional(:acss_debit_payments) => acss_debit_payments, - optional(:cashapp_payments) => cashapp_payments, + optional(:tax_reporting_us_1099_k) => tax_reporting_us_1099_k, + optional(:us_bank_transfer_payments) => us_bank_transfer_payments, + optional(:swish_payments) => swish_payments, optional(:cartes_bancaires_payments) => cartes_bancaires_payments, - optional(:india_international_payments) => india_international_payments, + optional(:ideal_payments) => ideal_payments, optional(:bacs_debit_payments) => bacs_debit_payments, - optional(:tax_reporting_us_1099_misc) => tax_reporting_us_1099_misc, optional(:paynow_payments) => paynow_payments, - optional(:klarna_payments) => klarna_payments, - optional(:us_bank_account_ach_payments) => us_bank_account_ach_payments, - optional(:card_payments) => card_payments, - optional(:p24_payments) => p24_payments, - optional(:boleto_payments) => boleto_payments, + optional(:giropay_payments) => giropay_payments, + optional(:amazon_pay_payments) => amazon_pay_payments, + optional(:grabpay_payments) => grabpay_payments, + optional(:multibanco_payments) => multibanco_payments, optional(:fpx_payments) => fpx_payments, + optional(:sepa_debit_payments) => sepa_debit_payments, + optional(:legacy_payments) => legacy_payments, + optional(:eps_payments) => eps_payments, + optional(:sofort_payments) => sofort_payments, + optional(:tax_reporting_us_1099_misc) => tax_reporting_us_1099_misc, + optional(:us_bank_account_ach_payments) => us_bank_account_ach_payments, optional(:au_becs_debit_payments) => au_becs_debit_payments, - optional(:konbini_payments) => konbini_payments, - optional(:ideal_payments) => ideal_payments, - optional(:afterpay_clearpay_payments) => afterpay_clearpay_payments, + optional(:link_payments) => link_payments, + optional(:p24_payments) => p24_payments, + optional(:jcb_payments) => jcb_payments, + optional(:treasury) => treasury, + optional(:oxxo_payments) => oxxo_payments, + optional(:india_international_payments) => india_international_payments, + optional(:mx_bank_transfer_payments) => mx_bank_transfer_payments, + optional(:cashapp_payments) => cashapp_payments, + optional(:bancontact_payments) => bancontact_payments, + optional(:sepa_bank_transfer_payments) => sepa_bank_transfer_payments, + optional(:klarna_payments) => klarna_payments, optional(:blik_payments) => blik_payments, + optional(:promptpay_payments) => promptpay_payments, + optional(:konbini_payments) => konbini_payments, optional(:zip_payments) => zip_payments, - optional(:bancontact_payments) => bancontact_payments, - optional(:giropay_payments) => giropay_payments, - optional(:legacy_payments) => legacy_payments, - optional(:sepa_debit_payments) => sepa_debit_payments, - optional(:revolut_pay_payments) => revolut_pay_payments, + optional(:afterpay_clearpay_payments) => afterpay_clearpay_payments, + optional(:card_payments) => card_payments, + optional(:jp_bank_transfer_payments) => jp_bank_transfer_payments, optional(:transfers) => transfers, - optional(:eps_payments) => eps_payments, - optional(:grabpay_payments) => grabpay_payments, - optional(:tax_reporting_us_1099_k) => tax_reporting_us_1099_k, - optional(:jcb_payments) => jcb_payments + optional(:card_issuing) => card_issuing, + optional(:affirm_payments) => affirm_payments, + optional(:twint_payments) => twint_payments } ) @@ -242,7 +268,7 @@ defmodule Stripe.Account do ) ( - @typedoc "Information about the company or business. This field is available for any `business_type`." + @typedoc "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts." @type company :: %{ optional(:address) => address, optional(:address_kana) => address_kana, @@ -274,6 +300,7 @@ defmodule Stripe.Account do | :public_company | :public_corporation | :public_partnership + | :registered_charity | :single_member_llc | :sole_establishment | :sole_proprietorship @@ -313,6 +340,16 @@ defmodule Stripe.Account do @type company_tax_id_verification :: %{optional(:files) => list(binary)} ) + ( + @typedoc "A hash of configuration describing the account controller's attributes." + @type controller :: %{ + optional(:fees) => fees, + optional(:losses) => losses, + optional(:requirement_collection) => :application | :stripe, + optional(:stripe_dashboard) => stripe_dashboard + } + ) + ( @typedoc nil @type created :: %{ @@ -338,7 +375,7 @@ defmodule Stripe.Account do ) ( - @typedoc "A document verifying the business." + @typedoc "An identifying document, either a passport or local ID card." @type document :: %{optional(:back) => binary, optional(:front) => binary} ) @@ -360,11 +397,21 @@ defmodule Stripe.Account do @type eps_payments :: %{optional(:requested) => boolean} ) + ( + @typedoc "A hash of configuration for who pays Stripe fees for product usage on this account." + @type fees :: %{optional(:payer) => :account | :application} + ) + ( @typedoc "The fpx_payments capability." @type fpx_payments :: %{optional(:requested) => boolean} ) + ( + @typedoc "The gb_bank_transfer_payments capability." + @type gb_bank_transfer_payments :: %{optional(:requested) => boolean} + ) + ( @typedoc "The giropay_payments capability." @type giropay_payments :: %{optional(:requested) => boolean} @@ -386,7 +433,7 @@ defmodule Stripe.Account do ) ( - @typedoc "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`." + @typedoc "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts." @type individual :: %{ optional(:address) => address, optional(:address_kana) => address_kana, @@ -408,16 +455,27 @@ defmodule Stripe.Account do optional(:phone) => binary, optional(:political_exposure) => :existing | :none, optional(:registered_address) => registered_address, + optional(:relationship) => relationship, optional(:ssn_last_4) => binary, optional(:verification) => verification } ) + ( + @typedoc "Settings specific to the account's use of Invoices." + @type invoices :: %{optional(:default_account_tax_ids) => list(binary) | binary} + ) + ( @typedoc "The jcb_payments capability." @type jcb_payments :: %{optional(:requested) => boolean} ) + ( + @typedoc "The jp_bank_transfer_payments capability." + @type jp_bank_transfer_payments :: %{optional(:requested) => boolean} + ) + ( @typedoc "The klarna_payments capability." @type klarna_payments :: %{optional(:requested) => boolean} @@ -438,6 +496,16 @@ defmodule Stripe.Account do @type link_payments :: %{optional(:requested) => boolean} ) + ( + @typedoc "A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them." + @type losses :: %{optional(:payments) => :application | :stripe} + ) + + ( + @typedoc "The mobilepay_payments capability." + @type mobilepay_payments :: %{optional(:requested) => boolean} + ) + ( @typedoc "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India." @type monthly_estimated_revenue :: %{ @@ -446,6 +514,16 @@ defmodule Stripe.Account do } ) + ( + @typedoc "The multibanco_payments capability." + @type multibanco_payments :: %{optional(:requested) => boolean} + ) + + ( + @typedoc "The mx_bank_transfer_payments capability." + @type mx_bank_transfer_payments :: %{optional(:requested) => boolean} + ) + ( @typedoc "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct." @type ownership_declaration :: %{ @@ -527,7 +605,7 @@ defmodule Stripe.Account do ) ( - @typedoc "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation." + @typedoc "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation." @type schedule :: %{ optional(:delay_days) => :minimum | integer, optional(:interval) => :daily | :manual | :monthly | :weekly, @@ -537,6 +615,11 @@ defmodule Stripe.Account do } ) + ( + @typedoc "The sepa_bank_transfer_payments capability." + @type sepa_bank_transfer_payments :: %{optional(:requested) => boolean} + ) + ( @typedoc "The sepa_debit_payments capability." @type sepa_debit_payments :: %{optional(:requested) => boolean} @@ -560,6 +643,11 @@ defmodule Stripe.Account do @type sofort_payments :: %{optional(:requested) => boolean} ) + ( + @typedoc "A hash of configuration for Stripe-hosted dashboards." + @type stripe_dashboard :: %{optional(:type) => :express | :full | :none} + ) + ( @typedoc "A publicly available mailing address for sending support issues to." @type support_address :: %{ @@ -572,6 +660,11 @@ defmodule Stripe.Account do } ) + ( + @typedoc "The swish_payments capability." + @type swish_payments :: %{optional(:requested) => boolean} + ) + ( @typedoc "The tax_reporting_us_1099_k capability." @type tax_reporting_us_1099_k :: %{optional(:requested) => boolean} @@ -583,12 +676,11 @@ defmodule Stripe.Account do ) ( - @typedoc "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance)." + @typedoc "Details on the account's acceptance of the Stripe Treasury Services Agreement." @type tos_acceptance :: %{ optional(:date) => integer, optional(:ip) => binary, - optional(:service_agreement) => binary, - optional(:user_agent) => binary + optional(:user_agent) => binary | binary } ) @@ -598,8 +690,13 @@ defmodule Stripe.Account do ) ( - @typedoc "The treasury capability." - @type treasury :: %{optional(:requested) => boolean} + @typedoc "Settings specific to the account's Treasury FinancialAccounts." + @type treasury :: %{optional(:tos_acceptance) => tos_acceptance} + ) + + ( + @typedoc "The twint_payments capability." + @type twint_payments :: %{optional(:requested) => boolean} ) ( @@ -607,6 +704,11 @@ defmodule Stripe.Account do @type us_bank_account_ach_payments :: %{optional(:requested) => boolean} ) + ( + @typedoc "The us_bank_transfer_payments capability." + @type us_bank_transfer_payments :: %{optional(:requested) => boolean} + ) + ( @typedoc "Information on the verification state of the company." @type verification :: %{optional(:document) => document} @@ -620,49 +722,11 @@ defmodule Stripe.Account do ( nil - @doc "

Retrieves the details of an account.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/account`\n" - ( - @spec retrieve(params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t()) :: - {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/account", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.

\n\n

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an Account Link\nfor a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express\nbelow.

\n\n

To update your own account, use the Dashboard. Refer to our\nConnect documentation to learn more about updating accounts.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}`\n" + @doc "

With Connect, you can delete accounts you manage.

\n\n

Test-mode accounts can be deleted at any time.

\n\n

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

\n\n

If you want to delete your own account, use the account information tab in your account settings instead.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}`\n" ( - @spec update( - account :: binary(), - params :: %{ - optional(:account_token) => binary, - optional(:business_profile) => business_profile, - optional(:business_type) => - :company | :government_entity | :individual | :non_profit, - optional(:capabilities) => capabilities, - optional(:company) => company, - optional(:default_currency) => binary, - optional(:documents) => documents, - optional(:email) => binary, - optional(:expand) => list(binary), - optional(:external_account) => binary, - optional(:individual) => individual, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:settings) => settings, - optional(:tos_acceptance) => tos_acceptance - }, - opts :: Keyword.t() - ) :: {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(account, params \\ %{}, opts \\ []) do + @spec delete(account :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def delete(account, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/accounts/{account}", @@ -686,8 +750,7 @@ defmodule Stripe.Account do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -696,23 +759,12 @@ defmodule Stripe.Account do ( nil - @doc "

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/accounts`\n" + @doc "

Retrieves the details of an account.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/account`\n" ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Account.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/accounts", [], []) + @spec retrieve(params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t()) :: + {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/account", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -726,37 +778,28 @@ defmodule Stripe.Account do ( nil - @doc "

With Connect, you can create Stripe accounts for your users.\nTo do this, you’ll first need to register your platform.

\n\n

If you’ve already collected information for your connected accounts, you can prefill that information when\ncreating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding.\nYou can prefill any information on the account.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts`\n" + @doc "

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/accounts`\n" ( - @spec create( + @spec list( params :: %{ - optional(:account_token) => binary, - optional(:business_profile) => business_profile, - optional(:business_type) => - :company | :government_entity | :individual | :non_profit, - optional(:capabilities) => capabilities, - optional(:company) => company, - optional(:country) => binary, - optional(:default_currency) => binary, - optional(:documents) => documents, - optional(:email) => binary, + optional(:created) => created | integer, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:external_account) => binary, - optional(:individual) => individual, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:settings) => settings, - optional(:tos_acceptance) => tos_acceptance, - optional(:type) => :custom | :express | :standard + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Account.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/accounts", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -765,14 +808,20 @@ defmodule Stripe.Account do ( nil - @doc "

With Connect, you can delete accounts you manage.

\n\n

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

\n\n

If you want to delete your own account, use the account information tab in your account settings instead.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}`\n" + @doc "

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/accounts/{account}/capabilities`\n" ( - @spec delete(account :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(account, opts \\ []) do + @spec capabilities( + account :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Capability.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def capabilities(account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/accounts/{account}", + "/v1/accounts/{account}/capabilities", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -793,7 +842,8 @@ defmodule Stripe.Account do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -802,17 +852,26 @@ defmodule Stripe.Account do ( nil - @doc "

With Connect, you may flag accounts as suspicious.

\n\n

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/reject`\n" + @doc "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/accounts/{account}/persons`\n" ( - @spec reject( + @spec persons( account :: binary(), - params :: %{optional(:expand) => list(binary), optional(:reason) => binary}, + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:relationship) => relationship, + optional(:starting_after) => binary + }, opts :: Keyword.t() - ) :: {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def reject(account, params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Person.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def persons(account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/accounts/{account}/reject", + "/v1/accounts/{account}/persons", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -831,6 +890,46 @@ defmodule Stripe.Account do [account] ) + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

With Connect, you can create Stripe accounts for your users.\nTo do this, you’ll first need to register your platform.

\n\n

If you’ve already collected information for your connected accounts, you can prefill that information when\ncreating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding.\nYou can prefill any information on the account.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts`\n" + ( + @spec create( + params :: %{ + optional(:account_token) => binary, + optional(:business_profile) => business_profile, + optional(:business_type) => + :company | :government_entity | :individual | :non_profit, + optional(:capabilities) => capabilities, + optional(:company) => company, + optional(:controller) => controller, + optional(:country) => binary, + optional(:default_currency) => binary, + optional(:documents) => documents, + optional(:email) => binary, + optional(:expand) => list(binary), + optional(:external_account) => binary, + optional(:individual) => individual, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:settings) => settings, + optional(:tos_acceptance) => tos_acceptance, + optional(:type) => :custom | :express | :standard + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/accounts", [], []) + Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) @@ -843,26 +942,33 @@ defmodule Stripe.Account do ( nil - @doc "

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/accounts/{account}/persons`\n" + @doc "

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.

\n\n

For accounts where controller.requirement_collection\nis application, which includes Custom accounts, you can update any information on the account.

\n\n

For accounts where controller.requirement_collection\nis stripe, which includes Standard and Express accounts, you can update all information until you create\nan Account Link or Account Session to start Connect onboarding,\nafter which some properties can no longer be updated.

\n\n

To update your own account, use the Dashboard. Refer to our\nConnect documentation to learn more about updating accounts.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}`\n" ( - @spec persons( + @spec update( account :: binary(), params :: %{ - optional(:ending_before) => binary, + optional(:account_token) => binary, + optional(:business_profile) => business_profile, + optional(:business_type) => + :company | :government_entity | :individual | :non_profit, + optional(:capabilities) => capabilities, + optional(:company) => company, + optional(:default_currency) => binary, + optional(:documents) => documents, + optional(:email) => binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:relationship) => relationship, - optional(:starting_after) => binary + optional(:external_account) => binary, + optional(:individual) => individual, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:settings) => settings, + optional(:tos_acceptance) => tos_acceptance }, opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Person.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def persons(account, params \\ %{}, opts \\ []) do + ) :: {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/accounts/{account}/persons", + "/v1/accounts/{account}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -884,7 +990,7 @@ defmodule Stripe.Account do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -893,20 +999,17 @@ defmodule Stripe.Account do ( nil - @doc "

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/accounts/{account}/capabilities`\n" + @doc "

With Connect, you can reject accounts that you have flagged as suspicious.

\n\n

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/reject`\n" ( - @spec capabilities( + @spec reject( account :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{optional(:expand) => list(binary), optional(:reason) => binary}, opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Capability.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def capabilities(account, params \\ %{}, opts \\ []) do + ) :: {:ok, Stripe.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def reject(account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/accounts/{account}/capabilities", + "/v1/accounts/{account}/reject", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -928,7 +1031,7 @@ defmodule Stripe.Account do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) diff --git a/lib/generated/account_link.ex b/lib/generated/account_link.ex index c7c66c1b..18a2f35d 100644 --- a/lib/generated/account_link.ex +++ b/lib/generated/account_link.ex @@ -9,6 +9,14 @@ defmodule Stripe.AccountLink do @type t :: %__MODULE__{created: integer, expires_at: integer, object: binary, url: binary} ) + ( + @typedoc "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow." + @type collection_options :: %{ + optional(:fields) => :currently_due | :eventually_due, + optional(:future_requirements) => :include | :omit + } + ) + ( nil @@ -18,6 +26,7 @@ defmodule Stripe.AccountLink do params :: %{ optional(:account) => binary, optional(:collect) => :currently_due | :eventually_due, + optional(:collection_options) => collection_options, optional(:expand) => list(binary), optional(:refresh_url) => binary, optional(:return_url) => binary, @@ -36,4 +45,4 @@ defmodule Stripe.AccountLink do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/account_session.ex b/lib/generated/account_session.ex index 95ce05ff..567beabe 100644 --- a/lib/generated/account_session.ex +++ b/lib/generated/account_session.ex @@ -16,30 +16,58 @@ defmodule Stripe.AccountSession do } ) + ( + @typedoc "Configuration for the account management embedded component." + @type account_management :: %{optional(:enabled) => boolean, optional(:features) => features} + ) + ( @typedoc "Configuration for the account onboarding embedded component." - @type account_onboarding :: %{optional(:enabled) => boolean, optional(:features) => map()} + @type account_onboarding :: %{optional(:enabled) => boolean, optional(:features) => features} + ) + + ( + @typedoc "Configuration for the balances embedded component." + @type balances :: %{optional(:enabled) => boolean, optional(:features) => features} ) ( @typedoc "Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not)." @type components :: %{ + optional(:account_management) => account_management, optional(:account_onboarding) => account_onboarding, + optional(:balances) => balances, + optional(:documents) => documents, + optional(:notification_banner) => notification_banner, optional(:payment_details) => payment_details, optional(:payments) => payments, - optional(:payouts) => payouts + optional(:payouts) => payouts, + optional(:payouts_list) => payouts_list, + optional(:tax_registrations) => tax_registrations, + optional(:tax_settings) => tax_settings } ) + ( + @typedoc "Configuration for the documents embedded component." + @type documents :: %{optional(:enabled) => boolean, optional(:features) => map()} + ) + ( @typedoc "The list of features enabled in the embedded component." @type features :: %{ optional(:capture_payments) => boolean, + optional(:destination_on_behalf_of_charge_management) => boolean, optional(:dispute_management) => boolean, optional(:refund_management) => boolean } ) + ( + @typedoc "Configuration for the notification banner embedded component." + @type notification_banner :: %{optional(:enabled) => boolean, optional(:features) => features} + ) + ( @typedoc "Configuration for the payment details embedded component." @type payment_details :: %{optional(:enabled) => boolean, optional(:features) => features} @@ -55,6 +83,21 @@ defmodule Stripe.AccountSession do @type payouts :: %{optional(:enabled) => boolean, optional(:features) => features} ) + ( + @typedoc "Configuration for the payouts list embedded component." + @type payouts_list :: %{optional(:enabled) => boolean, optional(:features) => map()} + ) + + ( + @typedoc "Configuration for the tax registrations embedded component." + @type tax_registrations :: %{optional(:enabled) => boolean, optional(:features) => map()} + ) + + ( + @typedoc "Configuration for the tax settings embedded component." + @type tax_settings :: %{optional(:enabled) => boolean, optional(:features) => map()} + ) + ( nil @@ -80,4 +123,4 @@ defmodule Stripe.AccountSession do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/api_errors.ex b/lib/generated/api_errors.ex index 6b755e74..f130b9b7 100644 --- a/lib/generated/api_errors.ex +++ b/lib/generated/api_errors.ex @@ -35,4 +35,4 @@ defmodule Stripe.ApiErrors do type: binary } ) -end +end \ No newline at end of file diff --git a/lib/generated/apple_pay_domain.ex b/lib/generated/apple_pay_domain.ex index e29d72be..e19cd1b0 100644 --- a/lib/generated/apple_pay_domain.ex +++ b/lib/generated/apple_pay_domain.ex @@ -17,28 +17,37 @@ defmodule Stripe.ApplePayDomain do ( nil - @doc "

List apple pay domains.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/apple_pay/domains`\n" + @doc "

Delete an apple pay domain.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/apple_pay/domains/{domain}`\n" ( - @spec list( - params :: %{ - optional(:domain_name) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.ApplePayDomain.t())} + @spec delete(domain :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedApplePayDomain.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/apple_pay/domains", [], []) + def delete(domain, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/apple_pay/domains/{domain}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "domain", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "domain", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [domain] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -47,20 +56,28 @@ defmodule Stripe.ApplePayDomain do ( nil - @doc "

Create an apple pay domain.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/apple_pay/domains`\n" + @doc "

List apple pay domains.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/apple_pay/domains`\n" ( - @spec create( - params :: %{optional(:domain_name) => binary, optional(:expand) => list(binary)}, + @spec list( + params :: %{ + optional(:domain_name) => binary, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, opts :: Keyword.t() ) :: - {:ok, Stripe.ApplePayDomain.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + {:ok, Stripe.List.t(Stripe.ApplePayDomain.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/apple_pay/domains", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -111,39 +128,22 @@ defmodule Stripe.ApplePayDomain do ( nil - @doc "

Delete an apple pay domain.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/apple_pay/domains/{domain}`\n" + @doc "

Create an apple pay domain.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/apple_pay/domains`\n" ( - @spec delete(domain :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedApplePayDomain.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete(domain, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/apple_pay/domains/{domain}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "domain", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "domain", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [domain] - ) + @spec create( + params :: %{optional(:domain_name) => binary, optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.ApplePayDomain.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/apple_pay/domains", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/application_fee.ex b/lib/generated/application_fee.ex index 38720e45..0ced2f3e 100644 --- a/lib/generated/application_fee.ex +++ b/lib/generated/application_fee.ex @@ -11,6 +11,7 @@ defmodule Stripe.ApplicationFee do :charge, :created, :currency, + :fee_source, :id, :livemode, :object, @@ -19,7 +20,7 @@ defmodule Stripe.ApplicationFee do :refunds ] - @typedoc "The `application_fee` type.\n\n * `account` ID of the Stripe account this fee was taken from.\n * `amount` Amount earned, in cents (or local equivalent).\n * `amount_refunded` Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)\n * `application` ID of the Connect application that earned the fee.\n * `balance_transaction` Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).\n * `charge` ID of the charge that the application fee was taken from.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `originating_transaction` ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.\n * `refunded` Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.\n * `refunds` A list of refunds that have been applied to the fee.\n" + @typedoc "The `application_fee` type.\n\n * `account` ID of the Stripe account this fee was taken from.\n * `amount` Amount earned, in cents (or local equivalent).\n * `amount_refunded` Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)\n * `application` ID of the Connect application that earned the fee.\n * `balance_transaction` Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).\n * `charge` ID of the charge that the application fee was taken from.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `fee_source` Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `originating_transaction` ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.\n * `refunded` Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.\n * `refunds` A list of refunds that have been applied to the fee.\n" @type t :: %__MODULE__{ account: binary | Stripe.Account.t(), amount: integer, @@ -29,6 +30,7 @@ defmodule Stripe.ApplicationFee do charge: binary | Stripe.Charge.t(), created: integer, currency: binary, + fee_source: term | nil, id: binary, livemode: boolean, object: binary, @@ -120,4 +122,4 @@ defmodule Stripe.ApplicationFee do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/apps__secret.ex b/lib/generated/apps__secret.ex index e320c479..fc08fe90 100644 --- a/lib/generated/apps__secret.ex +++ b/lib/generated/apps__secret.ex @@ -24,6 +24,36 @@ defmodule Stripe.Apps.Secret do @type scope :: %{optional(:type) => :account | :user, optional(:user) => binary} ) + ( + nil + + @doc "

List all secrets stored on the given scope.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/apps/secrets`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:scope) => scope, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Apps.Secret.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/apps/secrets", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -100,34 +130,4 @@ defmodule Stripe.Apps.Secret do end ) ) - - ( - nil - - @doc "

List all secrets stored on the given scope.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/apps/secrets`\n" - ( - @spec list( - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:scope) => scope, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Apps.Secret.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/apps/secrets", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/balance.ex b/lib/generated/balance.ex index 755471aa..379572c7 100644 --- a/lib/generated/balance.ex +++ b/lib/generated/balance.ex @@ -13,7 +13,7 @@ defmodule Stripe.Balance do :pending ] - @typedoc "The `balance` type.\n\n * `available` Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.\n * `connect_reserved` Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.\n * `instant_available` Funds that you can pay out using Instant Payouts.\n * `issuing` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `pending` Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.\n" + @typedoc "The `balance` type.\n\n * `available` Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.\n * `connect_reserved` Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.\n * `instant_available` Funds that you can pay out using Instant Payouts.\n * `issuing` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `pending` Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.\n" @type t :: %__MODULE__{ available: term, connect_reserved: term, @@ -43,4 +43,4 @@ defmodule Stripe.Balance do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/balance_transaction.ex b/lib/generated/balance_transaction.ex index 187c1b8b..3b5d4ce4 100644 --- a/lib/generated/balance_transaction.ex +++ b/lib/generated/balance_transaction.ex @@ -128,4 +128,4 @@ defmodule Stripe.BalanceTransaction do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/bank_account.ex b/lib/generated/bank_account.ex index 37950064..2b314db0 100644 --- a/lib/generated/bank_account.ex +++ b/lib/generated/bank_account.ex @@ -1,7 +1,7 @@ defmodule Stripe.BankAccount do use Stripe.Entity - @moduledoc "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer\ndestinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)" + @moduledoc "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/api#external_accounts) are transfer\ndestinations on `Account` objects for connected accounts.\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](/payments/bank-debits-transfers)" ( defstruct [ :account, @@ -25,7 +25,7 @@ defmodule Stripe.BankAccount do :status ] - @typedoc "The `bank_account` type.\n\n * `account` The ID of the account that the bank account is associated with.\n * `account_holder_name` The name of the person or business that owns the bank account.\n * `account_holder_type` The type of entity that holds the account. This can be either `individual` or `company`.\n * `account_type` The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.\n * `available_payout_methods` A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.\n * `bank_name` Name of the bank associated with the routing number (e.g., `WELLS FARGO`).\n * `country` Two-letter ISO code representing the country the bank account is located in.\n * `currency` Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.\n * `customer` The ID of the customer that the bank account is associated with.\n * `default_for_currency` Whether this bank account is the default external account for its currency.\n * `fingerprint` Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.\n * `future_requirements` 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.\n * `id` Unique identifier for the object.\n * `last4` The last four digits of the bank account number.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `requirements` Information about the requirements for the bank account, including what information needs to be collected.\n * `routing_number` The routing transit number for the bank account.\n * `status` For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.\n" + @typedoc "The `bank_account` type.\n\n * `account` The ID of the account that the bank account is associated with.\n * `account_holder_name` The name of the person or business that owns the bank account.\n * `account_holder_type` The type of entity that holds the account. This can be either `individual` or `company`.\n * `account_type` The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.\n * `available_payout_methods` A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.\n * `bank_name` Name of the bank associated with the routing number (e.g., `WELLS FARGO`).\n * `country` Two-letter ISO code representing the country the bank account is located in.\n * `currency` Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.\n * `customer` The ID of the customer that the bank account is associated with.\n * `default_for_currency` Whether this bank account is the default external account for its currency.\n * `fingerprint` Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.\n * `future_requirements` 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.\n * `id` Unique identifier for the object.\n * `last4` The last four digits of the bank account number.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `requirements` Information about the requirements for the bank account, including what information needs to be collected.\n * `routing_number` The routing transit number for the bank account.\n * `status` For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.\n" @type t :: %__MODULE__{ account: (binary | Stripe.Account.t()) | nil, account_holder_name: binary | nil, @@ -50,67 +50,37 @@ defmodule Stripe.BankAccount do ) ( - @typedoc "Owner's address." - @type address :: %{ - optional(:city) => binary, - optional(:country) => binary, - optional(:line1) => binary, - optional(:line2) => binary, - optional(:postal_code) => binary, - optional(:state) => binary - } + @typedoc "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check." + @type bank_account_ownership_verification :: %{optional(:files) => list(binary)} ) ( - @typedoc nil - @type owner :: %{ - optional(:address) => address, - optional(:email) => binary, - optional(:name) => binary, - optional(:phone) => binary + @typedoc "Documents that may be submitted to satisfy various informational requests." + @type documents :: %{ + optional(:bank_account_ownership_verification) => bank_account_ownership_verification } ) ( nil - @doc "

Update a specified source for a given customer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers/{customer}/sources/{id}`\n" + @doc "

Delete a specified external account for a given account.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" ( - @spec update( - customer :: binary(), - id :: binary(), - params :: %{ - optional(:account_holder_name) => binary, - optional(:account_holder_type) => :company | :individual, - optional(:address_city) => binary, - optional(:address_country) => binary, - optional(:address_line1) => binary, - optional(:address_line2) => binary, - optional(:address_state) => binary, - optional(:address_zip) => binary, - optional(:exp_month) => binary, - optional(:exp_year) => binary, - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:name) => binary, - optional(:owner) => owner - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Card.t() | Stripe.BankAccount.t() | Stripe.Source.t()} + @spec delete(account :: binary(), id :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedExternalAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(customer, id, params \\ %{}, opts \\ []) do + def delete(account, id, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/sources/{id}", + "/v1/accounts/{account}/external_accounts/{id}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", - name: "customer", + name: "account", required: true, schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "customer", + name: "account", title: nil, type: "string", items: [], @@ -132,13 +102,12 @@ defmodule Stripe.BankAccount do } } ], - [customer, id] + [account, id] ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -147,28 +116,45 @@ defmodule Stripe.BankAccount do ( nil - @doc "

Delete a specified source for a given customer.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}/sources/{id}`\n" + @doc "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" ( - @spec delete( - customer :: binary(), + @spec update( + account :: binary(), id :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:account_holder_name) => binary, + optional(:account_holder_type) => :company | :individual, + optional(:account_type) => :checking | :futsu | :savings | :toza, + optional(:address_city) => binary, + optional(:address_country) => binary, + optional(:address_line1) => binary, + optional(:address_line2) => binary, + optional(:address_state) => binary, + optional(:address_zip) => binary, + optional(:default_for_currency) => boolean, + optional(:documents) => documents, + optional(:exp_month) => binary, + optional(:exp_year) => binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:name) => binary + }, opts :: Keyword.t() ) :: - {:ok, Stripe.PaymentSource.t() | Stripe.DeletedPaymentSource.t()} + {:ok, Stripe.ExternalAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(customer, id, params \\ %{}, opts \\ []) do + def update(account, id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/sources/{id}", + "/v1/accounts/{account}/external_accounts/{id}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", - name: "customer", + name: "account", required: true, schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "customer", + name: "account", title: nil, type: "string", items: [], @@ -190,13 +176,13 @@ defmodule Stripe.BankAccount do } } ], - [customer, id] + [account, id] ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -256,4 +242,4 @@ defmodule Stripe.BankAccount do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/billing__alert.ex b/lib/generated/billing__alert.ex new file mode 100644 index 00000000..b361aa0b --- /dev/null +++ b/lib/generated/billing__alert.ex @@ -0,0 +1,274 @@ +defmodule Stripe.Billing.Alert do + use Stripe.Entity + + @moduledoc "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests." + ( + defstruct [ + :alert_type, + :filter, + :id, + :livemode, + :object, + :status, + :title, + :usage_threshold_config + ] + + @typedoc "The `billing.alert` type.\n\n * `alert_type` Defines the type of the alert.\n * `filter` Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers).\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` Status of the alert. This can be active, inactive or archived.\n * `title` Title of the alert.\n * `usage_threshold_config` Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).\n" + @type t :: %__MODULE__{ + alert_type: binary, + filter: term | nil, + id: binary, + livemode: boolean, + object: binary, + status: binary | nil, + title: binary, + usage_threshold_config: term | nil + } + ) + + ( + @typedoc "Filters to limit the scope of an alert." + @type filter :: %{ + optional(:customer) => binary, + optional(:subscription) => binary, + optional(:subscription_item) => binary + } + ) + + ( + @typedoc "The configuration of the usage threshold." + @type usage_threshold_config :: %{ + optional(:gte) => integer, + optional(:meter) => binary, + optional(:recurrence) => :one_time + } + ) + + ( + nil + + @doc "

Lists billing active and inactive alerts

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/billing/alerts`\n" + ( + @spec list( + params :: %{ + optional(:alert_type) => :usage_threshold, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:meter) => binary, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Billing.Alert.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/billing/alerts", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves a billing alert given an ID

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/billing/alerts/{id}`\n" + ( + @spec retrieve( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Alert.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/alerts/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a billing alert

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/alerts`\n" + ( + @spec create( + params :: %{ + optional(:alert_type) => :usage_threshold, + optional(:expand) => list(binary), + optional(:filter) => filter, + optional(:title) => binary, + optional(:usage_threshold_config) => usage_threshold_config + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Alert.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/billing/alerts", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Reactivates this alert, allowing it to trigger again.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/alerts/{id}/activate`\n" + ( + @spec activate( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Alert.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def activate(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/alerts/{id}/activate", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Archives this alert, removing it from the list view and APIs. This is non-reversible.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/alerts/{id}/archive`\n" + ( + @spec archive( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Alert.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def archive(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/alerts/{id}/archive", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Deactivates this alert, preventing it from triggering.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/alerts/{id}/deactivate`\n" + ( + @spec deactivate( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Alert.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def deactivate(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/alerts/{id}/deactivate", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/billing__meter.ex b/lib/generated/billing__meter.ex new file mode 100644 index 00000000..660c733e --- /dev/null +++ b/lib/generated/billing__meter.ex @@ -0,0 +1,282 @@ +defmodule Stripe.Billing.Meter do + use Stripe.Entity + + @moduledoc "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make." + ( + defstruct [ + :created, + :customer_mapping, + :default_aggregation, + :display_name, + :event_name, + :event_time_window, + :id, + :livemode, + :object, + :status, + :status_transitions, + :updated, + :value_settings + ] + + @typedoc "The `billing.meter` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer_mapping` \n * `default_aggregation` \n * `display_name` The meter's name.\n * `event_name` The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.\n * `event_time_window` The time window to pre-aggregate meter events for, if any.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The meter's status.\n * `status_transitions` \n * `updated` Time at which the object was last updated. Measured in seconds since the Unix epoch.\n * `value_settings` \n" + @type t :: %__MODULE__{ + created: integer, + customer_mapping: term, + default_aggregation: term, + display_name: binary, + event_name: binary, + event_time_window: binary | nil, + id: binary, + livemode: boolean, + object: binary, + status: binary, + status_transitions: term, + updated: integer, + value_settings: term + } + ) + + ( + @typedoc "Fields that specify how to map a meter event to a customer." + @type customer_mapping :: %{optional(:event_payload_key) => binary, optional(:type) => :by_id} + ) + + ( + @typedoc "The default settings to aggregate a meter's events with." + @type default_aggregation :: %{optional(:formula) => :count | :sum} + ) + + ( + @typedoc "Fields that specify how to calculate a meter event's value." + @type value_settings :: %{optional(:event_payload_key) => binary} + ) + + ( + nil + + @doc "

Retrieve a list of billing meters.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/billing/meters`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :active | :inactive + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Billing.Meter.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/billing/meters", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves a billing meter given an ID

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/billing/meters/{id}`\n" + ( + @spec retrieve( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Meter.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/meters/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a billing meter

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/meters`\n" + ( + @spec create( + params :: %{ + optional(:customer_mapping) => customer_mapping, + optional(:default_aggregation) => default_aggregation, + optional(:display_name) => binary, + optional(:event_name) => binary, + optional(:event_time_window) => :day | :hour, + optional(:expand) => list(binary), + optional(:value_settings) => value_settings + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Meter.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/billing/meters", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates a billing meter

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/meters/{id}`\n" + ( + @spec update( + id :: binary(), + params :: %{optional(:display_name) => binary, optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Meter.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/meters/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Deactivates a billing meter

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/meters/{id}/deactivate`\n" + ( + @spec deactivate( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Meter.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def deactivate(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/meters/{id}/deactivate", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Reactivates a billing meter

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/meters/{id}/reactivate`\n" + ( + @spec reactivate( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.Meter.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def reactivate(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/meters/{id}/reactivate", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/billing__meter_event.ex b/lib/generated/billing__meter_event.ex new file mode 100644 index 00000000..726e2961 --- /dev/null +++ b/lib/generated/billing__meter_event.ex @@ -0,0 +1,49 @@ +defmodule Stripe.Billing.MeterEvent do + use Stripe.Entity + + @moduledoc "A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.\nMeter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing." + ( + defstruct [:created, :event_name, :identifier, :livemode, :object, :payload, :timestamp] + + @typedoc "The `billing.meter_event` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `event_name` The name of the meter event. Corresponds with the `event_name` field on a meter.\n * `identifier` A unique identifier for the event.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `payload` The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).\n * `timestamp` The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.\n" + @type t :: %__MODULE__{ + created: integer, + event_name: binary, + identifier: binary, + livemode: boolean, + object: binary, + payload: term, + timestamp: integer + } + ) + + ( + nil + + @doc "

Creates a billing meter event

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/meter_events`\n" + ( + @spec create( + params :: %{ + optional(:event_name) => binary, + optional(:expand) => list(binary), + optional(:identifier) => binary, + optional(:payload) => map(), + optional(:timestamp) => integer + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.MeterEvent.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/billing/meter_events", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/billing__meter_event_adjustment.ex b/lib/generated/billing__meter_event_adjustment.ex new file mode 100644 index 00000000..7270813b --- /dev/null +++ b/lib/generated/billing__meter_event_adjustment.ex @@ -0,0 +1,53 @@ +defmodule Stripe.Billing.MeterEventAdjustment do + use Stripe.Entity + + @moduledoc "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer." + ( + defstruct [:cancel, :event_name, :livemode, :object, :status, :type] + + @typedoc "The `billing.meter_event_adjustment` type.\n\n * `cancel` Specifies which event to cancel.\n * `event_name` The name of the meter event. Corresponds with the `event_name` field on a meter.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The meter event adjustment's status.\n * `type` Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.\n" + @type t :: %__MODULE__{ + cancel: term | nil, + event_name: binary, + livemode: boolean, + object: binary, + status: binary, + type: binary + } + ) + + ( + @typedoc "Specifies which event to cancel." + @type cancel :: %{optional(:identifier) => binary} + ) + + ( + nil + + @doc "

Creates a billing meter event adjustment

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/meter_event_adjustments`\n" + ( + @spec create( + params :: %{ + optional(:cancel) => cancel, + optional(:event_name) => binary, + optional(:expand) => list(binary), + optional(:type) => :cancel + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Billing.MeterEventAdjustment.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params("/v1/billing/meter_event_adjustments", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/billing__meter_event_summary.ex b/lib/generated/billing__meter_event_summary.ex new file mode 100644 index 00000000..6ce92e00 --- /dev/null +++ b/lib/generated/billing__meter_event_summary.ex @@ -0,0 +1,72 @@ +defmodule Stripe.Billing.MeterEventSummary do + use Stripe.Entity + + @moduledoc "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period." + ( + defstruct [:aggregated_value, :end_time, :id, :livemode, :meter, :object, :start_time] + + @typedoc "The `billing.meter_event_summary` type.\n\n * `aggregated_value` Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.\n * `end_time` End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `meter` The meter associated with this event summary.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `start_time` Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.\n" + @type t :: %__MODULE__{ + aggregated_value: term, + end_time: integer, + id: binary, + livemode: boolean, + meter: binary, + object: binary, + start_time: integer + } + ) + + ( + nil + + @doc "

Retrieve a list of billing meter event summaries.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/billing/meters/{id}/event_summaries`\n" + ( + @spec list( + id :: binary(), + params :: %{ + optional(:customer) => binary, + optional(:end_time) => integer, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:start_time) => integer, + optional(:starting_after) => binary, + optional(:value_grouping_window) => :day | :hour + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Billing.MeterEventSummary.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing/meters/{id}/event_summaries", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/billing_portal__configuration.ex b/lib/generated/billing_portal__configuration.ex index 161dc016..df8de0cc 100644 --- a/lib/generated/billing_portal__configuration.ex +++ b/lib/generated/billing_portal__configuration.ex @@ -81,7 +81,6 @@ defmodule Stripe.BillingPortal.Configuration do optional(:invoice_history) => invoice_history, optional(:payment_method_update) => payment_method_update, optional(:subscription_cancel) => subscription_cancel, - optional(:subscription_pause) => subscription_pause, optional(:subscription_update) => subscription_update } ) @@ -116,11 +115,6 @@ defmodule Stripe.BillingPortal.Configuration do } ) - ( - @typedoc "Information about pausing subscriptions in the portal." - @type subscription_pause :: %{optional(:enabled) => boolean} - ) - ( @typedoc "Information about updating subscriptions in the portal." @type subscription_update :: %{ @@ -167,30 +161,42 @@ defmodule Stripe.BillingPortal.Configuration do ( nil - @doc "

Creates a configuration that describes the functionality and behavior of a PortalSession

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing_portal/configurations`\n" + @doc "

Retrieves a configuration that describes the functionality of the customer portal.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/billing_portal/configurations/{configuration}`\n" ( - @spec create( - params :: %{ - optional(:business_profile) => business_profile, - optional(:default_return_url) => binary | binary, - optional(:expand) => list(binary), - optional(:features) => features, - optional(:login_page) => login_page, - optional(:metadata) => %{optional(binary) => binary} - }, + @spec retrieve( + configuration :: binary(), + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.BillingPortal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def retrieve(configuration, params \\ %{}, opts \\ []) do path = - Stripe.OpenApi.Path.replace_path_params("/v1/billing_portal/configurations", [], []) + Stripe.OpenApi.Path.replace_path_params( + "/v1/billing_portal/configurations/{configuration}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "configuration", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "configuration", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [configuration] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -199,45 +205,25 @@ defmodule Stripe.BillingPortal.Configuration do ( nil - @doc "

Updates a configuration that describes the functionality of the customer portal.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing_portal/configurations/{configuration}`\n" + @doc "

Creates a configuration that describes the functionality and behavior of a PortalSession

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing_portal/configurations`\n" ( - @spec update( - configuration :: binary(), + @spec create( params :: %{ - optional(:active) => boolean, optional(:business_profile) => business_profile, optional(:default_return_url) => binary | binary, optional(:expand) => list(binary), optional(:features) => features, optional(:login_page) => login_page, - optional(:metadata) => %{optional(binary) => binary} | binary + optional(:metadata) => %{optional(binary) => binary} }, opts :: Keyword.t() ) :: {:ok, Stripe.BillingPortal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(configuration, params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/billing_portal/configurations/{configuration}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "configuration", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "configuration", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [configuration] - ) + Stripe.OpenApi.Path.replace_path_params("/v1/billing_portal/configurations", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -251,17 +237,25 @@ defmodule Stripe.BillingPortal.Configuration do ( nil - @doc "

Retrieves a configuration that describes the functionality of the customer portal.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/billing_portal/configurations/{configuration}`\n" + @doc "

Updates a configuration that describes the functionality of the customer portal.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing_portal/configurations/{configuration}`\n" ( - @spec retrieve( + @spec update( configuration :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:active) => boolean, + optional(:business_profile) => business_profile, + optional(:default_return_url) => binary | binary, + optional(:expand) => list(binary), + optional(:features) => features, + optional(:login_page) => login_page, + optional(:metadata) => %{optional(binary) => binary} | binary + }, opts :: Keyword.t() ) :: {:ok, Stripe.BillingPortal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(configuration, params \\ %{}, opts \\ []) do + def update(configuration, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/billing_portal/configurations/{configuration}", @@ -286,9 +280,9 @@ defmodule Stripe.BillingPortal.Configuration do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/billing_portal__session.ex b/lib/generated/billing_portal__session.ex index cd647ae6..939dcfde 100644 --- a/lib/generated/billing_portal__session.ex +++ b/lib/generated/billing_portal__session.ex @@ -1,7 +1,7 @@ defmodule Stripe.BillingPortal.Session do use Stripe.Entity - @moduledoc "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nLearn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal)." + @moduledoc "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nRelated guide: [Customer management](/customer-management)" ( defstruct [ :configuration, @@ -17,7 +17,7 @@ defmodule Stripe.BillingPortal.Session do :url ] - @typedoc "The `billing_portal.session` type.\n\n * `configuration` The configuration used by this session, describing the features available.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` The ID of the customer for this session.\n * `flow` 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.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `locale` The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.\n * `return_url` The URL to redirect customers to when they click on the portal's link to return to your website.\n * `url` The short-lived URL of the session that gives customers access to the customer portal.\n" + @typedoc "The `billing_portal.session` type.\n\n * `configuration` The configuration used by this session, describing the features available.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` The ID of the customer for this session.\n * `flow` 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.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `locale` The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.\n * `return_url` The URL to redirect customers to when they click on the portal's link to return to your website.\n * `url` The short-lived URL of the session that gives customers access to the customer portal.\n" @type t :: %__MODULE__{ configuration: binary | Stripe.BillingPortal.Configuration.t(), created: integer, @@ -194,4 +194,4 @@ defmodule Stripe.BillingPortal.Session do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/capability.ex b/lib/generated/capability.ex index 5f93277a..a4ca6471 100644 --- a/lib/generated/capability.ex +++ b/lib/generated/capability.ex @@ -180,4 +180,4 @@ defmodule Stripe.Capability do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/card.ex b/lib/generated/card.ex index 39d69b32..b7191d58 100644 --- a/lib/generated/card.ex +++ b/lib/generated/card.ex @@ -32,12 +32,13 @@ defmodule Stripe.Card do :last4, :metadata, :name, + :networks, :object, :status, :tokenization_method ] - @typedoc "The `card` type.\n\n * `account` The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.\n * `address_city` City/District/Suburb/Town/Village.\n * `address_country` Billing address country, if provided when creating card.\n * `address_line1` Address line 1 (Street address/PO Box/Company name).\n * `address_line1_check` If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.\n * `address_line2` Address line 2 (Apartment/Suite/Unit/Building).\n * `address_state` State/County/Province/Region.\n * `address_zip` ZIP or postal code.\n * `address_zip_check` If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.\n * `available_payout_methods` A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.\n * `brand` Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.\n * `country` Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.\n * `currency` Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.\n * `customer` The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.\n * `cvc_check` If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).\n * `default_for_currency` Whether this card is the default external account for its currency.\n * `description` A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)\n * `dynamic_last4` (For tokenized numbers only.) The last four digits of the device account number.\n * `exp_month` Two-digit number representing the card's expiration month.\n * `exp_year` Four-digit number representing the card's expiration year.\n * `fingerprint` Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*\n * `funding` Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.\n * `id` Unique identifier for the object.\n * `iin` Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)\n * `issuer` The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)\n * `last4` The last four digits of the card.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` Cardholder name.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.\n * `tokenization_method` If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.\n" + @typedoc "The `card` type.\n\n * `account` The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.\n * `address_city` City/District/Suburb/Town/Village.\n * `address_country` Billing address country, if provided when creating card.\n * `address_line1` Address line 1 (Street address/PO Box/Company name).\n * `address_line1_check` If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.\n * `address_line2` Address line 2 (Apartment/Suite/Unit/Building).\n * `address_state` State/County/Province/Region.\n * `address_zip` ZIP or postal code.\n * `address_zip_check` If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.\n * `available_payout_methods` A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.\n * `brand` Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.\n * `country` Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.\n * `currency` Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.\n * `customer` The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.\n * `cvc_check` If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).\n * `default_for_currency` Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.\n * `description` A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)\n * `dynamic_last4` (For tokenized numbers only.) The last four digits of the device account number.\n * `exp_month` Two-digit number representing the card's expiration month.\n * `exp_year` Four-digit number representing the card's expiration year.\n * `fingerprint` Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*\n * `funding` Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.\n * `id` Unique identifier for the object.\n * `iin` Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)\n * `issuer` The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)\n * `last4` The last four digits of the card.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` Cardholder name.\n * `networks` \n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.\n * `tokenization_method` If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.\n" @type t :: %__MODULE__{ account: (binary | Stripe.Account.t()) | nil, address_city: binary | nil, @@ -67,6 +68,7 @@ defmodule Stripe.Card do last4: binary, metadata: term | nil, name: binary | nil, + networks: term, object: binary, status: binary | nil, tokenization_method: binary | nil @@ -74,67 +76,37 @@ defmodule Stripe.Card do ) ( - @typedoc "Owner's address." - @type address :: %{ - optional(:city) => binary, - optional(:country) => binary, - optional(:line1) => binary, - optional(:line2) => binary, - optional(:postal_code) => binary, - optional(:state) => binary - } + @typedoc "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check." + @type bank_account_ownership_verification :: %{optional(:files) => list(binary)} ) ( - @typedoc nil - @type owner :: %{ - optional(:address) => address, - optional(:email) => binary, - optional(:name) => binary, - optional(:phone) => binary + @typedoc "Documents that may be submitted to satisfy various informational requests." + @type documents :: %{ + optional(:bank_account_ownership_verification) => bank_account_ownership_verification } ) ( nil - @doc "

Update a specified source for a given customer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers/{customer}/sources/{id}`\n" + @doc "

Delete a specified external account for a given account.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" ( - @spec update( - customer :: binary(), - id :: binary(), - params :: %{ - optional(:account_holder_name) => binary, - optional(:account_holder_type) => :company | :individual, - optional(:address_city) => binary, - optional(:address_country) => binary, - optional(:address_line1) => binary, - optional(:address_line2) => binary, - optional(:address_state) => binary, - optional(:address_zip) => binary, - optional(:exp_month) => binary, - optional(:exp_year) => binary, - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:name) => binary, - optional(:owner) => owner - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Card.t() | Stripe.BankAccount.t() | Stripe.Source.t()} + @spec delete(account :: binary(), id :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedExternalAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(customer, id, params \\ %{}, opts \\ []) do + def delete(account, id, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/sources/{id}", + "/v1/accounts/{account}/external_accounts/{id}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", - name: "customer", + name: "account", required: true, schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "customer", + name: "account", title: nil, type: "string", items: [], @@ -156,13 +128,12 @@ defmodule Stripe.Card do } } ], - [customer, id] + [account, id] ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -171,28 +142,45 @@ defmodule Stripe.Card do ( nil - @doc "

Delete a specified source for a given customer.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}/sources/{id}`\n" + @doc "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" ( - @spec delete( - customer :: binary(), + @spec update( + account :: binary(), id :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:account_holder_name) => binary, + optional(:account_holder_type) => :company | :individual, + optional(:account_type) => :checking | :futsu | :savings | :toza, + optional(:address_city) => binary, + optional(:address_country) => binary, + optional(:address_line1) => binary, + optional(:address_line2) => binary, + optional(:address_state) => binary, + optional(:address_zip) => binary, + optional(:default_for_currency) => boolean, + optional(:documents) => documents, + optional(:exp_month) => binary, + optional(:exp_year) => binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:name) => binary + }, opts :: Keyword.t() ) :: - {:ok, Stripe.PaymentSource.t() | Stripe.DeletedPaymentSource.t()} + {:ok, Stripe.ExternalAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(customer, id, params \\ %{}, opts \\ []) do + def update(account, id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/sources/{id}", + "/v1/accounts/{account}/external_accounts/{id}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", - name: "customer", + name: "account", required: true, schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "customer", + name: "account", title: nil, type: "string", items: [], @@ -214,15 +202,15 @@ defmodule Stripe.Card do } } ], - [customer, id] + [account, id] ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/cash_balance.ex b/lib/generated/cash_balance.ex index f79c8308..dab32ca7 100644 --- a/lib/generated/cash_balance.ex +++ b/lib/generated/cash_balance.ex @@ -103,4 +103,4 @@ defmodule Stripe.CashBalance do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/charge.ex b/lib/generated/charge.ex index aad5a87c..57d13714 100644 --- a/lib/generated/charge.ex +++ b/lib/generated/charge.ex @@ -4,57 +4,57 @@ defmodule Stripe.Charge do @moduledoc "The `Charge` object represents a single attempt to move money into your Stripe account.\nPaymentIntent confirmation is the most common way to create Charges, but transferring\nmoney to a different Stripe account through Connect also creates Charges.\nSome legacy payment flows create Charges directly, which is not recommended for new integrations." ( defstruct [ + :receipt_url, + :failure_message, + :radar_options, :shipping, - :id, - :transfer_data, - :statement_descriptor_suffix, - :application_fee_amount, - :disputed, - :transfer_group, - :status, - :source_transfer, - :transfer, - :created, - :currency, :refunded, :amount_refunded, - :captured, + :livemode, + :customer, + :statement_descriptor, + :receipt_email, + :payment_method, + :created, + :transfer_data, + :balance_transaction, + :payment_intent, :source, - :authorization_code, :level3, - :billing_details, - :amount_captured, - :object, - :failure_code, - :receipt_number, - :failure_balance_transaction, - :receipt_email, :application, - :balance_transaction, - :statement_descriptor, - :payment_method_details, - :invoice, - :outcome, - :amount, - :fraud_details, - :customer, - :on_behalf_of, + :authorization_code, + :disputed, :refunds, - :payment_intent, - :review, - :failure_message, + :statement_descriptor_suffix, + :invoice, :application_fee, + :amount_captured, + :status, :paid, :description, - :metadata, - :radar_options, + :id, + :payment_method_details, + :outcome, + :captured, + :application_fee_amount, + :currency, + :object, + :on_behalf_of, + :source_transfer, + :failure_code, :calculated_statement_descriptor, - :livemode, - :payment_method, - :receipt_url + :transfer, + :billing_details, + :transfer_group, + :review, + :failure_balance_transaction, + :receipt_number, + :fraud_details, + :amount, + :metadata ] - @typedoc "The `charge` type.\n\n * `amount` Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).\n * `amount_captured` Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).\n * `amount_refunded` Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).\n * `application` ID of the Connect application that created the charge.\n * `application_fee` The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.\n * `application_fee_amount` The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.\n * `authorization_code` Authorization code on the charge.\n * `balance_transaction` ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).\n * `billing_details` \n * `calculated_statement_descriptor` The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.\n * `captured` If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` ID of the customer this charge is for if one exists.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `disputed` Whether the charge has been disputed.\n * `failure_balance_transaction` ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.\n * `failure_code` Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).\n * `failure_message` Message to user further explaining reason for charge failure if available.\n * `fraud_details` Information on fraud assessments for the charge.\n * `id` Unique identifier for the object.\n * `invoice` ID of the invoice this charge is for if one exists.\n * `level3` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.\n * `outcome` Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.\n * `paid` `true` if the charge succeeded, or was successfully authorized for later capture.\n * `payment_intent` ID of the PaymentIntent associated with this charge, if one exists.\n * `payment_method` ID of the payment method used in this charge.\n * `payment_method_details` Details about the payment method at the time of the transaction.\n * `radar_options` \n * `receipt_email` This is the email address that the receipt for this charge was sent to.\n * `receipt_number` This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.\n * `receipt_url` This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.\n * `refunded` Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.\n * `refunds` A list of refunds that have been applied to the charge.\n * `review` ID of the review associated with this charge if one exists.\n * `shipping` Shipping information for the charge.\n * `source` This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.\n * `source_transfer` The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.\n * `statement_descriptor` For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.\n * `statement_descriptor_suffix` Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.\n * `status` The status of the payment is either `succeeded`, `pending`, or `failed`.\n * `transfer` ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).\n * `transfer_data` 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.\n * `transfer_group` A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.\n" + @typedoc "The `charge` type.\n\n * `amount` Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).\n * `amount_captured` Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).\n * `amount_refunded` Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).\n * `application` ID of the Connect application that created the charge.\n * `application_fee` The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.\n * `application_fee_amount` The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.\n * `authorization_code` Authorization code on the charge.\n * `balance_transaction` ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).\n * `billing_details` \n * `calculated_statement_descriptor` The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.\n * `captured` If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` ID of the customer this charge is for if one exists.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `disputed` Whether the charge has been disputed.\n * `failure_balance_transaction` ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.\n * `failure_code` Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).\n * `failure_message` Message to user further explaining reason for charge failure if available.\n * `fraud_details` Information on fraud assessments for the charge.\n * `id` Unique identifier for the object.\n * `invoice` ID of the invoice this charge is for if one exists.\n * `level3` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.\n * `outcome` Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.\n * `paid` `true` if the charge succeeded, or was successfully authorized for later capture.\n * `payment_intent` ID of the PaymentIntent associated with this charge, if one exists.\n * `payment_method` ID of the payment method used in this charge.\n * `payment_method_details` Details about the payment method at the time of the transaction.\n * `radar_options` \n * `receipt_email` This is the email address that the receipt for this charge was sent to.\n * `receipt_number` This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.\n * `receipt_url` This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.\n * `refunded` Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.\n * `refunds` A list of refunds that have been applied to the charge.\n * `review` ID of the review associated with this charge if one exists.\n * `shipping` Shipping information for the charge.\n * `source` This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.\n * `source_transfer` The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.\n * `statement_descriptor` For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.\n * `statement_descriptor_suffix` Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.\n * `status` The status of the payment is either `succeeded`, `pending`, or `failed`.\n * `transfer` ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).\n * `transfer_data` 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.\n * `transfer_group` A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.\n" @type t :: %__MODULE__{ amount: integer, amount_captured: integer, @@ -163,22 +163,26 @@ defmodule Stripe.Charge do ( nil - @doc "

Search for charges you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/charges/search`\n" + @doc "

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/charges`\n" ( - @spec search( + @spec list( params :: %{ + optional(:created) => created | integer, + optional(:customer) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:limit) => integer, - optional(:page) => binary, - optional(:query) => binary + optional(:payment_intent) => binary, + optional(:starting_after) => binary, + optional(:transfer_group) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.SearchResult.t(Stripe.Charge.t())} + {:ok, Stripe.List.t(Stripe.Charge.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def search(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/charges/search", [], []) + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/charges", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -192,26 +196,63 @@ defmodule Stripe.Charge do ( nil - @doc "

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/charges`\n" + @doc "

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/charges/{charge}`\n" ( - @spec list( + @spec retrieve( + charge :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: {:ok, Stripe.Charge.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(charge, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/charges/{charge}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "charge", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "charge", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [charge] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Search for charges you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/charges/search`\n" + ( + @spec search( params :: %{ - optional(:created) => created | integer, - optional(:customer) => binary, - optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:limit) => integer, - optional(:payment_intent) => binary, - optional(:starting_after) => binary, - optional(:transfer_group) => binary + optional(:page) => binary, + optional(:query) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Charge.t())} + {:ok, Stripe.SearchResult.t(Stripe.Charge.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/charges", [], []) + def search(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/charges/search", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -225,7 +266,7 @@ defmodule Stripe.Charge do ( nil - @doc "

Use the Payment Intents API to initiate a new payment instead\nof using this method. Confirmation of the PaymentIntent creates the Charge\nobject used to request payment, so this method is limited to legacy integrations.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/charges`\n" + @doc "

This method is no longer recommended—use the Payment Intents API\nto initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge\nobject used to request payment.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/charges`\n" ( @spec create( params :: %{ @@ -263,47 +304,6 @@ defmodule Stripe.Charge do ) ) - ( - nil - - @doc "

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/charges/{charge}`\n" - ( - @spec retrieve( - charge :: binary(), - params :: %{optional(:expand) => list(binary)}, - opts :: Keyword.t() - ) :: {:ok, Stripe.Charge.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(charge, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/charges/{charge}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "charge", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "charge", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [charge] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -404,4 +404,4 @@ defmodule Stripe.Charge do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/checkout__session.ex b/lib/generated/checkout__session.ex index c7f510cf..8509daf5 100644 --- a/lib/generated/checkout__session.ex +++ b/lib/generated/checkout__session.ex @@ -4,63 +4,64 @@ defmodule Stripe.Checkout.Session do @moduledoc "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)" ( defstruct [ - :shipping_options, - :id, + :line_items, + :success_url, + :allow_promotion_codes, + :consent_collection, + :mode, + :currency_conversion, + :ui_mode, + :shipping_cost, + :livemode, + :customer, + :billing_address_collection, + :setup_intent, + :after_expiration, + :return_url, + :created, :consent, - :shipping_details, + :payment_intent, + :expires_at, + :customer_creation, + :customer_details, + :invoice, :status, + :payment_link, + :amount_total, + :id, :cancel_url, - :billing_address_collection, - :payment_method_configuration_details, - :allow_promotion_codes, - :subscription, + :automatic_tax, + :phone_number_collection, + :invoice_creation, + :payment_method_options, + :currency, :url, + :object, :payment_method_collection, - :amount_total, - :amount_subtotal, - :redirect_on_completion, - :currency_conversion, - :created, - :currency, + :client_secret, + :shipping_details, + :payment_method_types, :tax_id_collection, - :after_expiration, + :saved_payment_method_options, :client_reference_id, - :setup_intent, - :automatic_tax, - :expires_at, - :total_details, - :object, - :recovered_from, - :client_secret, - :success_url, - :mode, - :custom_text, - :invoice, - :submit_type, - :shipping_cost, - :customer, - :invoice_creation, - :phone_number_collection, - :customer_details, :customer_email, - :payment_intent, - :consent_collection, - :shipping_address_collection, - :return_url, + :recovered_from, + :total_details, :locale, - :payment_method_types, - :metadata, - :payment_link, - :customer_creation, + :shipping_options, + :subscription, + :redirect_on_completion, + :amount_subtotal, + :payment_status, :custom_fields, - :line_items, - :payment_method_options, - :livemode, - :ui_mode, - :payment_status + :metadata, + :custom_text, + :shipping_address_collection, + :submit_type, + :payment_method_configuration_details ] - @typedoc "The `checkout.session` type.\n\n * `after_expiration` When set, provides configuration for actions to take if this Checkout Session expires.\n * `allow_promotion_codes` Enables user redeemable promotion codes.\n * `amount_subtotal` Total of all items before discounts or taxes are applied.\n * `amount_total` Total of all items after discounts and taxes are applied.\n * `automatic_tax` \n * `billing_address_collection` Describes whether Checkout should collect the customer's billing address.\n * `cancel_url` If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.\n * `client_reference_id` A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems.\n * `client_secret` Client secret to be used when initializing Stripe.js embedded checkout.\n * `consent` Results of `consent_collection` for this session.\n * `consent_collection` When set, provides configuration for the Checkout Session to gather active consent from customers.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `currency_conversion` Currency conversion details for automatic currency conversion sessions\n * `custom_fields` Collect additional information from your customer using custom fields. Up to 2 fields are supported.\n * `custom_text` \n * `customer` The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.\n * `customer_creation` Configure whether a Checkout Session creates a Customer when the Checkout Session completes.\n * `customer_details` The customer details including the customer's tax exempt status and the customer's tax IDs. Only the customer's email is present on Sessions in `setup` mode.\n * `customer_email` If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute.\n * `expires_at` The timestamp at which the Checkout Session will expire.\n * `id` Unique identifier for the object.\n * `invoice` ID of the invoice created by the Checkout Session, if it exists.\n * `invoice_creation` Details on the state of invoice creation for the Checkout Session.\n * `line_items` The line items purchased by the customer.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `locale` The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `mode` The mode of the Checkout Session.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `payment_intent` The ID of the PaymentIntent for Checkout Sessions in `payment` mode.\n * `payment_link` The ID of the Payment Link that created this Session.\n * `payment_method_collection` Configure whether a Checkout Session should collect a payment method.\n * `payment_method_configuration_details` Information about the payment method configuration used for this Checkout session if using dynamic payment methods.\n * `payment_method_options` Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.\n * `payment_method_types` A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept.\n * `payment_status` The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order.\n * `phone_number_collection` \n * `recovered_from` The ID of the original expired Checkout Session that triggered the recovery flow.\n * `redirect_on_completion` Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.\n * `return_url` Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.\n * `setup_intent` The ID of the SetupIntent for Checkout Sessions in `setup` mode.\n * `shipping_address_collection` When set, provides configuration for Checkout to collect a shipping address from a customer.\n * `shipping_cost` The details of the customer cost of shipping, including the customer chosen ShippingRate.\n * `shipping_details` Shipping information for this Checkout Session.\n * `shipping_options` The shipping rate options applied to this Session.\n * `status` The status of the Checkout Session, one of `open`, `complete`, or `expired`.\n * `submit_type` Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode, but not Checkout Sessions\nin `subscription` or `setup` mode. Possible values are `auto`, `pay`, `book`, `donate`. If blank or `auto`, `pay` is used.\n * `subscription` The ID of the subscription for Checkout Sessions in `subscription` mode.\n * `success_url` The URL the customer will be directed to after the payment or\nsubscription creation is successful.\n * `tax_id_collection` \n * `total_details` Tax and discount details for the computed total amount.\n * `ui_mode` The UI mode of the Session. Can be `hosted` (default) or `embedded`.\n * `url` The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.\n" + @typedoc "The `checkout.session` type.\n\n * `after_expiration` When set, provides configuration for actions to take if this Checkout Session expires.\n * `allow_promotion_codes` Enables user redeemable promotion codes.\n * `amount_subtotal` Total of all items before discounts or taxes are applied.\n * `amount_total` Total of all items after discounts and taxes are applied.\n * `automatic_tax` \n * `billing_address_collection` Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.\n * `cancel_url` If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.\n * `client_reference_id` A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems.\n * `client_secret` Client secret to be used when initializing Stripe.js embedded checkout.\n * `consent` Results of `consent_collection` for this session.\n * `consent_collection` When set, provides configuration for the Checkout Session to gather active consent from customers.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `currency_conversion` Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions\n * `custom_fields` Collect additional information from your customer using custom fields. Up to 3 fields are supported.\n * `custom_text` \n * `customer` The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.\n * `customer_creation` Configure whether a Checkout Session creates a Customer when the Checkout Session completes.\n * `customer_details` The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.\n * `customer_email` If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute.\n * `expires_at` The timestamp at which the Checkout Session will expire.\n * `id` Unique identifier for the object.\n * `invoice` ID of the invoice created by the Checkout Session, if it exists.\n * `invoice_creation` Details on the state of invoice creation for the Checkout Session.\n * `line_items` The line items purchased by the customer.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `locale` The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `mode` The mode of the Checkout Session.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `payment_intent` The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.\n * `payment_link` The ID of the Payment Link that created this Session.\n * `payment_method_collection` Configure whether a Checkout Session should collect a payment method. Defaults to `always`.\n * `payment_method_configuration_details` Information about the payment method configuration used for this Checkout session if using dynamic payment methods.\n * `payment_method_options` Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.\n * `payment_method_types` A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept.\n * `payment_status` The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order.\n * `phone_number_collection` \n * `recovered_from` The ID of the original expired Checkout Session that triggered the recovery flow.\n * `redirect_on_completion` This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.\n * `return_url` Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.\n * `saved_payment_method_options` Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.\n * `setup_intent` The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.\n * `shipping_address_collection` When set, provides configuration for Checkout to collect a shipping address from a customer.\n * `shipping_cost` The details of the customer cost of shipping, including the customer chosen ShippingRate.\n * `shipping_details` Shipping information for this Checkout Session.\n * `shipping_options` The shipping rate options applied to this Session.\n * `status` The status of the Checkout Session, one of `open`, `complete`, or `expired`.\n * `submit_type` Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.\n * `subscription` The ID of the subscription for Checkout Sessions in `subscription` mode.\n * `success_url` The URL the customer will be directed to after the payment or\nsubscription creation is successful.\n * `tax_id_collection` \n * `total_details` Tax and discount details for the computed total amount.\n * `ui_mode` The UI mode of the Session. Defaults to `hosted`.\n * `url` The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.\n" @type t :: %__MODULE__{ after_expiration: term | nil, allow_promotion_codes: boolean | nil, @@ -103,6 +104,7 @@ defmodule Stripe.Checkout.Session do recovered_from: binary | nil, redirect_on_completion: binary, return_url: binary, + saved_payment_method_options: term | nil, setup_intent: (binary | Stripe.SetupIntent.t()) | nil, shipping_address_collection: term | nil, shipping_cost: term | nil, @@ -175,6 +177,11 @@ defmodule Stripe.Checkout.Session do @type alipay :: %{optional(:setup_future_usage) => :none} ) + ( + @typedoc "contains details about the AmazonPay payment method options." + @type amazon_pay :: %{optional(:setup_future_usage) => :none | :off_session} + ) + ( @typedoc "contains details about the AU Becs Debit payment method options." @type au_becs_debit :: %{optional(:setup_future_usage) => :none} @@ -182,7 +189,7 @@ defmodule Stripe.Checkout.Session do ( @typedoc "Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions." - @type automatic_tax :: %{optional(:enabled) => boolean} + @type automatic_tax :: %{optional(:enabled) => boolean, optional(:liability) => liability} ) ( @@ -222,6 +229,7 @@ defmodule Stripe.Checkout.Session do @typedoc "contains details about the Card payment method options." @type card :: %{ optional(:installments) => installments, + optional(:request_three_d_secure) => :any | :automatic | :challenge, optional(:setup_future_usage) => :off_session | :on_session, optional(:statement_descriptor_suffix_kana) => binary, optional(:statement_descriptor_suffix_kanji) => binary @@ -254,15 +262,7 @@ defmodule Stripe.Checkout.Session do ( @typedoc nil - @type custom_fields :: %{ - optional(:dropdown) => dropdown, - optional(:key) => binary, - optional(:label) => label, - optional(:numeric) => numeric, - optional(:optional) => boolean, - optional(:text) => text, - optional(:type) => :dropdown | :numeric | :text - } + @type custom_fields :: %{optional(:name) => binary, optional(:value) => binary} ) ( @@ -310,7 +310,7 @@ defmodule Stripe.Checkout.Session do ( @typedoc "Configuration for `type=dropdown` fields." - @type dropdown :: %{optional(:options) => list(options)} + @type dropdown :: %{optional(:default_value) => binary, optional(:options) => list(options)} ) ( @@ -335,7 +335,7 @@ defmodule Stripe.Checkout.Session do @type financial_connections :: %{ optional(:permissions) => list(:balances | :ownership | :payment_method | :transactions), - optional(:prefetch) => list(:balances | :transactions) + optional(:prefetch) => list(:balances | :ownership | :transactions) } ) @@ -388,11 +388,22 @@ defmodule Stripe.Checkout.Session do optional(:custom_fields) => list(custom_fields) | binary, optional(:description) => binary, optional(:footer) => binary, + optional(:issuer) => issuer, optional(:metadata) => %{optional(binary) => binary}, optional(:rendering_options) => rendering_options | binary } ) + ( + @typedoc "All invoices will be billed using the specified settings." + @type invoice_settings :: %{optional(:issuer) => issuer} + ) + + ( + @typedoc "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account." + @type issuer :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + ( @typedoc "contains details about the Klarna payment method options." @type klarna :: %{optional(:setup_future_usage) => :none} @@ -411,6 +422,11 @@ defmodule Stripe.Checkout.Session do @type label :: %{optional(:custom) => binary, optional(:type) => :custom} ) + ( + @typedoc "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." + @type liability :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + ( @typedoc nil @type line_items :: %{ @@ -455,9 +471,23 @@ defmodule Stripe.Checkout.Session do } ) + ( + @typedoc "contains details about the Mobilepay payment method options." + @type mobilepay :: %{optional(:setup_future_usage) => :none} + ) + + ( + @typedoc "contains details about the Multibanco payment method options." + @type multibanco :: %{optional(:setup_future_usage) => :none} + ) + ( @typedoc "Configuration for `type=numeric` fields." - @type numeric :: %{optional(:maximum_length) => integer, optional(:minimum_length) => integer} + @type numeric :: %{ + optional(:default_value) => binary, + optional(:maximum_length) => integer, + optional(:minimum_length) => integer + } ) ( @@ -499,38 +529,49 @@ defmodule Stripe.Checkout.Session do } ) + ( + @typedoc "This parameter allows you to set some attributes on the payment method created during a Checkout session." + @type payment_method_data :: %{ + optional(:allow_redisplay) => :always | :limited | :unspecified + } + ) + ( @typedoc "Payment-method-specific configuration." @type payment_method_options :: %{ - optional(:acss_debit) => acss_debit, - optional(:affirm) => affirm, - optional(:afterpay_clearpay) => afterpay_clearpay, + optional(:sofort) => sofort, + optional(:customer_balance) => customer_balance, + optional(:boleto) => boleto, optional(:alipay) => alipay, optional(:au_becs_debit) => au_becs_debit, - optional(:bacs_debit) => bacs_debit, + optional(:amazon_pay) => amazon_pay, optional(:bancontact) => bancontact, - optional(:boleto) => boleto, - optional(:card) => card, - optional(:cashapp) => cashapp, - optional(:customer_balance) => customer_balance, - optional(:eps) => eps, - optional(:fpx) => fpx, - optional(:giropay) => giropay, + optional(:bacs_debit) => bacs_debit, + optional(:affirm) => affirm, + optional(:mobilepay) => mobilepay, optional(:grabpay) => grabpay, + optional(:eps) => eps, optional(:ideal) => ideal, + optional(:pix) => pix, + optional(:giropay) => giropay, + optional(:multibanco) => multibanco, + optional(:revolut_pay) => revolut_pay, optional(:klarna) => klarna, - optional(:konbini) => konbini, + optional(:card) => card, + optional(:acss_debit) => acss_debit, optional(:link) => link, - optional(:oxxo) => oxxo, + optional(:konbini) => konbini, optional(:p24) => p24, - optional(:paynow) => paynow, optional(:paypal) => paypal, - optional(:pix) => pix, - optional(:revolut_pay) => revolut_pay, + optional(:fpx) => fpx, + optional(:oxxo) => oxxo, + optional(:paynow) => paynow, + optional(:wechat_pay) => wechat_pay, + optional(:cashapp) => cashapp, optional(:sepa_debit) => sepa_debit, - optional(:sofort) => sofort, + optional(:afterpay_clearpay) => afterpay_clearpay, optional(:us_bank_account) => us_bank_account, - optional(:wechat_pay) => wechat_pay + optional(:swish) => swish } ) @@ -638,6 +679,14 @@ defmodule Stripe.Checkout.Session do @type revolut_pay :: %{optional(:setup_future_usage) => :none | :off_session} ) + ( + @typedoc "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode." + @type saved_payment_method_options :: %{ + optional(:allow_redisplay_filters) => list(:always | :limited | :unspecified), + optional(:payment_method_save) => :disabled | :enabled + } + ) + ( @typedoc "contains details about the Sepa Debit payment method options." @type sepa_debit :: %{optional(:setup_future_usage) => :none | :off_session | :on_session} @@ -923,7 +972,7 @@ defmodule Stripe.Checkout.Session do ) ( - @typedoc "Parameters to be passed to Shipping Rate creation for this shipping option" + @typedoc "Parameters to be passed to Shipping Rate creation for this shipping option." @type shipping_rate_data :: %{ optional(:delivery_estimate) => delivery_estimate, optional(:display_name) => binary, @@ -952,6 +1001,7 @@ defmodule Stripe.Checkout.Session do optional(:billing_cycle_anchor) => integer, optional(:default_tax_rates) => list(binary), optional(:description) => binary, + optional(:invoice_settings) => invoice_settings, optional(:metadata) => %{optional(binary) => binary}, optional(:on_behalf_of) => binary, optional(:proration_behavior) => :create_prorations | :none, @@ -963,7 +1013,12 @@ defmodule Stripe.Checkout.Session do ) ( - @typedoc "Controls tax ID collection settings for the session." + @typedoc "contains details about the Swish payment method options." + @type swish :: %{optional(:reference) => binary} + ) + + ( + @typedoc "Controls tax ID collection during checkout." @type tax_id_collection :: %{optional(:enabled) => boolean} ) @@ -974,7 +1029,11 @@ defmodule Stripe.Checkout.Session do ( @typedoc "Configuration for `type=text` fields." - @type text :: %{optional(:maximum_length) => integer, optional(:minimum_length) => integer} + @type text :: %{ + optional(:default_value) => binary, + optional(:maximum_length) => integer, + optional(:minimum_length) => integer + } ) ( @@ -1085,6 +1144,55 @@ defmodule Stripe.Checkout.Session do ) ) + ( + nil + + @doc "

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/checkout/sessions/{session}/line_items`\n" + ( + @spec list_line_items( + session :: binary(), + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Item.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list_line_items(session, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/checkout/sessions/{session}/line_items", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "session", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "session", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [session] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -1092,49 +1200,15 @@ defmodule Stripe.Checkout.Session do ( @spec create( params :: %{ - optional(:ui_mode) => :embedded | :hosted, - optional(:payment_method_options) => payment_method_options, - optional(:line_items) => list(line_items), - optional(:custom_fields) => list(custom_fields), - optional(:customer_creation) => :always | :if_required, - optional(:expand) => list(binary), + optional(:submit_type) => :auto | :book | :donate | :pay, + optional(:shipping_address_collection) => shipping_address_collection, + optional(:custom_text) => custom_text, optional(:metadata) => %{optional(binary) => binary}, - optional(:subscription_data) => subscription_data, - optional(:payment_method_types) => - list( - :acss_debit - | :affirm - | :afterpay_clearpay - | :alipay - | :au_becs_debit - | :bacs_debit - | :bancontact - | :blik - | :boleto - | :card - | :cashapp - | :customer_balance - | :eps - | :fpx - | :giropay - | :grabpay - | :ideal - | :klarna - | :konbini - | :link - | :oxxo - | :p24 - | :paynow - | :paypal - | :pix - | :promptpay - | :revolut_pay - | :sepa_debit - | :sofort - | :us_bank_account - | :wechat_pay - | :zip - ), + optional(:custom_fields) => list(custom_fields), + optional(:setup_intent_data) => setup_intent_data, + optional(:redirect_on_completion) => :always | :if_required | :never, + optional(:payment_method_configuration) => binary, + optional(:shipping_options) => list(shipping_options), optional(:locale) => :auto | :bg @@ -1177,34 +1251,75 @@ defmodule Stripe.Checkout.Session do | :zh | :"zh-HK" | :"zh-TW", - optional(:return_url) => binary, - optional(:shipping_address_collection) => shipping_address_collection, - optional(:consent_collection) => consent_collection, + optional(:payment_intent_data) => payment_intent_data, optional(:customer_email) => binary, - optional(:phone_number_collection) => phone_number_collection, - optional(:invoice_creation) => invoice_creation, - optional(:customer) => binary, - optional(:submit_type) => :auto | :book | :donate | :pay, - optional(:customer_update) => customer_update, - optional(:custom_text) => custom_text, - optional(:mode) => :payment | :setup | :subscription, - optional(:success_url) => binary, - optional(:expires_at) => integer, - optional(:automatic_tax) => automatic_tax, optional(:client_reference_id) => binary, - optional(:after_expiration) => after_expiration, + optional(:saved_payment_method_options) => saved_payment_method_options, optional(:tax_id_collection) => tax_id_collection, - optional(:currency) => binary, + optional(:payment_method_types) => + list( + :acss_debit + | :affirm + | :afterpay_clearpay + | :alipay + | :amazon_pay + | :au_becs_debit + | :bacs_debit + | :bancontact + | :blik + | :boleto + | :card + | :cashapp + | :customer_balance + | :eps + | :fpx + | :giropay + | :grabpay + | :ideal + | :klarna + | :konbini + | :link + | :mobilepay + | :multibanco + | :oxxo + | :p24 + | :paynow + | :paypal + | :pix + | :promptpay + | :revolut_pay + | :sepa_debit + | :sofort + | :swish + | :twint + | :us_bank_account + | :wechat_pay + | :zip + ), optional(:discounts) => list(discounts), - optional(:redirect_on_completion) => :always | :if_required | :never, - optional(:payment_method_configuration) => binary, optional(:payment_method_collection) => :always | :if_required, - optional(:allow_promotion_codes) => boolean, - optional(:billing_address_collection) => :auto | :required, - optional(:setup_intent_data) => setup_intent_data, + optional(:currency) => binary, + optional(:payment_method_options) => payment_method_options, + optional(:invoice_creation) => invoice_creation, + optional(:phone_number_collection) => phone_number_collection, + optional(:automatic_tax) => automatic_tax, optional(:cancel_url) => binary, - optional(:payment_intent_data) => payment_intent_data, - optional(:shipping_options) => list(shipping_options) + optional(:customer_creation) => :always | :if_required, + optional(:expires_at) => integer, + optional(:subscription_data) => subscription_data, + optional(:return_url) => binary, + optional(:after_expiration) => after_expiration, + optional(:billing_address_collection) => :auto | :required, + optional(:customer) => binary, + optional(:expand) => list(binary), + optional(:payment_method_data) => payment_method_data, + optional(:ui_mode) => :embedded | :hosted, + optional(:mode) => :payment | :setup | :subscription, + optional(:consent_collection) => consent_collection, + optional(:allow_promotion_codes) => boolean, + optional(:success_url) => binary, + optional(:line_items) => list(line_items), + optional(:customer_update) => customer_update }, opts :: Keyword.t() ) :: @@ -1226,25 +1341,23 @@ defmodule Stripe.Checkout.Session do ( nil - @doc "

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/checkout/sessions/{session}/line_items`\n" + @doc "

Updates a Session object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/checkout/sessions/{session}`\n" ( - @spec list_line_items( + @spec update( session :: binary(), params :: %{ - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary + optional(:metadata) => %{optional(binary) => binary} | binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Item.t())} + {:ok, Stripe.Checkout.Session.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list_line_items(session, params \\ %{}, opts \\ []) do + def update(session, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/checkout/sessions/{session}/line_items", + "/v1/checkout/sessions/{session}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1266,7 +1379,7 @@ defmodule Stripe.Checkout.Session do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -1315,4 +1428,4 @@ defmodule Stripe.Checkout.Session do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/climate__order.ex b/lib/generated/climate__order.ex index 290696aa..862938eb 100644 --- a/lib/generated/climate__order.ex +++ b/lib/generated/climate__order.ex @@ -60,6 +60,35 @@ defmodule Stripe.Climate.Order do @type beneficiary :: %{optional(:public_name) => binary} ) + ( + nil + + @doc "

Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/orders`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Climate.Order.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/climate/orders", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -102,35 +131,6 @@ defmodule Stripe.Climate.Order do ) ) - ( - nil - - @doc "

Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/orders`\n" - ( - @spec list( - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Climate.Order.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/climate/orders", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -210,7 +210,7 @@ defmodule Stripe.Climate.Order do ( nil - @doc "

Cancels a Climate order. You can cancel an order within 30 days of creation. Stripe refunds the\nreservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the amount_total.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/climate/orders/{order}/cancel`\n" + @doc "

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the\nreservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the amount_total.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/climate/orders/{order}/cancel`\n" ( @spec cancel( order :: binary(), @@ -248,4 +248,4 @@ defmodule Stripe.Climate.Order do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/climate__product.ex b/lib/generated/climate__product.ex index 431d61db..51eb0546 100644 --- a/lib/generated/climate__product.ex +++ b/lib/generated/climate__product.ex @@ -29,6 +29,35 @@ defmodule Stripe.Climate.Product do } ) + ( + nil + + @doc "

Lists all available Climate product objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/products`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Climate.Product.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/climate/products", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -72,33 +101,4 @@ defmodule Stripe.Climate.Product do end ) ) - - ( - nil - - @doc "

Lists all available Climate product objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/products`\n" - ( - @spec list( - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Climate.Product.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/climate/products", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/climate__supplier.ex b/lib/generated/climate__supplier.ex index 93ba0dd9..f25e6db3 100644 --- a/lib/generated/climate__supplier.ex +++ b/lib/generated/climate__supplier.ex @@ -16,6 +16,35 @@ defmodule Stripe.Climate.Supplier do } ) + ( + nil + + @doc "

Lists all available Climate supplier objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/suppliers`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Climate.Supplier.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/climate/suppliers", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -59,33 +88,4 @@ defmodule Stripe.Climate.Supplier do end ) ) - - ( - nil - - @doc "

Lists all available Climate supplier objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/climate/suppliers`\n" - ( - @spec list( - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Climate.Supplier.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/climate/suppliers", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/confirmation_token.ex b/lib/generated/confirmation_token.ex new file mode 100644 index 00000000..ce915618 --- /dev/null +++ b/lib/generated/confirmation_token.ex @@ -0,0 +1,417 @@ +defmodule Stripe.ConfirmationToken do + use Stripe.Entity + + @moduledoc "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation)." + ( + defstruct [ + :created, + :expires_at, + :id, + :livemode, + :mandate_data, + :object, + :payment_intent, + :payment_method_options, + :payment_method_preview, + :return_url, + :setup_future_usage, + :setup_intent, + :shipping, + :use_stripe_sdk + ] + + @typedoc "The `confirmation_token` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `expires_at` Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `mandate_data` Data used for generating a Mandate.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `payment_intent` ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.\n * `payment_method_options` Payment-method-specific configuration for this ConfirmationToken.\n * `payment_method_preview` Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.\n * `return_url` Return URL used to confirm the Intent.\n * `setup_future_usage` Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.\n * `setup_intent` ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.\n * `shipping` Shipping information collected on this ConfirmationToken.\n * `use_stripe_sdk` Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.\n" + @type t :: %__MODULE__{ + created: integer, + expires_at: integer | nil, + id: binary, + livemode: boolean, + mandate_data: term | nil, + object: binary, + payment_intent: binary | nil, + payment_method_options: term | nil, + payment_method_preview: term | nil, + return_url: binary | nil, + setup_future_usage: binary | nil, + setup_intent: binary | nil, + shipping: term | nil, + use_stripe_sdk: boolean + } + ) + + ( + @typedoc "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method." + @type acss_debit :: %{ + optional(:account_number) => binary, + optional(:institution_number) => binary, + optional(:transit_number) => binary + } + ) + + ( + @typedoc nil + @type address :: %{ + optional(:city) => binary, + optional(:country) => binary, + optional(:line1) => binary, + optional(:line2) => binary, + optional(:postal_code) => binary, + optional(:state) => binary + } + ) + + ( + @typedoc "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account." + @type au_becs_debit :: %{optional(:account_number) => binary, optional(:bsb_number) => binary} + ) + + ( + @typedoc "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account." + @type bacs_debit :: %{optional(:account_number) => binary, optional(:sort_code) => binary} + ) + + ( + @typedoc "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods." + @type billing_details :: %{ + optional(:address) => address | binary, + optional(:email) => binary | binary, + optional(:name) => binary | binary, + optional(:phone) => binary | binary + } + ) + + ( + @typedoc "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method." + @type boleto :: %{optional(:tax_id) => binary} + ) + + ( + @typedoc "Customer's date of birth" + @type dob :: %{ + optional(:day) => integer, + optional(:month) => integer, + optional(:year) => integer + } + ) + + ( + @typedoc "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method." + @type eps :: %{ + optional(:bank) => + :arzte_und_apotheker_bank + | :austrian_anadi_bank_ag + | :bank_austria + | :bankhaus_carl_spangler + | :bankhaus_schelhammer_und_schattera_ag + | :bawag_psk_ag + | :bks_bank_ag + | :brull_kallmus_bank_ag + | :btv_vier_lander_bank + | :capital_bank_grawe_gruppe_ag + | :deutsche_bank_ag + | :dolomitenbank + | :easybank_ag + | :erste_bank_und_sparkassen + | :hypo_alpeadriabank_international_ag + | :hypo_bank_burgenland_aktiengesellschaft + | :hypo_noe_lb_fur_niederosterreich_u_wien + | :hypo_oberosterreich_salzburg_steiermark + | :hypo_tirol_bank_ag + | :hypo_vorarlberg_bank_ag + | :marchfelder_bank + | :oberbank_ag + | :raiffeisen_bankengruppe_osterreich + | :schoellerbank_ag + | :sparda_bank_wien + | :volksbank_gruppe + | :volkskreditbank_ag + | :vr_bank_braunau + } + ) + + ( + @typedoc "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method." + @type fpx :: %{ + optional(:account_holder_type) => :company | :individual, + optional(:bank) => + :affin_bank + | :agrobank + | :alliance_bank + | :ambank + | :bank_islam + | :bank_muamalat + | :bank_of_china + | :bank_rakyat + | :bsn + | :cimb + | :deutsche_bank + | :hong_leong_bank + | :hsbc + | :kfh + | :maybank2e + | :maybank2u + | :ocbc + | :pb_enterprise + | :public_bank + | :rhb + | :standard_chartered + | :uob + } + ) + + ( + @typedoc "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method." + @type ideal :: %{ + optional(:bank) => + :abn_amro + | :asn_bank + | :bunq + | :handelsbanken + | :ing + | :knab + | :moneyou + | :n26 + | :nn + | :rabobank + | :regiobank + | :revolut + | :sns_bank + | :triodos_bank + | :van_lanschot + | :yoursafe + } + ) + + ( + @typedoc "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method." + @type klarna :: %{optional(:dob) => dob} + ) + + ( + @typedoc "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method." + @type p24 :: %{ + optional(:bank) => + :alior_bank + | :bank_millennium + | :bank_nowy_bfg_sa + | :bank_pekao_sa + | :banki_spbdzielcze + | :blik + | :bnp_paribas + | :boz + | :citi_handlowy + | :credit_agricole + | :envelobank + | :etransfer_pocztowy24 + | :getin_bank + | :ideabank + | :ing + | :inteligo + | :mbank_mtransfer + | :nest_przelew + | :noble_pay + | :pbac_z_ipko + | :plus_bank + | :santander_przelew24 + | :tmobile_usbugi_bankowe + | :toyota_bank + | :velobank + | :volkswagen_bank + } + ) + + ( + @typedoc "If provided, this hash will be used to create a PaymentMethod." + @type payment_method_data :: %{ + optional(:sofort) => sofort, + optional(:customer_balance) => map(), + optional(:boleto) => boleto, + optional(:alipay) => map(), + optional(:au_becs_debit) => au_becs_debit, + optional(:amazon_pay) => map(), + optional(:metadata) => %{optional(binary) => binary}, + optional(:bancontact) => map(), + optional(:interac_present) => map(), + optional(:bacs_debit) => bacs_debit, + optional(:affirm) => map(), + optional(:billing_details) => billing_details, + optional(:mobilepay) => map(), + optional(:grabpay) => map(), + optional(:eps) => eps, + optional(:ideal) => ideal, + optional(:pix) => map(), + optional(:giropay) => map(), + optional(:multibanco) => map(), + optional(:revolut_pay) => map(), + optional(:klarna) => klarna, + optional(:twint) => map(), + optional(:acss_debit) => acss_debit, + optional(:link) => map(), + optional(:konbini) => map(), + optional(:blik) => map(), + optional(:p24) => p24, + optional(:paypal) => map(), + optional(:fpx) => fpx, + optional(:oxxo) => map(), + optional(:paynow) => map(), + optional(:wechat_pay) => map(), + optional(:promptpay) => map(), + optional(:type) => + :acss_debit + | :affirm + | :afterpay_clearpay + | :alipay + | :amazon_pay + | :au_becs_debit + | :bacs_debit + | :bancontact + | :blik + | :boleto + | :cashapp + | :customer_balance + | :eps + | :fpx + | :giropay + | :grabpay + | :ideal + | :klarna + | :konbini + | :link + | :mobilepay + | :multibanco + | :oxxo + | :p24 + | :paynow + | :paypal + | :pix + | :promptpay + | :revolut_pay + | :sepa_debit + | :sofort + | :swish + | :twint + | :us_bank_account + | :wechat_pay + | :zip, + optional(:radar_options) => radar_options, + optional(:cashapp) => map(), + optional(:sepa_debit) => sepa_debit, + optional(:afterpay_clearpay) => map(), + optional(:allow_redisplay) => :always | :limited | :unspecified, + optional(:us_bank_account) => us_bank_account, + optional(:swish) => map(), + optional(:zip) => map() + } + ) + + ( + @typedoc "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information." + @type radar_options :: %{optional(:session) => binary} + ) + + ( + @typedoc "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account." + @type sepa_debit :: %{optional(:iban) => binary} + ) + + ( + @typedoc "Shipping information for this ConfirmationToken." + @type shipping :: %{ + optional(:address) => address, + optional(:name) => binary, + optional(:phone) => binary | binary + } + ) + + ( + @typedoc "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method." + @type sofort :: %{optional(:country) => :AT | :BE | :DE | :ES | :IT | :NL} + ) + + ( + @typedoc "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method." + @type us_bank_account :: %{ + optional(:account_holder_type) => :company | :individual, + optional(:account_number) => binary, + optional(:account_type) => :checking | :savings, + optional(:financial_connections_account) => binary, + optional(:routing_number) => binary + } + ) + + ( + nil + + @doc "

Retrieves an existing ConfirmationToken object

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/confirmation_tokens/{confirmation_token}`\n" + ( + @spec retrieve( + confirmation_token :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.ConfirmationToken.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def retrieve(confirmation_token, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/confirmation_tokens/{confirmation_token}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "confirmation_token", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "confirmation_token", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [confirmation_token] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a test mode Confirmation Token server side for your integration tests.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/confirmation_tokens`\n" + ( + @spec create( + params :: %{ + optional(:expand) => list(binary), + optional(:payment_method) => binary, + optional(:payment_method_data) => payment_method_data, + optional(:return_url) => binary, + optional(:setup_future_usage) => :off_session | :on_session, + optional(:shipping) => shipping + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.ConfirmationToken.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params("/v1/test_helpers/confirmation_tokens", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/country_spec.ex b/lib/generated/country_spec.ex index 51983ec1..4381200b 100644 --- a/lib/generated/country_spec.ex +++ b/lib/generated/country_spec.ex @@ -96,4 +96,4 @@ defmodule Stripe.CountrySpec do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/coupon.ex b/lib/generated/coupon.ex index 8e254f19..c675cd11 100644 --- a/lib/generated/coupon.ex +++ b/lib/generated/coupon.ex @@ -63,28 +63,35 @@ defmodule Stripe.Coupon do ( nil - @doc "

Returns a list of your coupons.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/coupons`\n" + @doc "

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/coupons/{coupon}`\n" ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Coupon.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/coupons", [], []) + @spec delete(coupon :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedCoupon.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def delete(coupon, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/coupons/{coupon}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "coupon", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "coupon", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [coupon] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -93,33 +100,28 @@ defmodule Stripe.Coupon do ( nil - @doc "

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

\n\n

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/coupons`\n" + @doc "

Returns a list of your coupons.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/coupons`\n" ( - @spec create( + @spec list( params :: %{ - optional(:amount_off) => integer, - optional(:applies_to) => applies_to, - optional(:currency) => binary, - optional(:currency_options) => map(), - optional(:duration) => :forever | :once | :repeating, - optional(:duration_in_months) => integer, + optional(:created) => created | integer, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:id) => binary, - optional(:max_redemptions) => integer, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:name) => binary, - optional(:percent_off) => number, - optional(:redeem_by) => integer + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Coupon.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Coupon.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/coupons", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -169,39 +171,28 @@ defmodule Stripe.Coupon do ( nil - @doc "

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/coupons/{coupon}`\n" + @doc "

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

\n\n

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/coupons`\n" ( - @spec update( - coupon :: binary(), + @spec create( params :: %{ + optional(:amount_off) => integer, + optional(:applies_to) => applies_to, + optional(:currency) => binary, optional(:currency_options) => map(), + optional(:duration) => :forever | :once | :repeating, + optional(:duration_in_months) => integer, optional(:expand) => list(binary), + optional(:id) => binary, + optional(:max_redemptions) => integer, optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:name) => binary + optional(:name) => binary, + optional(:percent_off) => number, + optional(:redeem_by) => integer }, opts :: Keyword.t() ) :: {:ok, Stripe.Coupon.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(coupon, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/coupons/{coupon}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "coupon", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "coupon", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [coupon] - ) + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/coupons", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -215,11 +206,19 @@ defmodule Stripe.Coupon do ( nil - @doc "

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/coupons/{coupon}`\n" + @doc "

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/coupons/{coupon}`\n" ( - @spec delete(coupon :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedCoupon.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(coupon, opts \\ []) do + @spec update( + coupon :: binary(), + params :: %{ + optional(:currency_options) => map(), + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:name) => binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Coupon.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(coupon, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/coupons/{coupon}", @@ -243,9 +242,10 @@ defmodule Stripe.Coupon do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/credit_note.ex b/lib/generated/credit_note.ex index 339591df..5ba6584a 100644 --- a/lib/generated/credit_note.ex +++ b/lib/generated/credit_note.ex @@ -71,6 +71,16 @@ defmodule Stripe.CreditNote do } ) + ( + @typedoc nil + @type created :: %{ + optional(:gt) => integer, + optional(:gte) => integer, + optional(:lt) => integer, + optional(:lte) => integer + } + ) + ( @typedoc nil @type lines :: %{ @@ -87,7 +97,7 @@ defmodule Stripe.CreditNote do ) ( - @typedoc "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note." + @typedoc nil @type shipping_cost :: %{optional(:shipping_rate) => binary} ) @@ -103,34 +113,71 @@ defmodule Stripe.CreditNote do ( nil - @doc "

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces\nits amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result\nin any combination of the following:

\n\n\n\n

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

\n\n

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount\nor post_payment_credit_notes_amount depending on its status at the time of credit note creation.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/credit_notes`\n" + @doc "

Returns a list of credit notes.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes`\n" ( - @spec create( + @spec list( params :: %{ - optional(:amount) => integer, - optional(:credit_amount) => integer, - optional(:effective_at) => integer, + optional(:created) => created | integer, + optional(:customer) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:invoice) => binary, - optional(:lines) => list(lines), - optional(:memo) => binary, - optional(:metadata) => %{optional(binary) => binary}, - optional(:out_of_band_amount) => integer, - optional(:reason) => - :duplicate | :fraudulent | :order_change | :product_unsatisfactory, - optional(:refund) => binary, - optional(:refund_amount) => integer, - optional(:shipping_cost) => shipping_cost + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.CreditNote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.CreditNote.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/credit_notes", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves the credit note object with the given identifier.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes/{id}`\n" + ( + @spec retrieve( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: {:ok, Stripe.CreditNote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/credit_notes/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -146,6 +193,7 @@ defmodule Stripe.CreditNote do optional(:amount) => integer, optional(:credit_amount) => integer, optional(:effective_at) => integer, + optional(:email_type) => :credit_note | :none, optional(:expand) => list(binary), optional(:invoice) => binary, optional(:lines) => list(lines), @@ -175,34 +223,36 @@ defmodule Stripe.CreditNote do ( nil - @doc "

Retrieves the credit note object with the given identifier.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes/{id}`\n" + @doc "

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes/preview/lines`\n" ( - @spec retrieve( - id :: binary(), - params :: %{optional(:expand) => list(binary)}, + @spec preview_lines( + params :: %{ + optional(:amount) => integer, + optional(:credit_amount) => integer, + optional(:effective_at) => integer, + optional(:email_type) => :credit_note | :none, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:invoice) => binary, + optional(:limit) => integer, + optional(:lines) => list(lines), + optional(:memo) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:out_of_band_amount) => integer, + optional(:reason) => + :duplicate | :fraudulent | :order_change | :product_unsatisfactory, + optional(:refund) => binary, + optional(:refund_amount) => integer, + optional(:shipping_cost) => shipping_cost, + optional(:starting_after) => binary + }, opts :: Keyword.t() - ) :: {:ok, Stripe.CreditNote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(id, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/credit_notes/{id}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "id", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "id", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [id] - ) + ) :: + {:ok, Stripe.List.t(Stripe.CreditNoteLineItem.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def preview_lines(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/credit_notes/preview/lines", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -216,29 +266,35 @@ defmodule Stripe.CreditNote do ( nil - @doc "

Returns a list of credit notes.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes`\n" + @doc "

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces\nits amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result\nin any combination of the following:

\n\n\n\n

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

\n\n

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount\nor post_payment_credit_notes_amount depending on its status at the time of credit note creation.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/credit_notes`\n" ( - @spec list( + @spec create( params :: %{ - optional(:customer) => binary, - optional(:ending_before) => binary, + optional(:amount) => integer, + optional(:credit_amount) => integer, + optional(:effective_at) => integer, + optional(:email_type) => :credit_note | :none, optional(:expand) => list(binary), optional(:invoice) => binary, - optional(:limit) => integer, - optional(:starting_after) => binary + optional(:lines) => list(lines), + optional(:memo) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:out_of_band_amount) => integer, + optional(:reason) => + :duplicate | :fraudulent | :order_change | :product_unsatisfactory, + optional(:refund) => binary, + optional(:refund_amount) => integer, + optional(:shipping_cost) => shipping_cost }, opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.CreditNote.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do + ) :: {:ok, Stripe.CreditNote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/credit_notes", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -329,46 +385,4 @@ defmodule Stripe.CreditNote do end ) ) - - ( - nil - - @doc "

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes/preview/lines`\n" - ( - @spec preview_lines( - params :: %{ - optional(:amount) => integer, - optional(:credit_amount) => integer, - optional(:effective_at) => integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:invoice) => binary, - optional(:limit) => integer, - optional(:lines) => list(lines), - optional(:memo) => binary, - optional(:metadata) => %{optional(binary) => binary}, - optional(:out_of_band_amount) => integer, - optional(:reason) => - :duplicate | :fraudulent | :order_change | :product_unsatisfactory, - optional(:refund) => binary, - optional(:refund_amount) => integer, - optional(:shipping_cost) => shipping_cost, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.CreditNoteLineItem.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def preview_lines(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/credit_notes/preview/lines", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/credit_note_line_item.ex b/lib/generated/credit_note_line_item.ex index 616af9f6..60c35037 100644 --- a/lib/generated/credit_note_line_item.ex +++ b/lib/generated/credit_note_line_item.ex @@ -45,7 +45,7 @@ defmodule Stripe.CreditNoteLineItem do ( nil - @doc "

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes/{credit_note}/lines`\n" + @doc "

When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/credit_notes/{credit_note}/lines`\n" ( @spec list( credit_note :: binary(), @@ -90,4 +90,4 @@ defmodule Stripe.CreditNoteLineItem do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/customer.ex b/lib/generated/customer.ex index 7fe661f0..4b2ae9bd 100644 --- a/lib/generated/customer.ex +++ b/lib/generated/customer.ex @@ -34,7 +34,7 @@ defmodule Stripe.Customer do :test_clock ] - @typedoc "The `customer` type.\n\n * `address` The customer's address.\n * `balance` The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.\n * `cash_balance` The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.\n * `default_source` ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.\n * `delinquent` Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `discount` Describes the current discount active on the customer, if there is one.\n * `email` The customer's email address.\n * `id` Unique identifier for the object.\n * `invoice_credit_balance` The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.\n * `invoice_prefix` The prefix for the customer used to generate unique invoice numbers.\n * `invoice_settings` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` The customer's full name or business name.\n * `next_invoice_sequence` The suffix of the customer's next invoice number (for example, 0001).\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `phone` The customer's phone number.\n * `preferred_locales` The customer's preferred locales (languages), ordered by preference.\n * `shipping` Mailing and shipping address for the customer. Appears on invoices emailed to this customer.\n * `sources` The customer's payment sources, if any.\n * `subscriptions` The customer's current subscriptions, if any.\n * `tax` \n * `tax_exempt` Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**.\n * `tax_ids` The customer's tax IDs.\n * `test_clock` ID of the test clock that this customer belongs to.\n" + @typedoc "The `customer` type.\n\n * `address` The customer's address.\n * `balance` The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.\n * `cash_balance` The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.\n * `default_source` ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.\n * `delinquent` Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `discount` Describes the current discount active on the customer, if there is one.\n * `email` The customer's email address.\n * `id` Unique identifier for the object.\n * `invoice_credit_balance` The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.\n * `invoice_prefix` The prefix for the customer used to generate unique invoice numbers.\n * `invoice_settings` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` The customer's full name or business name.\n * `next_invoice_sequence` The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `phone` The customer's phone number.\n * `preferred_locales` The customer's preferred locales (languages), ordered by preference.\n * `shipping` Mailing and shipping address for the customer. Appears on invoices emailed to this customer.\n * `sources` The customer's payment sources, if any.\n * `subscriptions` The customer's current subscriptions, if any.\n * `tax` \n * `tax_exempt` Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**.\n * `tax_ids` The customer's tax IDs.\n * `test_clock` ID of the test clock that this customer belongs to.\n" @type t :: %__MODULE__{ address: term | nil, balance: integer, @@ -131,7 +131,8 @@ defmodule Stripe.Customer do ( @typedoc nil @type rendering_options :: %{ - optional(:amount_tax_display) => :exclude_tax | :include_inclusive_tax + optional(:amount_tax_display) => :exclude_tax | :include_inclusive_tax, + optional(:template) => binary } ) @@ -169,6 +170,7 @@ defmodule Stripe.Customer do | :au_abn | :au_arn | :bg_uic + | :bh_vat | :bo_tin | :br_cnpj | :br_cpf @@ -178,11 +180,13 @@ defmodule Stripe.Customer do | :ca_pst_mb | :ca_pst_sk | :ca_qst + | :ch_uid | :ch_vat | :cl_tin | :cn_tin | :co_nit | :cr_tin + | :de_stn | :do_rcn | :ec_ruc | :eg_tin @@ -192,6 +196,7 @@ defmodule Stripe.Customer do | :gb_vat | :ge_vat | :hk_br + | :hr_oib | :hu_tin | :id_npwp | :il_vat @@ -202,13 +207,17 @@ defmodule Stripe.Customer do | :jp_trn | :ke_pin | :kr_brn + | :kz_bin | :li_uid | :mx_rfc | :my_frp | :my_itn | :my_sst + | :ng_tin | :no_vat + | :no_voec | :nz_gst + | :om_vat | :pe_ruc | :ph_tin | :ro_tin @@ -236,27 +245,37 @@ defmodule Stripe.Customer do ( nil - @doc "

Search for customers you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/search`\n" + @doc "

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}`\n" ( - @spec search( - params :: %{ - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:page) => binary, - optional(:query) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.SearchResult.t(Stripe.Customer.t())} + @spec delete(customer :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedCustomer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def search(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/customers/search", [], []) + def delete(customer, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/customers/{customer}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "customer", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "customer", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [customer] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -265,30 +284,37 @@ defmodule Stripe.Customer do ( nil - @doc "

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers`\n" + @doc "

Removes the currently applied discount on a customer.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}/discount`\n" ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:email) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:test_clock) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Customer.t())} + @spec delete_discount(customer :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedDiscount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/customers", [], []) + def delete_discount(customer, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/customers/{customer}/discount", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "customer", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "customer", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [customer] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -297,43 +323,30 @@ defmodule Stripe.Customer do ( nil - @doc "

Creates a new customer object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers`\n" + @doc "

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers`\n" ( - @spec create( + @spec list( params :: %{ - optional(:address) => address | binary, - optional(:balance) => integer, - optional(:cash_balance) => cash_balance, - optional(:coupon) => binary, - optional(:description) => binary, + optional(:created) => created | integer, optional(:email) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:invoice_prefix) => binary, - optional(:invoice_settings) => invoice_settings, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:name) => binary, - optional(:next_invoice_sequence) => integer, - optional(:payment_method) => binary, - optional(:phone) => binary, - optional(:preferred_locales) => list(binary), - optional(:promotion_code) => binary, - optional(:shipping) => shipping | binary, - optional(:source) => binary, - optional(:tax) => tax, - optional(:tax_exempt) => :exempt | :none | :reverse, - optional(:tax_id_data) => list(tax_id_data), - optional(:test_clock) => binary, - optional(:validate) => boolean + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:test_clock) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Customer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Customer.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/customers", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -386,79 +399,25 @@ defmodule Stripe.Customer do ( nil - @doc "

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

\n\n

This request accepts mostly the same arguments as the customer creation call.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers/{customer}`\n" + @doc "

Returns a list of transactions that updated the customer’s balances.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/balance_transactions`\n" ( - @spec update( + @spec balance_transactions( customer :: binary(), params :: %{ - optional(:address) => address | binary, - optional(:balance) => integer, - optional(:cash_balance) => cash_balance, - optional(:coupon) => binary, - optional(:default_source) => binary, - optional(:description) => binary, - optional(:email) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:invoice_prefix) => binary, - optional(:invoice_settings) => invoice_settings, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:name) => binary, - optional(:next_invoice_sequence) => integer, - optional(:phone) => binary, - optional(:preferred_locales) => list(binary), - optional(:promotion_code) => binary, - optional(:shipping) => shipping | binary, - optional(:source) => binary, - optional(:tax) => tax, - optional(:tax_exempt) => :exempt | :none | :reverse, - optional(:validate) => boolean + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Customer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(customer, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "customer", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "customer", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [customer] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}`\n" - ( - @spec delete(customer :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedCustomer.t()} + ) :: + {:ok, Stripe.List.t(Stripe.CustomerBalanceTransaction.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(customer, opts \\ []) do + def balance_transactions(customer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}", + "/v1/customers/{customer}/balance_transactions", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -479,7 +438,8 @@ defmodule Stripe.Customer do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -493,6 +453,7 @@ defmodule Stripe.Customer do @spec list_payment_methods( customer :: binary(), params :: %{ + optional(:allow_redisplay) => :always | :limited | :unspecified, optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:limit) => integer, @@ -502,6 +463,7 @@ defmodule Stripe.Customer do | :affirm | :afterpay_clearpay | :alipay + | :amazon_pay | :au_becs_debit | :bacs_debit | :bancontact @@ -518,6 +480,8 @@ defmodule Stripe.Customer do | :klarna | :konbini | :link + | :mobilepay + | :multibanco | :oxxo | :p24 | :paynow @@ -527,6 +491,8 @@ defmodule Stripe.Customer do | :revolut_pay | :sepa_debit | :sofort + | :swish + | :twint | :us_bank_account | :wechat_pay | :zip @@ -626,42 +592,22 @@ defmodule Stripe.Customer do ( nil - @doc "

Returns a list of transactions that updated the customer’s balances.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/balance_transactions`\n" + @doc "

Search for customers you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/search`\n" ( - @spec balance_transactions( - customer :: binary(), + @spec search( params :: %{ - optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:limit) => integer, - optional(:starting_after) => binary + optional(:page) => binary, + optional(:query) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.CustomerBalanceTransaction.t())} + {:ok, Stripe.SearchResult.t(Stripe.Customer.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def balance_transactions(customer, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/balance_transactions", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "customer", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "customer", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [customer] - ) + def search(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/customers/search", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -675,25 +621,84 @@ defmodule Stripe.Customer do ( nil - @doc "

Create an incoming testmode bank transfer

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/customers/{customer}/fund_cash_balance`\n" + @doc "

Creates a new customer object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers`\n" ( - @spec fund_cash_balance( + @spec create( + params :: %{ + optional(:address) => address | binary, + optional(:balance) => integer, + optional(:cash_balance) => cash_balance, + optional(:coupon) => binary, + optional(:description) => binary, + optional(:email) => binary, + optional(:expand) => list(binary), + optional(:invoice_prefix) => binary, + optional(:invoice_settings) => invoice_settings, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:name) => binary, + optional(:next_invoice_sequence) => integer, + optional(:payment_method) => binary, + optional(:phone) => binary, + optional(:preferred_locales) => list(binary), + optional(:promotion_code) => binary, + optional(:shipping) => shipping | binary, + optional(:source) => binary, + optional(:tax) => tax, + optional(:tax_exempt) => :exempt | :none | :reverse, + optional(:tax_id_data) => list(tax_id_data), + optional(:test_clock) => binary, + optional(:validate) => boolean + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Customer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/customers", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

\n\n

This request accepts mostly the same arguments as the customer creation call.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers/{customer}`\n" + ( + @spec update( customer :: binary(), params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, + optional(:address) => address | binary, + optional(:balance) => integer, + optional(:cash_balance) => cash_balance, + optional(:coupon) => binary, + optional(:default_source) => binary, + optional(:description) => binary, + optional(:email) => binary, optional(:expand) => list(binary), - optional(:reference) => binary + optional(:invoice_prefix) => binary, + optional(:invoice_settings) => invoice_settings, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:name) => binary, + optional(:next_invoice_sequence) => integer, + optional(:phone) => binary, + optional(:preferred_locales) => list(binary), + optional(:promotion_code) => binary, + optional(:shipping) => shipping | binary, + optional(:source) => binary, + optional(:tax) => tax, + optional(:tax_exempt) => :exempt | :none | :reverse, + optional(:validate) => boolean }, opts :: Keyword.t() - ) :: - {:ok, Stripe.CustomerCashBalanceTransaction.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def fund_cash_balance(customer, params \\ %{}, opts \\ []) do + ) :: {:ok, Stripe.Customer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(customer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/customers/{customer}/fund_cash_balance", + "/v1/customers/{customer}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -773,16 +778,25 @@ defmodule Stripe.Customer do ( nil - @doc "

Removes the currently applied discount on a customer.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}/discount`\n" + @doc "

Create an incoming testmode bank transfer

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/customers/{customer}/fund_cash_balance`\n" ( - @spec delete_discount(customer :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedDiscount.t()} + @spec fund_cash_balance( + customer :: binary(), + params :: %{ + optional(:amount) => integer, + optional(:currency) => binary, + optional(:expand) => list(binary), + optional(:reference) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.CustomerCashBalanceTransaction.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete_discount(customer, opts \\ []) do + def fund_cash_balance(customer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/discount", + "/v1/test_helpers/customers/{customer}/fund_cash_balance", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -803,9 +817,10 @@ defmodule Stripe.Customer do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/customer_balance_transaction.ex b/lib/generated/customer_balance_transaction.ex index cb03695d..c1478df6 100644 --- a/lib/generated/customer_balance_transaction.ex +++ b/lib/generated/customer_balance_transaction.ex @@ -40,21 +40,25 @@ defmodule Stripe.CustomerBalanceTransaction do ( nil - @doc "

Retrieves a specific customer balance transaction that updated the customer’s balances.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/balance_transactions/{transaction}`\n" + @doc "

Returns a list of transactions that updated the customer’s balances.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/balance_transactions`\n" ( - @spec retrieve( + @spec list( customer :: binary(), - transaction :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, opts :: Keyword.t() ) :: - {:ok, Stripe.CustomerBalanceTransaction.t()} + {:ok, Stripe.List.t(Stripe.CustomerBalanceTransaction.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(customer, transaction, params \\ %{}, opts \\ []) do + def list(customer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/balance_transactions/{transaction}", + "/v1/customers/{customer}/balance_transactions", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -68,22 +72,9 @@ defmodule Stripe.CustomerBalanceTransaction do properties: [], any_of: [] } - }, - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "transaction", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "transaction", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } } ], - [customer, transaction] + [customer] ) Stripe.Request.new_request(opts) @@ -98,25 +89,21 @@ defmodule Stripe.CustomerBalanceTransaction do ( nil - @doc "

Returns a list of transactions that updated the customer’s balances.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/balance_transactions`\n" + @doc "

Retrieves a specific customer balance transaction that updated the customer’s balances.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/balance_transactions/{transaction}`\n" ( - @spec list( + @spec retrieve( customer :: binary(), - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, + transaction :: binary(), + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.CustomerBalanceTransaction.t())} + {:ok, Stripe.CustomerBalanceTransaction.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(customer, params \\ %{}, opts \\ []) do + def retrieve(customer, transaction, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/balance_transactions", + "/v1/customers/{customer}/balance_transactions/{transaction}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -130,9 +117,22 @@ defmodule Stripe.CustomerBalanceTransaction do properties: [], any_of: [] } + }, + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "transaction", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "transaction", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } } ], - [customer] + [customer, transaction] ) Stripe.Request.new_request(opts) @@ -255,4 +255,4 @@ defmodule Stripe.CustomerBalanceTransaction do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/customer_cash_balance_transaction.ex b/lib/generated/customer_cash_balance_transaction.ex index ca80b6e6..a1e04d14 100644 --- a/lib/generated/customer_cash_balance_transaction.ex +++ b/lib/generated/customer_cash_balance_transaction.ex @@ -44,21 +44,25 @@ defmodule Stripe.CustomerCashBalanceTransaction do ( nil - @doc "

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/cash_balance_transactions/{transaction}`\n" + @doc "

Returns a list of transactions that modified the customer’s cash balance.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/cash_balance_transactions`\n" ( - @spec retrieve( + @spec list( customer :: binary(), - transaction :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, opts :: Keyword.t() ) :: - {:ok, Stripe.CustomerCashBalanceTransaction.t()} + {:ok, Stripe.List.t(Stripe.CustomerCashBalanceTransaction.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(customer, transaction, params \\ %{}, opts \\ []) do + def list(customer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/cash_balance_transactions/{transaction}", + "/v1/customers/{customer}/cash_balance_transactions", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -72,22 +76,9 @@ defmodule Stripe.CustomerCashBalanceTransaction do properties: [], any_of: [] } - }, - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "transaction", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "transaction", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } } ], - [customer, transaction] + [customer] ) Stripe.Request.new_request(opts) @@ -102,25 +93,21 @@ defmodule Stripe.CustomerCashBalanceTransaction do ( nil - @doc "

Returns a list of transactions that modified the customer’s cash balance.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/cash_balance_transactions`\n" + @doc "

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/cash_balance_transactions/{transaction}`\n" ( - @spec list( + @spec retrieve( customer :: binary(), - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, + transaction :: binary(), + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.CustomerCashBalanceTransaction.t())} + {:ok, Stripe.CustomerCashBalanceTransaction.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(customer, params \\ %{}, opts \\ []) do + def retrieve(customer, transaction, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/cash_balance_transactions", + "/v1/customers/{customer}/cash_balance_transactions/{transaction}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -134,9 +121,22 @@ defmodule Stripe.CustomerCashBalanceTransaction do properties: [], any_of: [] } + }, + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "transaction", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "transaction", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } } ], - [customer] + [customer, transaction] ) Stripe.Request.new_request(opts) @@ -147,4 +147,4 @@ defmodule Stripe.CustomerCashBalanceTransaction do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/customer_session.ex b/lib/generated/customer_session.ex index b1f5f04e..bc72f1d2 100644 --- a/lib/generated/customer_session.ex +++ b/lib/generated/customer_session.ex @@ -1,11 +1,11 @@ defmodule Stripe.CustomerSession do use Stripe.Entity - @moduledoc "A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs)\ncontrol over a customer." + @moduledoc "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer)." ( defstruct [:client_secret, :components, :created, :customer, :expires_at, :livemode, :object] - @typedoc "The `customer_session` type.\n\n * `client_secret` The client secret of this customer session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.\n * `components` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` The customer the customer session was created for.\n * `expires_at` The timestamp at which this customer session will expire.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" + @typedoc "The `customer_session` type.\n\n * `client_secret` The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.\n * `components` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` The Customer the Customer Session was created for.\n * `expires_at` The timestamp at which this Customer Session will expire.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{ client_secret: binary, components: term, @@ -23,13 +23,32 @@ defmodule Stripe.CustomerSession do ) ( - @typedoc "Configuration for each component. 1 component must be enabled." + @typedoc "Configuration for each component. Exactly 1 component must be enabled." @type components :: %{ optional(:buy_button) => buy_button, + optional(:payment_element) => payment_element, optional(:pricing_table) => pricing_table } ) + ( + @typedoc "This hash defines whether the Payment Element supports certain features." + @type features :: %{ + optional(:payment_method_allow_redisplay_filters) => + list(:always | :limited | :unspecified), + optional(:payment_method_redisplay) => :disabled | :enabled, + optional(:payment_method_redisplay_limit) => integer, + optional(:payment_method_remove) => :disabled | :enabled, + optional(:payment_method_save) => :disabled | :enabled, + optional(:payment_method_save_usage) => :off_session | :on_session + } + ) + + ( + @typedoc "Configuration for the Payment Element." + @type payment_element :: %{optional(:enabled) => boolean, optional(:features) => features} + ) + ( @typedoc "Configuration for the pricing table." @type pricing_table :: %{optional(:enabled) => boolean} @@ -38,7 +57,7 @@ defmodule Stripe.CustomerSession do ( nil - @doc "

Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customer_sessions`\n" + @doc "

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customer_sessions`\n" ( @spec create( params :: %{ @@ -62,4 +81,4 @@ defmodule Stripe.CustomerSession do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_account.ex b/lib/generated/deleted_account.ex index 78ae781c..3095b26f 100644 --- a/lib/generated/deleted_account.ex +++ b/lib/generated/deleted_account.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedAccount do @typedoc "The `deleted_account` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_apple_pay_domain.ex b/lib/generated/deleted_apple_pay_domain.ex index 07f3ba5d..a2334ed6 100644 --- a/lib/generated/deleted_apple_pay_domain.ex +++ b/lib/generated/deleted_apple_pay_domain.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedApplePayDomain do @typedoc "The `deleted_apple_pay_domain` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_coupon.ex b/lib/generated/deleted_coupon.ex index 59df8879..c454e5ac 100644 --- a/lib/generated/deleted_coupon.ex +++ b/lib/generated/deleted_coupon.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedCoupon do @typedoc "The `deleted_coupon` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_customer.ex b/lib/generated/deleted_customer.ex index 20a62803..387393db 100644 --- a/lib/generated/deleted_customer.ex +++ b/lib/generated/deleted_customer.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedCustomer do @typedoc "The `deleted_customer` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_discount.ex b/lib/generated/deleted_discount.ex index a02b0577..521e5b7c 100644 --- a/lib/generated/deleted_discount.ex +++ b/lib/generated/deleted_discount.ex @@ -13,10 +13,11 @@ defmodule Stripe.DeletedDiscount do :object, :promotion_code, :start, - :subscription + :subscription, + :subscription_item ] - @typedoc "The `deleted_discount` type.\n\n * `checkout_session` The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.\n * `coupon` \n * `customer` The ID of the customer associated with this discount.\n * `deleted` Always true for a deleted object\n * `id` The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.\n * `invoice` The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.\n * `invoice_item` The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `promotion_code` The promotion code applied to create this discount.\n * `start` Date that the coupon was applied.\n * `subscription` The subscription that this coupon is applied to, if it is applied to a particular subscription.\n" + @typedoc "The `deleted_discount` type.\n\n * `checkout_session` The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.\n * `coupon` \n * `customer` The ID of the customer associated with this discount.\n * `deleted` Always true for a deleted object\n * `id` The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.\n * `invoice` The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.\n * `invoice_item` The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `promotion_code` The promotion code applied to create this discount.\n * `start` Date that the coupon was applied.\n * `subscription` The subscription that this coupon is applied to, if it is applied to a particular subscription.\n * `subscription_item` The subscription item that this coupon is applied to, if it is applied to a particular subscription item.\n" @type t :: %__MODULE__{ checkout_session: binary | nil, coupon: Stripe.Coupon.t(), @@ -28,7 +29,8 @@ defmodule Stripe.DeletedDiscount do object: binary, promotion_code: (binary | Stripe.PromotionCode.t()) | nil, start: integer, - subscription: binary | nil + subscription: binary | nil, + subscription_item: binary | nil } ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_external_account.ex b/lib/generated/deleted_external_account.ex index e5f43996..f49d78d2 100644 --- a/lib/generated/deleted_external_account.ex +++ b/lib/generated/deleted_external_account.ex @@ -6,4 +6,4 @@ defmodule Stripe.DeletedExternalAccount do @typedoc "The `deleted_external_account` type.\n\n\n" @type t :: %__MODULE__{} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_invoice.ex b/lib/generated/deleted_invoice.ex index 7c34f1eb..4eeefcd3 100644 --- a/lib/generated/deleted_invoice.ex +++ b/lib/generated/deleted_invoice.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedInvoice do @typedoc "The `deleted_invoice` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_invoiceitem.ex b/lib/generated/deleted_invoiceitem.ex index a2551dd3..56eddc45 100644 --- a/lib/generated/deleted_invoiceitem.ex +++ b/lib/generated/deleted_invoiceitem.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedInvoiceitem do @typedoc "The `deleted_invoiceitem` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_payment_source.ex b/lib/generated/deleted_payment_source.ex index 9630ba9c..e04d175d 100644 --- a/lib/generated/deleted_payment_source.ex +++ b/lib/generated/deleted_payment_source.ex @@ -6,4 +6,4 @@ defmodule Stripe.DeletedPaymentSource do @typedoc "The `deleted_payment_source` type.\n\n\n" @type t :: %__MODULE__{} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_person.ex b/lib/generated/deleted_person.ex index 94362bab..25cebefb 100644 --- a/lib/generated/deleted_person.ex +++ b/lib/generated/deleted_person.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedPerson do @typedoc "The `deleted_person` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_plan.ex b/lib/generated/deleted_plan.ex index c01ce5df..d8560d61 100644 --- a/lib/generated/deleted_plan.ex +++ b/lib/generated/deleted_plan.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedPlan do @typedoc "The `deleted_plan` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_product.ex b/lib/generated/deleted_product.ex index 7ae7fc10..673533b6 100644 --- a/lib/generated/deleted_product.ex +++ b/lib/generated/deleted_product.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedProduct do @typedoc "The `deleted_product` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_product_feature.ex b/lib/generated/deleted_product_feature.ex new file mode 100644 index 00000000..5dd22c6a --- /dev/null +++ b/lib/generated/deleted_product_feature.ex @@ -0,0 +1,10 @@ +defmodule Stripe.DeletedProductFeature do + use Stripe.Entity + @moduledoc "" + ( + defstruct [:deleted, :id, :object] + + @typedoc "The `deleted_product_feature` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" + @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} + ) +end \ No newline at end of file diff --git a/lib/generated/deleted_radar__value_list.ex b/lib/generated/deleted_radar__value_list.ex index 027f3479..b457d48d 100644 --- a/lib/generated/deleted_radar__value_list.ex +++ b/lib/generated/deleted_radar__value_list.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedRadar.ValueList do @typedoc "The `deleted_radar.value_list` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_radar__value_list_item.ex b/lib/generated/deleted_radar__value_list_item.ex index 1c00cc5b..69b1e2b4 100644 --- a/lib/generated/deleted_radar__value_list_item.ex +++ b/lib/generated/deleted_radar__value_list_item.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedRadar.ValueListItem do @typedoc "The `deleted_radar.value_list_item` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_subscription_item.ex b/lib/generated/deleted_subscription_item.ex index 1ade2b76..1dacff7e 100644 --- a/lib/generated/deleted_subscription_item.ex +++ b/lib/generated/deleted_subscription_item.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedSubscriptionItem do @typedoc "The `deleted_subscription_item` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_tax_id.ex b/lib/generated/deleted_tax_id.ex index b3769d47..2afc7bb7 100644 --- a/lib/generated/deleted_tax_id.ex +++ b/lib/generated/deleted_tax_id.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedTaxId do @typedoc "The `deleted_tax_id` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_terminal__configuration.ex b/lib/generated/deleted_terminal__configuration.ex index ba7b763f..f2266c3e 100644 --- a/lib/generated/deleted_terminal__configuration.ex +++ b/lib/generated/deleted_terminal__configuration.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedTerminal.Configuration do @typedoc "The `deleted_terminal.configuration` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_terminal__location.ex b/lib/generated/deleted_terminal__location.ex index 22139a54..895658fa 100644 --- a/lib/generated/deleted_terminal__location.ex +++ b/lib/generated/deleted_terminal__location.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedTerminal.Location do @typedoc "The `deleted_terminal.location` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_terminal__reader.ex b/lib/generated/deleted_terminal__reader.ex index 388dbc28..139c390c 100644 --- a/lib/generated/deleted_terminal__reader.ex +++ b/lib/generated/deleted_terminal__reader.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedTerminal.Reader do @typedoc "The `deleted_terminal.reader` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_test_helpers__test_clock.ex b/lib/generated/deleted_test_helpers__test_clock.ex index 0dc39a10..f40dd012 100644 --- a/lib/generated/deleted_test_helpers__test_clock.ex +++ b/lib/generated/deleted_test_helpers__test_clock.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedTestHelpers.TestClock do @typedoc "The `deleted_test_helpers.test_clock` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/deleted_webhook_endpoint.ex b/lib/generated/deleted_webhook_endpoint.ex index 91f518ed..2cf79e01 100644 --- a/lib/generated/deleted_webhook_endpoint.ex +++ b/lib/generated/deleted_webhook_endpoint.ex @@ -7,4 +7,4 @@ defmodule Stripe.DeletedWebhookEndpoint do @typedoc "The `deleted_webhook_endpoint` type.\n\n * `deleted` Always true for a deleted object\n * `id` Unique identifier for the object.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" @type t :: %__MODULE__{deleted: boolean, id: binary, object: binary} ) -end +end \ No newline at end of file diff --git a/lib/generated/dispute.ex b/lib/generated/dispute.ex index 64967fd9..48609793 100644 --- a/lib/generated/dispute.ex +++ b/lib/generated/dispute.ex @@ -247,4 +247,4 @@ defmodule Stripe.Dispute do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/entitlements__active_entitlement.ex b/lib/generated/entitlements__active_entitlement.ex new file mode 100644 index 00000000..7cf4d888 --- /dev/null +++ b/lib/generated/entitlements__active_entitlement.ex @@ -0,0 +1,91 @@ +defmodule Stripe.Entitlements.ActiveEntitlement do + use Stripe.Entity + @moduledoc "An active entitlement describes access to a feature for a customer." + ( + defstruct [:feature, :id, :livemode, :lookup_key, :object] + + @typedoc "The `entitlements.active_entitlement` type.\n\n * `feature` The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `lookup_key` A unique key you provide as your own system identifier. This may be up to 80 characters.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" + @type t :: %__MODULE__{ + feature: binary | Stripe.Entitlements.Feature.t(), + id: binary, + livemode: boolean, + lookup_key: binary, + object: binary + } + ) + + ( + nil + + @doc "

Retrieve a list of active entitlements for a customer

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/entitlements/active_entitlements`\n" + ( + @spec list( + params :: %{ + optional(:customer) => binary, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Entitlements.ActiveEntitlement.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params("/v1/entitlements/active_entitlements", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieve an active entitlement

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/entitlements/active_entitlements/{id}`\n" + ( + @spec retrieve( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Entitlements.ActiveEntitlement.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def retrieve(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/entitlements/active_entitlements/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/entitlements__feature.ex b/lib/generated/entitlements__feature.ex new file mode 100644 index 00000000..1f6bb7ee --- /dev/null +++ b/lib/generated/entitlements__feature.ex @@ -0,0 +1,172 @@ +defmodule Stripe.Entitlements.Feature do + use Stripe.Entity + + @moduledoc "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer." + ( + defstruct [:active, :id, :livemode, :lookup_key, :metadata, :name, :object] + + @typedoc "The `entitlements.feature` type.\n\n * `active` Inactive features cannot be attached to new products and will not be returned from the features list endpoint.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `lookup_key` A unique key you provide as your own system identifier. This may be up to 80 characters.\n * `metadata` Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` The feature's name, for your own purpose, not meant to be displayable to the customer.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" + @type t :: %__MODULE__{ + active: boolean, + id: binary, + livemode: boolean, + lookup_key: binary, + metadata: term, + name: binary, + object: binary + } + ) + + ( + nil + + @doc "

Retrieve a list of features

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/entitlements/features`\n" + ( + @spec list( + params :: %{ + optional(:archived) => boolean, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:lookup_key) => binary, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Entitlements.Feature.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/entitlements/features", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves a feature

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/entitlements/features/{id}`\n" + ( + @spec retrieve( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Entitlements.Feature.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def retrieve(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/entitlements/features/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a feature

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/entitlements/features`\n" + ( + @spec create( + params :: %{ + optional(:expand) => list(binary), + optional(:lookup_key) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:name) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Entitlements.Feature.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/entitlements/features", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Update a feature’s metadata or permanently deactivate it.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/entitlements/features/{id}`\n" + ( + @spec update( + id :: binary(), + params :: %{ + optional(:active) => boolean, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:name) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Entitlements.Feature.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def update(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/entitlements/features/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/ephemeral_key.ex b/lib/generated/ephemeral_key.ex index 5218a8b8..8df69d3b 100644 --- a/lib/generated/ephemeral_key.ex +++ b/lib/generated/ephemeral_key.ex @@ -15,34 +15,6 @@ defmodule Stripe.EphemeralKey do } ) - ( - nil - - @doc "

Creates a short-lived API key for a given resource.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/ephemeral_keys`\n" - ( - @spec create( - params :: %{ - optional(:customer) => binary, - optional(:expand) => list(binary), - optional(:issuing_card) => binary, - optional(:nonce) => binary, - optional(:verification_session) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.EphemeralKey.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/ephemeral_keys", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -84,4 +56,32 @@ defmodule Stripe.EphemeralKey do end ) ) -end + + ( + nil + + @doc "

Creates a short-lived API key for a given resource.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/ephemeral_keys`\n" + ( + @spec create( + params :: %{ + optional(:customer) => binary, + optional(:expand) => list(binary), + optional(:issuing_card) => binary, + optional(:nonce) => binary, + optional(:verification_session) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.EphemeralKey.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/ephemeral_keys", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/event.ex b/lib/generated/event.ex index 0dfcb0c4..38f107f9 100644 --- a/lib/generated/event.ex +++ b/lib/generated/event.ex @@ -1,7 +1,7 @@ defmodule Stripe.Event do use Stripe.Entity - @moduledoc "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://stripe.com/docs/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days." + @moduledoc "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://docs.stripe.com/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://docs.stripe.com/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days." ( defstruct [ :account, @@ -44,7 +44,7 @@ defmodule Stripe.Event do ( nil - @doc "

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/events`\n" + @doc "

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/events`\n" ( @spec list( params :: %{ @@ -77,7 +77,7 @@ defmodule Stripe.Event do ( nil - @doc "

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/events/{id}`\n" + @doc "

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/events/{id}`\n" ( @spec retrieve( id :: binary(), @@ -114,4 +114,4 @@ defmodule Stripe.Event do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/exchange_rate.ex b/lib/generated/exchange_rate.ex index 9b2529ce..11db8e1d 100644 --- a/lib/generated/exchange_rate.ex +++ b/lib/generated/exchange_rate.ex @@ -79,4 +79,4 @@ defmodule Stripe.ExchangeRate do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/external_account.ex b/lib/generated/external_account.ex index b5bab04e..2712ffa7 100644 --- a/lib/generated/external_account.ex +++ b/lib/generated/external_account.ex @@ -8,7 +8,7 @@ defmodule Stripe.ExternalAccount do ) ( - @typedoc "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a voided check." + @typedoc "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check." @type bank_account_ownership_verification :: %{optional(:files) => list(binary)} ) @@ -19,6 +19,58 @@ defmodule Stripe.ExternalAccount do } ) + ( + nil + + @doc "

Delete a specified external account for a given account.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" + ( + @spec delete(account :: binary(), id :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedExternalAccount.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def delete(account, id, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/accounts/{account}/external_accounts/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "account", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "account", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + }, + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [account, id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -179,7 +231,7 @@ defmodule Stripe.ExternalAccount do ( nil - @doc "

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" + @doc "

Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.

\n\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" ( @spec update( account :: binary(), @@ -250,56 +302,4 @@ defmodule Stripe.ExternalAccount do end ) ) - - ( - nil - - @doc "

Delete a specified external account for a given account.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}/external_accounts/{id}`\n" - ( - @spec delete(account :: binary(), id :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedExternalAccount.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete(account, id, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/accounts/{account}/external_accounts/{id}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "account", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "account", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - }, - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "id", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "id", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [account, id] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/fee_refund.ex b/lib/generated/fee_refund.ex index 7f19fef6..c8397d9c 100644 --- a/lib/generated/fee_refund.ex +++ b/lib/generated/fee_refund.ex @@ -21,22 +21,32 @@ defmodule Stripe.FeeRefund do ( nil - @doc "

Refunds an application fee that has previously been collected but not yet refunded.\nFunds will be refunded to the Stripe account from which the fee was originally collected.

\n\n

You can optionally refund only part of an application fee.\nYou can do so multiple times, until the entire fee has been refunded.

\n\n

Once entirely refunded, an application fee can’t be refunded again.\nThis method will raise an error when called on an already-refunded application fee,\nor when trying to refund more money than is left on an application fee.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/application_fees/{id}/refunds`\n" + @doc "

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/application_fees/{fee}/refunds/{id}`\n" ( - @spec create( + @spec retrieve( + fee :: binary(), id :: binary(), - params :: %{ - optional(:amount) => integer, - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.FeeRefund.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(id, params \\ %{}, opts \\ []) do + def retrieve(fee, id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/application_fees/{id}/refunds", + "/v1/application_fees/{fee}/refunds/{id}", [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "fee", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "fee", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + }, %OpenApiGen.Blueprint.Parameter{ in: "path", name: "id", @@ -51,13 +61,13 @@ defmodule Stripe.FeeRefund do } } ], - [id] + [fee, id] ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -115,15 +125,18 @@ defmodule Stripe.FeeRefund do ( nil - @doc "

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/application_fees/{fee}/refunds/{id}`\n" + @doc "

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata as an argument.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/application_fees/{fee}/refunds/{id}`\n" ( - @spec retrieve( + @spec update( fee :: binary(), id :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary + }, opts :: Keyword.t() ) :: {:ok, Stripe.FeeRefund.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(fee, id, params \\ %{}, opts \\ []) do + def update(fee, id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/application_fees/{fee}/refunds/{id}", @@ -161,7 +174,7 @@ defmodule Stripe.FeeRefund do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -170,35 +183,22 @@ defmodule Stripe.FeeRefund do ( nil - @doc "

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n

This request only accepts metadata as an argument.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/application_fees/{fee}/refunds/{id}`\n" + @doc "

Refunds an application fee that has previously been collected but not yet refunded.\nFunds will be refunded to the Stripe account from which the fee was originally collected.

\n\n

You can optionally refund only part of an application fee.\nYou can do so multiple times, until the entire fee has been refunded.

\n\n

Once entirely refunded, an application fee can’t be refunded again.\nThis method will raise an error when called on an already-refunded application fee,\nor when trying to refund more money than is left on an application fee.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/application_fees/{id}/refunds`\n" ( - @spec update( - fee :: binary(), + @spec create( id :: binary(), params :: %{ + optional(:amount) => integer, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary + optional(:metadata) => %{optional(binary) => binary} }, opts :: Keyword.t() ) :: {:ok, Stripe.FeeRefund.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(fee, id, params \\ %{}, opts \\ []) do + def create(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/application_fees/{fee}/refunds/{id}", + "/v1/application_fees/{id}/refunds", [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "fee", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "fee", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - }, %OpenApiGen.Blueprint.Parameter{ in: "path", name: "id", @@ -213,7 +213,7 @@ defmodule Stripe.FeeRefund do } } ], - [fee, id] + [id] ) Stripe.Request.new_request(opts) @@ -224,4 +224,4 @@ defmodule Stripe.FeeRefund do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/file.ex b/lib/generated/file.ex index 4dcb8fcd..1e5c6cc5 100644 --- a/lib/generated/file.ex +++ b/lib/generated/file.ex @@ -65,6 +65,7 @@ defmodule Stripe.File do | :finance_report_run | :identity_document | :identity_document_downloadable + | :issuing_regulatory_reporting | :pci_document | :selfie | :sigma_scheduled_query @@ -146,4 +147,4 @@ defmodule Stripe.File do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/file_link.ex b/lib/generated/file_link.ex index 5ccc14f6..cc0e499f 100644 --- a/lib/generated/file_link.ex +++ b/lib/generated/file_link.ex @@ -29,6 +29,38 @@ defmodule Stripe.FileLink do } ) + ( + nil + + @doc "

Returns a list of file links.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/file_links`\n" + ( + @spec list( + params :: %{ + optional(:created) => created | integer, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:expired) => boolean, + optional(:file) => binary, + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.FileLink.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/file_links", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -140,36 +172,4 @@ defmodule Stripe.FileLink do end ) ) - - ( - nil - - @doc "

Returns a list of file links.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/file_links`\n" - ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:expired) => boolean, - optional(:file) => binary, - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.FileLink.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/file_links", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/financial_connections__account.ex b/lib/generated/financial_connections__account.ex index 54980761..b4445845 100644 --- a/lib/generated/financial_connections__account.ex +++ b/lib/generated/financial_connections__account.ex @@ -183,23 +183,20 @@ defmodule Stripe.FinancialConnections.Account do ( nil - @doc "

Refreshes the data associated with a Financial Connections Account.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/financial_connections/accounts/{account}/refresh`\n" + @doc "

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/financial_connections/accounts/{account}/disconnect`\n" ( - @spec refresh( + @spec disconnect( account :: binary(), - params :: %{ - optional(:expand) => list(binary), - optional(:features) => list(:balance | :ownership | :transactions) - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.FinancialConnections.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def refresh(account, params \\ %{}, opts \\ []) do + def disconnect(account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/financial_connections/accounts/{account}/refresh", + "/v1/financial_connections/accounts/{account}/disconnect", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -230,20 +227,23 @@ defmodule Stripe.FinancialConnections.Account do ( nil - @doc "

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/financial_connections/accounts/{account}/disconnect`\n" + @doc "

Refreshes the data associated with a Financial Connections Account.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/financial_connections/accounts/{account}/refresh`\n" ( - @spec disconnect( + @spec refresh( account :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:features) => list(:balance | :ownership | :transactions) + }, opts :: Keyword.t() ) :: {:ok, Stripe.FinancialConnections.Account.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def disconnect(account, params \\ %{}, opts \\ []) do + def refresh(account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/financial_connections/accounts/{account}/disconnect", + "/v1/financial_connections/accounts/{account}/refresh", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -364,4 +364,4 @@ defmodule Stripe.FinancialConnections.Account do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/financial_connections__account_owner.ex b/lib/generated/financial_connections__account_owner.ex index b8e6af05..334696c8 100644 --- a/lib/generated/financial_connections__account_owner.ex +++ b/lib/generated/financial_connections__account_owner.ex @@ -16,4 +16,4 @@ defmodule Stripe.FinancialConnections.AccountOwner do refreshed_at: integer | nil } ) -end +end \ No newline at end of file diff --git a/lib/generated/financial_connections__session.ex b/lib/generated/financial_connections__session.ex index 1647c8a4..02e39b8d 100644 --- a/lib/generated/financial_connections__session.ex +++ b/lib/generated/financial_connections__session.ex @@ -42,40 +42,11 @@ defmodule Stripe.FinancialConnections.Session do ( @typedoc "Filters to restrict the kinds of accounts to collect." - @type filters :: %{optional(:countries) => list(binary)} - ) - - ( - nil - - @doc "

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/financial_connections/sessions`\n" - ( - @spec create( - params :: %{ - optional(:account_holder) => account_holder, - optional(:expand) => list(binary), - optional(:filters) => filters, - optional(:permissions) => - list(:balances | :ownership | :payment_method | :transactions), - optional(:prefetch) => list(:balances | :ownership | :transactions), - optional(:return_url) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.FinancialConnections.Session.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params("/v1/financial_connections/sessions", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) + @type filters :: %{ + optional(:account_subcategories) => + list(:checking | :credit_card | :line_of_credit | :mortgage | :savings), + optional(:countries) => list(binary) + } ) ( @@ -121,4 +92,37 @@ defmodule Stripe.FinancialConnections.Session do end ) ) -end + + ( + nil + + @doc "

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/financial_connections/sessions`\n" + ( + @spec create( + params :: %{ + optional(:account_holder) => account_holder, + optional(:expand) => list(binary), + optional(:filters) => filters, + optional(:permissions) => + list(:balances | :ownership | :payment_method | :transactions), + optional(:prefetch) => list(:balances | :ownership | :transactions), + optional(:return_url) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.FinancialConnections.Session.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params("/v1/financial_connections/sessions", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/financial_connections__transaction.ex b/lib/generated/financial_connections__transaction.ex index 4949589f..bff88a0e 100644 --- a/lib/generated/financial_connections__transaction.ex +++ b/lib/generated/financial_connections__transaction.ex @@ -50,6 +50,43 @@ defmodule Stripe.FinancialConnections.Transaction do @type transaction_refresh :: %{optional(:after) => binary} ) + ( + nil + + @doc "

Returns a list of Financial Connections Transaction objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/financial_connections/transactions`\n" + ( + @spec list( + params :: %{ + optional(:account) => binary, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:transacted_at) => transacted_at | integer, + optional(:transaction_refresh) => transaction_refresh + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.FinancialConnections.Transaction.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/financial_connections/transactions", + [], + [] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -93,41 +130,4 @@ defmodule Stripe.FinancialConnections.Transaction do end ) ) - - ( - nil - - @doc "

Returns a list of Financial Connections Transaction objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/financial_connections/transactions`\n" - ( - @spec list( - params :: %{ - optional(:account) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:transacted_at) => transacted_at | integer, - optional(:transaction_refresh) => transaction_refresh - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.FinancialConnections.Transaction.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/financial_connections/transactions", - [], - [] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/forwarding__request.ex b/lib/generated/forwarding__request.ex new file mode 100644 index 00000000..3ad2fd47 --- /dev/null +++ b/lib/generated/forwarding__request.ex @@ -0,0 +1,158 @@ +defmodule Stripe.Forwarding.Request do + use Stripe.Entity + + @moduledoc "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding)." + ( + defstruct [ + :created, + :id, + :livemode, + :object, + :payment_method, + :replacements, + :request_context, + :request_details, + :response_details, + :url + ] + + @typedoc "The `forwarding.request` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `payment_method` The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.\n * `replacements` The field kinds to be replaced in the forwarded request.\n * `request_context` Context about the request from Stripe's servers to the destination endpoint.\n * `request_details` The request that was sent to the destination endpoint. We redact any sensitive fields.\n * `response_details` The response that the destination endpoint returned to us. We redact any sensitive fields.\n * `url` The destination URL for the forwarded request. Must be supported by the config.\n" + @type t :: %__MODULE__{ + created: integer, + id: binary, + livemode: boolean, + object: binary, + payment_method: binary, + replacements: term, + request_context: term | nil, + request_details: term | nil, + response_details: term | nil, + url: binary | nil + } + ) + + ( + @typedoc nil + @type created :: %{ + optional(:gt) => integer, + optional(:gte) => integer, + optional(:lt) => integer, + optional(:lte) => integer + } + ) + + ( + @typedoc nil + @type headers :: %{optional(:name) => binary, optional(:value) => binary} + ) + + ( + @typedoc "The request body and headers to be sent to the destination endpoint." + @type request :: %{optional(:body) => binary, optional(:headers) => list(headers)} + ) + + ( + nil + + @doc "

Lists all ForwardingRequest objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/forwarding/requests`\n" + ( + @spec list( + params :: %{ + optional(:created) => created, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Forwarding.Request.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/forwarding/requests", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves a ForwardingRequest object.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/forwarding/requests/{id}`\n" + ( + @spec retrieve( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Forwarding.Request.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def retrieve(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/forwarding/requests/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a ForwardingRequest object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/forwarding/requests`\n" + ( + @spec create( + params :: %{ + optional(:expand) => list(binary), + optional(:payment_method) => binary, + optional(:replacements) => + list(:card_cvc | :card_expiry | :card_number | :cardholder_name), + optional(:request) => request, + optional(:url) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Forwarding.Request.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/forwarding/requests", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/funding_instructions.ex b/lib/generated/funding_instructions.ex index 56ad1fb1..565f53c5 100644 --- a/lib/generated/funding_instructions.ex +++ b/lib/generated/funding_instructions.ex @@ -14,4 +14,4 @@ defmodule Stripe.FundingInstructions do object: binary } ) -end +end \ No newline at end of file diff --git a/lib/generated/identity__verification_report.ex b/lib/generated/identity__verification_report.ex index 116d3a52..594fcf3e 100644 --- a/lib/generated/identity__verification_report.ex +++ b/lib/generated/identity__verification_report.ex @@ -1,32 +1,40 @@ defmodule Stripe.Identity.VerificationReport do use Stripe.Entity - @moduledoc "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results)." + @moduledoc "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results)." ( defstruct [ + :client_reference_id, :created, :document, + :email, :id, :id_number, :livemode, :object, :options, + :phone, :selfie, :type, + :verification_flow, :verification_session ] - @typedoc "The `identity.verification_report` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `document` \n * `id` Unique identifier for the object.\n * `id_number` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `options` \n * `selfie` \n * `type` Type of report.\n * `verification_session` ID of the VerificationSession that created this report.\n" + @typedoc "The `identity.verification_report` type.\n\n * `client_reference_id` A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `document` \n * `email` \n * `id` Unique identifier for the object.\n * `id_number` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `options` \n * `phone` \n * `selfie` \n * `type` Type of report.\n * `verification_flow` The configuration token of a Verification Flow from the dashboard.\n * `verification_session` ID of the VerificationSession that created this report.\n" @type t :: %__MODULE__{ + client_reference_id: binary | nil, created: integer, document: term, + email: term, id: binary, id_number: term, livemode: boolean, object: binary, options: term, + phone: term, selfie: term, type: binary, + verification_flow: binary, verification_session: binary | nil } ) @@ -41,6 +49,40 @@ defmodule Stripe.Identity.VerificationReport do } ) + ( + nil + + @doc "

List all verification reports.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/identity/verification_reports`\n" + ( + @spec list( + params :: %{ + optional(:client_reference_id) => binary, + optional(:created) => created | integer, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:type) => :document | :id_number, + optional(:verification_session) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Identity.VerificationReport.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params("/v1/identity/verification_reports", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -84,37 +126,4 @@ defmodule Stripe.Identity.VerificationReport do end ) ) - - ( - nil - - @doc "

List all verification reports.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/identity/verification_reports`\n" - ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:type) => :document | :id_number, - optional(:verification_session) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Identity.VerificationReport.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params("/v1/identity/verification_reports", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/identity__verification_session.ex b/lib/generated/identity__verification_session.ex index d49b8418..68b3c6a2 100644 --- a/lib/generated/identity__verification_session.ex +++ b/lib/generated/identity__verification_session.ex @@ -4,6 +4,7 @@ defmodule Stripe.Identity.VerificationSession do @moduledoc "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)" ( defstruct [ + :client_reference_id, :client_secret, :created, :id, @@ -13,15 +14,19 @@ defmodule Stripe.Identity.VerificationSession do :metadata, :object, :options, + :provided_details, :redaction, + :related_customer, :status, :type, :url, + :verification_flow, :verified_outputs ] - @typedoc "The `identity.verification_session` type.\n\n * `client_secret` The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `id` Unique identifier for the object.\n * `last_error` If present, this property tells you the last error encountered when processing the verification.\n * `last_verification_report` ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `options` A set of options for the session’s verification checks.\n * `redaction` Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.\n * `status` Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).\n * `type` The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.\n * `url` The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.\n * `verified_outputs` The user’s verified data.\n" + @typedoc "The `identity.verification_session` type.\n\n * `client_reference_id` A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.\n * `client_secret` The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `id` Unique identifier for the object.\n * `last_error` If present, this property tells you the last error encountered when processing the verification.\n * `last_verification_report` ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `options` A set of options for the session’s verification checks.\n * `provided_details` Details provided about the user being verified. These details may be shown to the user.\n * `redaction` Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.\n * `related_customer` Token referencing a Customer resource.\n * `status` Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).\n * `type` The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.\n * `url` The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.\n * `verification_flow` The configuration token of a Verification Flow from the dashboard.\n * `verified_outputs` The user’s verified data.\n" @type t :: %__MODULE__{ + client_reference_id: binary | nil, client_secret: binary | nil, created: integer, id: binary, @@ -31,10 +36,13 @@ defmodule Stripe.Identity.VerificationSession do metadata: term, object: binary, options: term | nil, + provided_details: term | nil, redaction: term | nil, + related_customer: binary | nil, status: binary, - type: binary | nil, + type: binary, url: binary | nil, + verification_flow: binary, verified_outputs: term | nil } ) @@ -64,32 +72,40 @@ defmodule Stripe.Identity.VerificationSession do @type options :: %{optional(:document) => document | binary} ) + ( + @typedoc "Details provided about the user being verified. These details may be shown to the user." + @type provided_details :: %{optional(:email) => binary, optional(:phone) => binary} + ) + ( nil - @doc "

Creates a VerificationSession object.

\n\n

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

\n\n

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

\n\n

Related guide: Verify your users’ identity documents

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions`\n" + @doc "

Returns a list of VerificationSessions

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/identity/verification_sessions`\n" ( - @spec create( + @spec list( params :: %{ + optional(:client_reference_id) => binary, + optional(:created) => created | integer, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:options) => options, - optional(:return_url) => binary, - optional(:type) => :document | :id_number + optional(:limit) => integer, + optional(:related_customer) => binary, + optional(:starting_after) => binary, + optional(:status) => :canceled | :processing | :requires_input | :verified }, opts :: Keyword.t() ) :: - {:ok, Stripe.Identity.VerificationSession.t()} + {:ok, Stripe.List.t(Stripe.Identity.VerificationSession.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/identity/verification_sessions", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -142,30 +158,33 @@ defmodule Stripe.Identity.VerificationSession do ( nil - @doc "

Returns a list of VerificationSessions

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/identity/verification_sessions`\n" + @doc "

Creates a VerificationSession object.

\n\n

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

\n\n

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

\n\n

Related guide: Verify your users’ identity documents

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions`\n" ( - @spec list( + @spec create( params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, + optional(:client_reference_id) => binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:status) => :canceled | :processing | :requires_input | :verified + optional(:metadata) => %{optional(binary) => binary}, + optional(:options) => options, + optional(:provided_details) => provided_details, + optional(:related_customer) => binary, + optional(:return_url) => binary, + optional(:type) => :document | :id_number, + optional(:verification_flow) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Identity.VerificationSession.t())} + {:ok, Stripe.Identity.VerificationSession.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/identity/verification_sessions", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -174,20 +193,26 @@ defmodule Stripe.Identity.VerificationSession do ( nil - @doc "

A VerificationSession object can be canceled when it is in requires_input status.

\n\n

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions/{session}/cancel`\n" + @doc "

Updates a VerificationSession object.

\n\n

When the session status is requires_input, you can use this method to update the\nverification check and options.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions/{session}`\n" ( - @spec cancel( + @spec update( session :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary}, + optional(:options) => options, + optional(:provided_details) => provided_details, + optional(:type) => :document | :id_number + }, opts :: Keyword.t() ) :: {:ok, Stripe.Identity.VerificationSession.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def cancel(session, params \\ %{}, opts \\ []) do + def update(session, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/identity/verification_sessions/{session}/cancel", + "/v1/identity/verification_sessions/{session}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -218,9 +243,9 @@ defmodule Stripe.Identity.VerificationSession do ( nil - @doc "

Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.

\n\n

A VerificationSession object can be redacted when it is in requires_input or verified\nstatus. Redacting a VerificationSession in requires_action\nstate will automatically cancel it.

\n\n

The redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.

\n\n

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.

\n\n

Learn more.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions/{session}/redact`\n" + @doc "

A VerificationSession object can be canceled when it is in requires_input status.

\n\n

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions/{session}/cancel`\n" ( - @spec redact( + @spec cancel( session :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() @@ -228,10 +253,10 @@ defmodule Stripe.Identity.VerificationSession do {:ok, Stripe.Identity.VerificationSession.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def redact(session, params \\ %{}, opts \\ []) do + def cancel(session, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/identity/verification_sessions/{session}/redact", + "/v1/identity/verification_sessions/{session}/cancel", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -262,25 +287,20 @@ defmodule Stripe.Identity.VerificationSession do ( nil - @doc "

Updates a VerificationSession object.

\n\n

When the session status is requires_input, you can use this method to update the\nverification check and options.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions/{session}`\n" + @doc "

Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.

\n\n

A VerificationSession object can be redacted when it is in requires_input or verified\nstatus. Redacting a VerificationSession in requires_action\nstate will automatically cancel it.

\n\n

The redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.

\n\n

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.

\n\n

Learn more.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/identity/verification_sessions/{session}/redact`\n" ( - @spec update( + @spec redact( session :: binary(), - params :: %{ - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:options) => options, - optional(:type) => :document | :id_number - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Identity.VerificationSession.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(session, params \\ %{}, opts \\ []) do + def redact(session, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/identity/verification_sessions/{session}", + "/v1/identity/verification_sessions/{session}/redact", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -307,4 +327,4 @@ defmodule Stripe.Identity.VerificationSession do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/invoice.ex b/lib/generated/invoice.ex index 802fb60a..bd821b12 100644 --- a/lib/generated/invoice.ex +++ b/lib/generated/invoice.ex @@ -4,91 +4,91 @@ defmodule Stripe.Invoice do @moduledoc "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)" ( defstruct [ - :lines, - :default_tax_rates, - :id, - :attempted, - :transfer_data, - :period_start, + :quote, + :customer_address, + :customer_tax_exempt, + :last_finalization_error, + :webhooks_delivered_at, + :attempt_count, + :customer_name, + :shipping_cost, + :invoice_pdf, + :livemode, + :customer, + :statement_descriptor, + :amount_shipping, + :collection_method, + :total_tax_amounts, + :post_payment_credit_notes_amount, + :discount, + :charge, + :auto_advance, + :subscription_details, :tax, - :application_fee_amount, - :number, + :account_tax_ids, + :created, + :transfer_data, + :subtotal_excluding_tax, + :payment_intent, + :effective_at, :rendering, - :customer_address, - :shipping_details, - :ending_balance, + :application, + :account_name, + :pre_payment_credit_notes_amount, :status, - :from_invoice, - :total_tax_amounts, - :webhooks_delivered_at, - :subscription, - :next_payment_attempt, + :customer_phone, + :paid, + :description, + :id, :period_end, - :amount_remaining, - :quote, - :discounts, - :created, + :footer, + :due_date, + :status_transitions, + :subtotal, + :number, + :paid_out_of_band, + :default_tax_rates, :total_discount_amounts, - :currency, - :subtotal_excluding_tax, - :total_excluding_tax, :automatic_tax, - :test_clock, - :post_payment_credit_notes_amount, - :status_transitions, + :issuer, + :customer_tax_ids, :latest_revision, - :object, + :threshold_reason, :billing_reason, - :receipt_number, + :application_fee_amount, + :currency, + :ending_balance, :default_source, - :rendering_options, - :due_date, - :application, - :payment_settings, - :statement_descriptor, - :hosted_invoice_url, - :account_tax_ids, + :subscription_proration_date, :amount_paid, - :shipping_cost, - :customer, - :account_name, - :charge, + :object, :on_behalf_of, - :customer_email, - :discount, - :threshold_reason, - :paid_out_of_band, - :payment_intent, - :total, + :period_start, + :attempted, + :discounts, + :shipping_details, + :lines, :customer_shipping, - :subscription_details, - :footer, - :subscription_proration_date, - :pre_payment_credit_notes_amount, - :paid, - :description, - :metadata, + :customer_email, + :total_excluding_tax, + :from_invoice, :account_country, - :subtotal, - :amount_shipping, - :custom_fields, - :customer_name, - :attempt_count, - :last_finalization_error, - :amount_due, - :default_payment_method, - :collection_method, - :effective_at, - :customer_tax_ids, - :livemode, + :hosted_invoice_url, + :total, + :subscription, + :next_payment_attempt, + :receipt_number, + :test_clock, :starting_balance, - :invoice_pdf, - :customer_phone, - :auto_advance, - :customer_tax_exempt + :default_payment_method, + :amount_remaining, + :payment_settings, + :custom_fields, + :metadata, + :amount_due ] - @typedoc "The `invoice` type.\n\n * `account_country` The country of the business associated with this invoice, most often the business creating the invoice.\n * `account_name` The public name of the business associated with this invoice, most often the business creating the invoice.\n * `account_tax_ids` The account tax IDs associated with the invoice. Only editable when the invoice is a draft.\n * `amount_due` Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.\n * `amount_paid` The amount, in cents (or local equivalent), that was paid.\n * `amount_remaining` The difference between amount_due and amount_paid, in cents (or local equivalent).\n * `amount_shipping` This is the sum of all the shipping amounts.\n * `application` ID of the Connect Application that created the invoice.\n * `application_fee_amount` The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.\n * `attempt_count` Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.\n * `attempted` Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.\n * `auto_advance` Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.\n * `automatic_tax` \n * `billing_reason` Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.\n * `charge` ID of the latest charge generated for this invoice, if any.\n * `collection_method` Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `custom_fields` Custom fields displayed on the invoice.\n * `customer` The ID of the customer who will be billed.\n * `customer_address` The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_email` The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_name` The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_phone` The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_shipping` The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_tax_exempt` The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_tax_ids` The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.\n * `default_payment_method` ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.\n * `default_source` ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.\n * `default_tax_rates` The tax rates applied to this invoice, if any.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.\n * `discount` Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.\n * `discounts` The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.\n * `due_date` The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.\n * `effective_at` The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.\n * `ending_balance` Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.\n * `footer` Footer displayed on the invoice.\n * `from_invoice` Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.\n * `hosted_invoice_url` The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.\n * `id` Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.\n * `invoice_pdf` The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.\n * `last_finalization_error` The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.\n * `latest_revision` The ID of the most recent non-draft revision of this invoice\n * `lines` The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `next_payment_attempt` The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.\n * `number` A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.\n * `paid` Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.\n * `paid_out_of_band` Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.\n * `payment_intent` The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.\n * `payment_settings` \n * `period_end` End of the usage period during which invoice items were added to this invoice.\n * `period_start` Start of the usage period during which invoice items were added to this invoice.\n * `post_payment_credit_notes_amount` Total amount of all post-payment credit notes issued for this invoice.\n * `pre_payment_credit_notes_amount` Total amount of all pre-payment credit notes issued for this invoice.\n * `quote` The quote this invoice was generated from.\n * `receipt_number` This is the transaction number that appears on email receipts sent for this invoice.\n * `rendering` The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.\n * `rendering_options` This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering.\n * `shipping_cost` The details of the cost of shipping, including the ShippingRate applied on the invoice.\n * `shipping_details` Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.\n * `starting_balance` Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.\n * `statement_descriptor` Extra information about an invoice for the customer's credit card statement.\n * `status` The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)\n * `status_transitions` \n * `subscription` The subscription that this invoice was prepared for, if any.\n * `subscription_details` Details about the subscription that created this invoice.\n * `subscription_proration_date` Only set for upcoming invoices that preview prorations. The time used to calculate prorations.\n * `subtotal` Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated\n * `subtotal_excluding_tax` The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated\n * `tax` The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.\n * `test_clock` ID of the test clock this invoice belongs to.\n * `threshold_reason` \n * `total` Total after discounts and taxes.\n * `total_discount_amounts` The aggregate amounts calculated per discount across all line items.\n * `total_excluding_tax` The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.\n * `total_tax_amounts` The aggregate amounts calculated per tax rate for all line items.\n * `transfer_data` The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.\n * `webhooks_delivered_at` Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.\n" + @typedoc "The `invoice` type.\n\n * `account_country` The country of the business associated with this invoice, most often the business creating the invoice.\n * `account_name` The public name of the business associated with this invoice, most often the business creating the invoice.\n * `account_tax_ids` The account tax IDs associated with the invoice. Only editable when the invoice is a draft.\n * `amount_due` Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.\n * `amount_paid` The amount, in cents (or local equivalent), that was paid.\n * `amount_remaining` The difference between amount_due and amount_paid, in cents (or local equivalent).\n * `amount_shipping` This is the sum of all the shipping amounts.\n * `application` ID of the Connect Application that created the invoice.\n * `application_fee_amount` The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.\n * `attempt_count` Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.\n * `attempted` Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.\n * `auto_advance` Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.\n * `automatic_tax` \n * `billing_reason` Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.\n * `charge` ID of the latest charge generated for this invoice, if any.\n * `collection_method` Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `custom_fields` Custom fields displayed on the invoice.\n * `customer` The ID of the customer who will be billed.\n * `customer_address` The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_email` The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_name` The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_phone` The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_shipping` The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_tax_exempt` The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.\n * `customer_tax_ids` The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.\n * `default_payment_method` ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.\n * `default_source` ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.\n * `default_tax_rates` The tax rates applied to this invoice, if any.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.\n * `discount` Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.\n * `discounts` The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.\n * `due_date` The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.\n * `effective_at` The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.\n * `ending_balance` Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.\n * `footer` Footer displayed on the invoice.\n * `from_invoice` Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.\n * `hosted_invoice_url` The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.\n * `id` Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.\n * `invoice_pdf` The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.\n * `issuer` \n * `last_finalization_error` The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.\n * `latest_revision` The ID of the most recent non-draft revision of this invoice\n * `lines` The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `next_payment_attempt` The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.\n * `number` A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.\n * `paid` Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.\n * `paid_out_of_band` Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.\n * `payment_intent` The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.\n * `payment_settings` \n * `period_end` End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.\n * `period_start` Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.\n * `post_payment_credit_notes_amount` Total amount of all post-payment credit notes issued for this invoice.\n * `pre_payment_credit_notes_amount` Total amount of all pre-payment credit notes issued for this invoice.\n * `quote` The quote this invoice was generated from.\n * `receipt_number` This is the transaction number that appears on email receipts sent for this invoice.\n * `rendering` The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.\n * `shipping_cost` The details of the cost of shipping, including the ShippingRate applied on the invoice.\n * `shipping_details` Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.\n * `starting_balance` Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.\n * `statement_descriptor` Extra information about an invoice for the customer's credit card statement.\n * `status` The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)\n * `status_transitions` \n * `subscription` The subscription that this invoice was prepared for, if any.\n * `subscription_details` Details about the subscription that created this invoice.\n * `subscription_proration_date` Only set for upcoming invoices that preview prorations. The time used to calculate prorations.\n * `subtotal` Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated\n * `subtotal_excluding_tax` The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated\n * `tax` The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.\n * `test_clock` ID of the test clock this invoice belongs to.\n * `threshold_reason` \n * `total` Total after discounts and taxes.\n * `total_discount_amounts` The aggregate amounts calculated per discount across all line items.\n * `total_excluding_tax` The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.\n * `total_tax_amounts` The aggregate amounts calculated per tax rate for all line items.\n * `transfer_data` The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.\n * `webhooks_delivered_at` Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.\n" @type t :: %__MODULE__{ account_country: binary | nil, account_name: binary | nil, @@ -122,7 +122,7 @@ defmodule Stripe.Invoice do default_tax_rates: term, description: binary | nil, discount: term | nil, - discounts: term | nil, + discounts: term, due_date: integer | nil, effective_at: integer | nil, ending_balance: integer | nil, @@ -131,6 +131,7 @@ defmodule Stripe.Invoice do hosted_invoice_url: binary | nil, id: binary, invoice_pdf: binary | nil, + issuer: term, last_finalization_error: Stripe.ApiErrors.t() | nil, latest_revision: (binary | Stripe.Invoice.t()) | nil, lines: term, @@ -151,7 +152,6 @@ defmodule Stripe.Invoice do quote: (binary | Stripe.Quote.t()) | nil, receipt_number: binary | nil, rendering: term | nil, - rendering_options: term | nil, shipping_cost: term | nil, shipping_details: term | nil, starting_balance: integer, @@ -183,6 +183,17 @@ defmodule Stripe.Invoice do } ) + ( + @typedoc nil + @type add_invoice_items :: %{ + optional(:discounts) => list(discounts), + optional(:price) => binary, + optional(:price_data) => price_data, + optional(:quantity) => integer, + optional(:tax_rates) => list(binary) | binary + } + ) + ( @typedoc nil @type address :: %{ @@ -197,7 +208,7 @@ defmodule Stripe.Invoice do ( @typedoc nil - @type automatic_tax :: %{optional(:enabled) => boolean} + @type automatic_tax :: %{optional(:enabled) => boolean, optional(:liability) => liability} ) ( @@ -215,14 +226,17 @@ defmodule Stripe.Invoice do ( @typedoc nil - @type billing_thresholds :: %{optional(:usage_gte) => integer} + @type billing_thresholds :: %{ + optional(:amount_gte) => integer, + optional(:reset_billing_cycle_anchor) => boolean + } ) ( @typedoc nil @type card :: %{ optional(:installments) => installments, - optional(:request_three_d_secure) => :any | :automatic + optional(:request_three_d_secure) => :any | :automatic | :challenge } ) @@ -267,7 +281,11 @@ defmodule Stripe.Invoice do ( @typedoc nil - @type discounts :: %{optional(:coupon) => binary, optional(:discount) => binary} + @type discounts :: %{ + optional(:coupon) => binary, + optional(:discount) => binary, + optional(:promotion_code) => binary + } ) ( @@ -285,12 +303,18 @@ defmodule Stripe.Invoice do @type eu_bank_transfer :: %{optional(:country) => binary} ) + ( + @typedoc "Provide filters for the linked accounts that the customer can select for the payment method." + @type filters :: %{optional(:account_subcategories) => list(:checking | :savings)} + ) + ( @typedoc "Additional fields for Financial Connections Session creation" @type financial_connections :: %{ + optional(:filters) => filters, optional(:permissions) => list(:balances | :ownership | :payment_method | :transactions), - optional(:prefetch) => list(:balances | :transactions) + optional(:prefetch) => list(:balances | :ownership | :transactions) } ) @@ -335,6 +359,57 @@ defmodule Stripe.Invoice do } ) + ( + @typedoc "All invoices will be billed using the specified settings." + @type invoice_settings :: %{ + optional(:account_tax_ids) => list(binary) | binary, + optional(:days_until_due) => integer, + optional(:issuer) => issuer + } + ) + + ( + @typedoc nil + @type issuer :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + + ( + @typedoc nil + @type items :: %{ + optional(:billing_thresholds) => billing_thresholds | binary, + optional(:discounts) => list(discounts) | binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:plan) => binary, + optional(:price) => binary, + optional(:price_data) => price_data, + optional(:quantity) => integer, + optional(:tax_rates) => list(binary) | binary + } + ) + + ( + @typedoc "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." + @type liability :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + + ( + @typedoc nil + @type lines :: %{ + optional(:amount) => integer, + optional(:description) => binary, + optional(:discountable) => boolean, + optional(:discounts) => list(discounts) | binary, + optional(:invoice_item) => binary, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:period) => period, + optional(:price) => binary, + optional(:price_data) => price_data, + optional(:quantity) => integer, + optional(:tax_amounts) => list(tax_amounts) | binary, + optional(:tax_rates) => list(binary) | binary + } + ) + ( @typedoc "Additional fields for Mandate creation" @type mandate_options :: %{optional(:transaction_type) => :business | :personal} @@ -364,6 +439,7 @@ defmodule Stripe.Invoice do optional(:card) => card | binary, optional(:customer_balance) => customer_balance | binary, optional(:konbini) => map() | binary, + optional(:sepa_debit) => map() | binary, optional(:us_bank_account) => us_bank_account | binary } ) @@ -378,6 +454,7 @@ defmodule Stripe.Invoice do :ach_credit_transfer | :ach_debit | :acss_debit + | :amazon_pay | :au_becs_debit | :bacs_debit | :bancontact @@ -392,13 +469,16 @@ defmodule Stripe.Invoice do | :ideal | :konbini | :link + | :multibanco | :p24 | :paynow | :paypal | :promptpay + | :revolut_pay | :sepa_credit_transfer | :sepa_debit | :sofort + | :swish | :us_bank_account | :wechat_pay ) @@ -416,6 +496,35 @@ defmodule Stripe.Invoice do @type period :: %{optional(:end) => integer, optional(:start) => integer} ) + ( + @typedoc nil + @type phases :: %{ + optional(:add_invoice_items) => list(add_invoice_items), + optional(:application_fee_percent) => number, + optional(:automatic_tax) => automatic_tax, + optional(:billing_cycle_anchor) => :automatic | :phase_start, + optional(:billing_thresholds) => billing_thresholds | binary, + optional(:collection_method) => :charge_automatically | :send_invoice, + optional(:coupon) => binary, + optional(:currency) => binary, + optional(:default_payment_method) => binary, + optional(:default_tax_rates) => list(binary) | binary, + optional(:description) => binary | binary, + optional(:discounts) => list(discounts) | binary, + optional(:end_date) => integer | :now, + optional(:invoice_settings) => invoice_settings, + optional(:items) => list(items), + optional(:iterations) => integer, + optional(:metadata) => %{optional(binary) => binary}, + optional(:on_behalf_of) => binary, + optional(:proration_behavior) => :always_invoice | :create_prorations | :none, + optional(:start_date) => integer | :now, + optional(:transfer_data) => transfer_data, + optional(:trial) => boolean, + optional(:trial_end) => integer | :now + } + ) + ( @typedoc nil @type plan :: %{ @@ -437,6 +546,17 @@ defmodule Stripe.Invoice do } ) + ( + @typedoc "Data used to generate a new product object inline. One of `product` or `product_data` is required." + @type product_data :: %{ + optional(:description) => binary, + optional(:images) => list(binary), + optional(:metadata) => %{optional(binary) => binary}, + optional(:name) => binary, + optional(:tax_code) => binary + } + ) + ( @typedoc "The recurring components of a price such as `interval` and `interval_count`." @type recurring :: %{ @@ -449,14 +569,18 @@ defmodule Stripe.Invoice do @typedoc "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page." @type rendering :: %{ optional(:amount_tax_display) => :exclude_tax | :include_inclusive_tax, - optional(:pdf) => pdf + optional(:pdf) => pdf, + optional(:template) => binary, + optional(:template_version) => integer | binary } ) ( @typedoc nil - @type rendering_options :: %{ - optional(:amount_tax_display) => :exclude_tax | :include_inclusive_tax + @type schedule_details :: %{ + optional(:end_behavior) => :cancel | :release, + optional(:phases) => list(phases), + optional(:proration_behavior) => :always_invoice | :create_prorations | :none } ) @@ -470,7 +594,7 @@ defmodule Stripe.Invoice do ) ( - @typedoc nil + @typedoc "Settings for the cost of shipping for this invoice." @type shipping_cost :: %{ optional(:shipping_rate) => binary, optional(:shipping_rate_data) => shipping_rate_data @@ -478,7 +602,7 @@ defmodule Stripe.Invoice do ) ( - @typedoc nil + @typedoc "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer." @type shipping_details :: %{ optional(:address) => address, optional(:name) => binary, @@ -499,12 +623,30 @@ defmodule Stripe.Invoice do } ) + ( + @typedoc nil + @type subscription_details :: %{ + optional(:billing_cycle_anchor) => (:now | :unchanged) | integer, + optional(:cancel_at) => integer | binary, + optional(:cancel_at_period_end) => boolean, + optional(:cancel_now) => boolean, + optional(:default_tax_rates) => list(binary) | binary, + optional(:items) => list(items), + optional(:proration_behavior) => :always_invoice | :create_prorations | :none, + optional(:proration_date) => integer, + optional(:resume_at) => :now, + optional(:start_date) => integer, + optional(:trial_end) => :now | integer + } + ) + ( @typedoc nil @type subscription_items :: %{ optional(:billing_thresholds) => billing_thresholds | binary, optional(:clear_usage) => boolean, optional(:deleted) => boolean, + optional(:discounts) => list(discounts) | binary, optional(:id) => binary, optional(:metadata) => %{optional(binary) => binary} | binary, optional(:plan) => binary, @@ -520,6 +662,15 @@ defmodule Stripe.Invoice do @type tax :: %{optional(:ip_address) => binary | binary} ) + ( + @typedoc nil + @type tax_amounts :: %{ + optional(:amount) => integer, + optional(:tax_rate_data) => tax_rate_data, + optional(:taxable_amount) => integer + } + ) + ( @typedoc nil @type tax_ids :: %{ @@ -530,6 +681,7 @@ defmodule Stripe.Invoice do | :au_abn | :au_arn | :bg_uic + | :bh_vat | :bo_tin | :br_cnpj | :br_cpf @@ -539,11 +691,13 @@ defmodule Stripe.Invoice do | :ca_pst_mb | :ca_pst_sk | :ca_qst + | :ch_uid | :ch_vat | :cl_tin | :cn_tin | :co_nit | :cr_tin + | :de_stn | :do_rcn | :ec_ruc | :eg_tin @@ -553,6 +707,7 @@ defmodule Stripe.Invoice do | :gb_vat | :ge_vat | :hk_br + | :hr_oib | :hu_tin | :id_npwp | :il_vat @@ -563,13 +718,17 @@ defmodule Stripe.Invoice do | :jp_trn | :ke_pin | :kr_brn + | :kz_bin | :li_uid | :mx_rfc | :my_frp | :my_itn | :my_sst + | :ng_tin | :no_vat + | :no_voec | :nz_gst + | :om_vat | :pe_ruc | :ph_tin | :ro_tin @@ -595,8 +754,37 @@ defmodule Stripe.Invoice do ) ( - @typedoc nil - @type transfer_data :: %{optional(:amount) => integer, optional(:destination) => binary} + @typedoc "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items." + @type tax_rate_data :: %{ + optional(:country) => binary, + optional(:description) => binary, + optional(:display_name) => binary, + optional(:inclusive) => boolean, + optional(:jurisdiction) => binary, + optional(:percentage) => number, + optional(:state) => binary, + optional(:tax_type) => + :amusement_tax + | :communications_tax + | :gst + | :hst + | :igst + | :jct + | :lease_tax + | :pst + | :qst + | :rst + | :sales_tax + | :vat + } + ) + + ( + @typedoc "The data with which to automatically create a Transfer for each of the associated subscription's invoices." + @type transfer_data :: %{ + optional(:amount_percent) => number, + optional(:destination) => binary + } ) ( @@ -610,67 +798,65 @@ defmodule Stripe.Invoice do ( nil - @doc "

Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices/search`\n" - ( - @spec search( - params :: %{ - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:page) => binary, - optional(:query) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.SearchResult.t(Stripe.Invoice.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def search(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/invoices/search", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices/upcoming`\n" + @doc "

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/invoices/{invoice}`\n" ( - @spec upcoming( - params :: %{ - optional(:automatic_tax) => automatic_tax, - optional(:coupon) => binary, - optional(:currency) => binary, + @spec delete(invoice :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedInvoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def delete(invoice, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoices/{invoice}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "invoice", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "invoice", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [invoice] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices`\n" + ( + @spec list( + params :: %{ + optional(:collection_method) => :charge_automatically | :send_invoice, + optional(:created) => created | integer, optional(:customer) => binary, - optional(:customer_details) => customer_details, - optional(:discounts) => list(discounts) | binary, + optional(:due_date) => due_date | integer, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:invoice_items) => list(invoice_items), - optional(:schedule) => binary, - optional(:subscription) => binary, - optional(:subscription_billing_cycle_anchor) => (:now | :unchanged) | integer, - optional(:subscription_cancel_at) => integer | binary, - optional(:subscription_cancel_at_period_end) => boolean, - optional(:subscription_cancel_now) => boolean, - optional(:subscription_default_tax_rates) => list(binary) | binary, - optional(:subscription_items) => list(subscription_items), - optional(:subscription_proration_behavior) => - :always_invoice | :create_prorations | :none, - optional(:subscription_proration_date) => integer, - optional(:subscription_resume_at) => :now, - optional(:subscription_start_date) => integer, - optional(:subscription_trial_end) => :now | integer, - optional(:subscription_trial_from_plan) => boolean + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :draft | :open | :paid | :uncollectible | :void, + optional(:subscription) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def upcoming(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/invoices/upcoming", [], []) + ) :: + {:ok, Stripe.List.t(Stripe.Invoice.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/invoices", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -684,40 +870,14 @@ defmodule Stripe.Invoice do ( nil - @doc "

Draft invoices are fully editable. Once an invoice is finalized,\nmonetary values, as well as collection_method, become uneditable.

\n\n

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or automatically reconciling invoices, pass\nauto_advance=false.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}`\n" + @doc "

Retrieves the invoice with the given ID.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices/{invoice}`\n" ( - @spec update( + @spec retrieve( invoice :: binary(), - params :: %{ - optional(:account_tax_ids) => list(binary) | binary, - optional(:application_fee_amount) => integer, - optional(:auto_advance) => boolean, - optional(:automatic_tax) => automatic_tax, - optional(:collection_method) => :charge_automatically | :send_invoice, - optional(:custom_fields) => list(custom_fields) | binary, - optional(:days_until_due) => integer, - optional(:default_payment_method) => binary, - optional(:default_source) => binary | binary, - optional(:default_tax_rates) => list(binary) | binary, - optional(:description) => binary, - optional(:discounts) => list(discounts) | binary, - optional(:due_date) => integer, - optional(:effective_at) => integer | binary, - optional(:expand) => list(binary), - optional(:footer) => binary, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:on_behalf_of) => binary | binary, - optional(:payment_settings) => payment_settings, - optional(:rendering) => rendering, - optional(:rendering_options) => rendering_options | binary, - optional(:shipping_cost) => shipping_cost | binary, - optional(:shipping_details) => shipping_details | binary, - optional(:statement_descriptor) => binary, - optional(:transfer_data) => transfer_data | binary - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(invoice, params \\ %{}, opts \\ []) do + def retrieve(invoice, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/invoices/{invoice}", @@ -742,7 +902,7 @@ defmodule Stripe.Invoice do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -751,47 +911,77 @@ defmodule Stripe.Invoice do ( nil - @doc "

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/pay`\n" + @doc "

Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices/search`\n" ( - @spec pay( - invoice :: binary(), + @spec search( params :: %{ optional(:expand) => list(binary), - optional(:forgive) => boolean, - optional(:mandate) => binary | binary, - optional(:off_session) => boolean, - optional(:paid_out_of_band) => boolean, - optional(:payment_method) => binary, - optional(:source) => binary + optional(:limit) => integer, + optional(:page) => binary, + optional(:query) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.SearchResult.t(Stripe.Invoice.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def search(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/invoices/search", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

\n\n

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices/upcoming`\n" + ( + @spec upcoming( + params :: %{ + optional(:automatic_tax) => automatic_tax, + optional(:coupon) => binary, + optional(:currency) => binary, + optional(:customer) => binary, + optional(:customer_details) => customer_details, + optional(:discounts) => list(discounts) | binary, + optional(:expand) => list(binary), + optional(:invoice_items) => list(invoice_items), + optional(:issuer) => issuer, + optional(:on_behalf_of) => binary | binary, + optional(:preview_mode) => :next | :recurring, + optional(:schedule) => binary, + optional(:schedule_details) => schedule_details, + optional(:subscription) => binary, + optional(:subscription_billing_cycle_anchor) => (:now | :unchanged) | integer, + optional(:subscription_cancel_at) => integer | binary, + optional(:subscription_cancel_at_period_end) => boolean, + optional(:subscription_cancel_now) => boolean, + optional(:subscription_default_tax_rates) => list(binary) | binary, + optional(:subscription_details) => subscription_details, + optional(:subscription_items) => list(subscription_items), + optional(:subscription_proration_behavior) => + :always_invoice | :create_prorations | :none, + optional(:subscription_proration_date) => integer, + optional(:subscription_resume_at) => :now, + optional(:subscription_start_date) => integer, + optional(:subscription_trial_end) => :now | integer, + optional(:subscription_trial_from_plan) => boolean }, opts :: Keyword.t() ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def pay(invoice, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/invoices/{invoice}/pay", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "invoice", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "invoice", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [invoice] - ) + def upcoming(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/invoices/upcoming", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -813,8 +1003,12 @@ defmodule Stripe.Invoice do optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:invoice_items) => list(invoice_items), + optional(:issuer) => issuer, optional(:limit) => integer, + optional(:on_behalf_of) => binary | binary, + optional(:preview_mode) => :next | :recurring, optional(:schedule) => binary, + optional(:schedule_details) => schedule_details, optional(:starting_after) => binary, optional(:subscription) => binary, optional(:subscription_billing_cycle_anchor) => (:now | :unchanged) | integer, @@ -822,6 +1016,7 @@ defmodule Stripe.Invoice do optional(:subscription_cancel_at_period_end) => boolean, optional(:subscription_cancel_now) => boolean, optional(:subscription_default_tax_rates) => list(binary) | binary, + optional(:subscription_details) => subscription_details, optional(:subscription_items) => list(subscription_items), optional(:subscription_proration_behavior) => :always_invoice | :create_prorations | :none, @@ -874,13 +1069,13 @@ defmodule Stripe.Invoice do optional(:expand) => list(binary), optional(:footer) => binary, optional(:from_invoice) => from_invoice, + optional(:issuer) => issuer, optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:number) => binary, optional(:on_behalf_of) => binary, optional(:payment_settings) => payment_settings, - optional(:pending_invoice_items_behavior) => - :exclude | :include | :include_and_require, + optional(:pending_invoice_items_behavior) => :exclude | :include, optional(:rendering) => rendering, - optional(:rendering_options) => rendering_options | binary, optional(:shipping_cost) => shipping_cost, optional(:shipping_details) => shipping_details, optional(:statement_descriptor) => binary, @@ -904,33 +1099,66 @@ defmodule Stripe.Invoice do ( nil - @doc "

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices`\n" + @doc "

Draft invoices are fully editable. Once an invoice is finalized,\nmonetary values, as well as collection_method, become uneditable.

\n\n

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or automatically reconciling invoices, pass\nauto_advance=false.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}`\n" ( - @spec list( + @spec update( + invoice :: binary(), params :: %{ + optional(:account_tax_ids) => list(binary) | binary, + optional(:application_fee_amount) => integer, + optional(:auto_advance) => boolean, + optional(:automatic_tax) => automatic_tax, optional(:collection_method) => :charge_automatically | :send_invoice, - optional(:created) => created | integer, - optional(:customer) => binary, - optional(:due_date) => due_date | integer, - optional(:ending_before) => binary, + optional(:custom_fields) => list(custom_fields) | binary, + optional(:days_until_due) => integer, + optional(:default_payment_method) => binary, + optional(:default_source) => binary | binary, + optional(:default_tax_rates) => list(binary) | binary, + optional(:description) => binary, + optional(:discounts) => list(discounts) | binary, + optional(:due_date) => integer, + optional(:effective_at) => integer | binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:status) => :draft | :open | :paid | :uncollectible | :void, - optional(:subscription) => binary + optional(:footer) => binary, + optional(:issuer) => issuer, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:number) => binary | binary, + optional(:on_behalf_of) => binary | binary, + optional(:payment_settings) => payment_settings, + optional(:rendering) => rendering, + optional(:shipping_cost) => shipping_cost | binary, + optional(:shipping_details) => shipping_details | binary, + optional(:statement_descriptor) => binary, + optional(:transfer_data) => transfer_data | binary }, opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Invoice.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/invoices", [], []) + ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(invoice, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoices/{invoice}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "invoice", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "invoice", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [invoice] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -939,17 +1167,103 @@ defmodule Stripe.Invoice do ( nil - @doc "

Retrieves the invoice with the given ID.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoices/{invoice}`\n" + @doc "

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/add_lines`\n" ( - @spec retrieve( + @spec add_lines( + invoice :: binary(), + params :: %{ + optional(:expand) => list(binary), + optional(:invoice_metadata) => map() | binary, + optional(:lines) => list(lines) + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def add_lines(invoice, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoices/{invoice}/add_lines", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "invoice", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "invoice", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [invoice] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/finalize`\n" + ( + @spec finalize_invoice( + invoice :: binary(), + params :: %{optional(:auto_advance) => boolean, optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def finalize_invoice(invoice, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoices/{invoice}/finalize", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "invoice", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "invoice", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [invoice] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/mark_uncollectible`\n" + ( + @spec mark_uncollectible( invoice :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(invoice, params \\ %{}, opts \\ []) do + def mark_uncollectible(invoice, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/invoices/{invoice}", + "/v1/invoices/{invoice}/mark_uncollectible", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -971,7 +1285,7 @@ defmodule Stripe.Invoice do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -980,14 +1294,25 @@ defmodule Stripe.Invoice do ( nil - @doc "

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/invoices/{invoice}`\n" + @doc "

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/pay`\n" ( - @spec delete(invoice :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedInvoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(invoice, opts \\ []) do + @spec pay( + invoice :: binary(), + params :: %{ + optional(:expand) => list(binary), + optional(:forgive) => boolean, + optional(:mandate) => binary | binary, + optional(:off_session) => boolean, + optional(:paid_out_of_band) => boolean, + optional(:payment_method) => binary, + optional(:source) => binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def pay(invoice, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/invoices/{invoice}", + "/v1/invoices/{invoice}/pay", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1008,7 +1333,8 @@ defmodule Stripe.Invoice do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -1017,17 +1343,21 @@ defmodule Stripe.Invoice do ( nil - @doc "

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/finalize`\n" + @doc "

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/remove_lines`\n" ( - @spec finalize_invoice( + @spec remove_lines( invoice :: binary(), - params :: %{optional(:auto_advance) => boolean, optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:invoice_metadata) => map() | binary, + optional(:lines) => list(lines) + }, opts :: Keyword.t() ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def finalize_invoice(invoice, params \\ %{}, opts \\ []) do + def remove_lines(invoice, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/invoices/{invoice}/finalize", + "/v1/invoices/{invoice}/remove_lines", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1099,17 +1429,21 @@ defmodule Stripe.Invoice do ( nil - @doc "

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/mark_uncollectible`\n" + @doc "

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/update_lines`\n" ( - @spec mark_uncollectible( + @spec update_lines( invoice :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:invoice_metadata) => map() | binary, + optional(:lines) => list(lines) + }, opts :: Keyword.t() ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def mark_uncollectible(invoice, params \\ %{}, opts \\ []) do + def update_lines(invoice, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/invoices/{invoice}/mark_uncollectible", + "/v1/invoices/{invoice}/update_lines", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1140,7 +1474,7 @@ defmodule Stripe.Invoice do ( nil - @doc "

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/void`\n" + @doc "

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

\n\n

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/{invoice}/void`\n" ( @spec void_invoice( invoice :: binary(), @@ -1177,4 +1511,41 @@ defmodule Stripe.Invoice do end ) ) -end + + ( + nil + + @doc "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

\n\n

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoices/create_preview`\n" + ( + @spec create_preview( + params :: %{ + optional(:automatic_tax) => automatic_tax, + optional(:coupon) => binary, + optional(:currency) => binary, + optional(:customer) => binary, + optional(:customer_details) => customer_details, + optional(:discounts) => list(discounts) | binary, + optional(:expand) => list(binary), + optional(:invoice_items) => list(invoice_items), + optional(:issuer) => issuer, + optional(:on_behalf_of) => binary | binary, + optional(:preview_mode) => :next | :recurring, + optional(:schedule) => binary, + optional(:schedule_details) => schedule_details, + optional(:subscription) => binary, + optional(:subscription_details) => subscription_details + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Invoice.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create_preview(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/invoices/create_preview", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/invoice_rendering_template.ex b/lib/generated/invoice_rendering_template.ex new file mode 100644 index 00000000..59941b14 --- /dev/null +++ b/lib/generated/invoice_rendering_template.ex @@ -0,0 +1,181 @@ +defmodule Stripe.InvoiceRenderingTemplate do + use Stripe.Entity + @moduledoc "" + ( + defstruct [:created, :id, :livemode, :metadata, :nickname, :object, :status, :version] + + @typedoc "The `invoice_rendering_template` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `nickname` A brief description of the template, hidden from customers\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The status of the template, one of `active` or `archived`.\n * `version` Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering\n" + @type t :: %__MODULE__{ + created: integer, + id: binary, + livemode: boolean, + metadata: term | nil, + nickname: binary | nil, + object: binary, + status: binary, + version: integer + } + ) + + ( + nil + + @doc "

List all templates, ordered by creation date, with the most recently created template appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoice_rendering_templates`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :active | :archived + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.InvoiceRenderingTemplate.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/invoice_rendering_templates", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoice_rendering_templates/{template}`\n" + ( + @spec retrieve( + template :: binary(), + params :: %{optional(:expand) => list(binary), optional(:version) => integer}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.InvoiceRenderingTemplate.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def retrieve(template, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoice_rendering_templates/{template}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "template", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "template", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [template] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoice_rendering_templates/{template}/archive`\n" + ( + @spec archive( + template :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.InvoiceRenderingTemplate.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def archive(template, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoice_rendering_templates/{template}/archive", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "template", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "template", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [template] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoice_rendering_templates/{template}/unarchive`\n" + ( + @spec unarchive( + template :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.InvoiceRenderingTemplate.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def unarchive(template, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoice_rendering_templates/{template}/unarchive", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "template", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "template", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [template] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/invoiceitem.ex b/lib/generated/invoiceitem.ex index 928071bf..e18461ee 100644 --- a/lib/generated/invoiceitem.ex +++ b/lib/generated/invoiceitem.ex @@ -69,7 +69,11 @@ defmodule Stripe.Invoiceitem do ( @typedoc nil - @type discounts :: %{optional(:coupon) => binary, optional(:discount) => binary} + @type discounts :: %{ + optional(:coupon) => binary, + optional(:discount) => binary, + optional(:promotion_code) => binary + } ) ( @@ -78,7 +82,7 @@ defmodule Stripe.Invoiceitem do ) ( - @typedoc "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline." + @typedoc "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required." @type price_data :: %{ optional(:currency) => binary, optional(:product) => binary, @@ -91,31 +95,37 @@ defmodule Stripe.Invoiceitem do ( nil - @doc "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoiceitems`\n" + @doc "

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/invoiceitems/{invoiceitem}`\n" ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:customer) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:invoice) => binary, - optional(:limit) => integer, - optional(:pending) => boolean, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Invoiceitem.t())} + @spec delete(invoiceitem :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedInvoiceitem.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/invoiceitems", [], []) + def delete(invoiceitem, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/invoiceitems/{invoiceitem}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "invoiceitem", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "invoiceitem", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [invoiceitem] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -124,39 +134,31 @@ defmodule Stripe.Invoiceitem do ( nil - @doc "

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoiceitems`\n" + @doc "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/invoiceitems`\n" ( - @spec create( + @spec list( params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, + optional(:created) => created | integer, optional(:customer) => binary, - optional(:description) => binary, - optional(:discountable) => boolean, - optional(:discounts) => list(discounts) | binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:invoice) => binary, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:period) => period, - optional(:price) => binary, - optional(:price_data) => price_data, - optional(:quantity) => integer, - optional(:subscription) => binary, - optional(:tax_behavior) => :exclusive | :inclusive | :unspecified, - optional(:tax_code) => binary | binary, - optional(:tax_rates) => list(binary), - optional(:unit_amount) => integer, - optional(:unit_amount_decimal) => binary + optional(:limit) => integer, + optional(:pending) => boolean, + optional(:starting_after) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Invoiceitem.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Invoiceitem.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/invoiceitems", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -206,50 +208,34 @@ defmodule Stripe.Invoiceitem do ( nil - @doc "

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoiceitems/{invoiceitem}`\n" + @doc "

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoiceitems`\n" ( - @spec update( - invoiceitem :: binary(), + @spec create( params :: %{ optional(:amount) => integer, + optional(:currency) => binary, + optional(:customer) => binary, optional(:description) => binary, optional(:discountable) => boolean, optional(:discounts) => list(discounts) | binary, optional(:expand) => list(binary), + optional(:invoice) => binary, optional(:metadata) => %{optional(binary) => binary} | binary, optional(:period) => period, optional(:price) => binary, optional(:price_data) => price_data, optional(:quantity) => integer, + optional(:subscription) => binary, optional(:tax_behavior) => :exclusive | :inclusive | :unspecified, optional(:tax_code) => binary | binary, - optional(:tax_rates) => list(binary) | binary, + optional(:tax_rates) => list(binary), optional(:unit_amount) => integer, optional(:unit_amount_decimal) => binary }, opts :: Keyword.t() ) :: {:ok, Stripe.Invoiceitem.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(invoiceitem, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/invoiceitems/{invoiceitem}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "invoiceitem", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "invoiceitem", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [invoiceitem] - ) + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/invoiceitems", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -263,13 +249,30 @@ defmodule Stripe.Invoiceitem do ( nil - @doc "

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/invoiceitems/{invoiceitem}`\n" + @doc "

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/invoiceitems/{invoiceitem}`\n" ( - @spec delete(invoiceitem :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedInvoiceitem.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete(invoiceitem, opts \\ []) do + @spec update( + invoiceitem :: binary(), + params :: %{ + optional(:amount) => integer, + optional(:description) => binary, + optional(:discountable) => boolean, + optional(:discounts) => list(discounts) | binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:period) => period, + optional(:price) => binary, + optional(:price_data) => price_data, + optional(:quantity) => integer, + optional(:tax_behavior) => :exclusive | :inclusive | :unspecified, + optional(:tax_code) => binary | binary, + optional(:tax_rates) => list(binary) | binary, + optional(:unit_amount) => integer, + optional(:unit_amount_decimal) => binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Invoiceitem.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(invoiceitem, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/invoiceitems/{invoiceitem}", @@ -293,9 +296,10 @@ defmodule Stripe.Invoiceitem do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/issuing__authorization.ex b/lib/generated/issuing__authorization.ex index 3ea596a0..77692d67 100644 --- a/lib/generated/issuing__authorization.ex +++ b/lib/generated/issuing__authorization.ex @@ -13,6 +13,8 @@ defmodule Stripe.Issuing.Authorization do :cardholder, :created, :currency, + :fleet, + :fuel, :id, :livemode, :merchant_amount, @@ -31,7 +33,7 @@ defmodule Stripe.Issuing.Authorization do :wallet ] - @typedoc "The `issuing.authorization` type.\n\n * `amount` The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.\n * `amount_details` Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `approved` Whether the authorization has been approved.\n * `authorization_method` How the card details were provided.\n * `balance_transactions` List of balance transactions associated with this authorization.\n * `card` \n * `cardholder` The cardholder to whom this authorization belongs.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `merchant_amount` The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.\n * `merchant_currency` The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `merchant_data` \n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `network_data` Details about the authorization, such as identifiers, set by the card network.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `pending_request` The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.\n * `request_history` History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.\n * `status` The current status of the authorization in its lifecycle.\n * `token` [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.\n * `transactions` List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.\n * `treasury` [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).\n * `verification_data` \n * `wallet` The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.\n" + @typedoc "The `issuing.authorization` type.\n\n * `amount` The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.\n * `amount_details` Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `approved` Whether the authorization has been approved.\n * `authorization_method` How the card details were provided.\n * `balance_transactions` List of balance transactions associated with this authorization.\n * `card` \n * `cardholder` The cardholder to whom this authorization belongs.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `fleet` Fleet-specific information for authorizations using Fleet cards.\n * `fuel` Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `merchant_amount` The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.\n * `merchant_currency` The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `merchant_data` \n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `network_data` Details about the authorization, such as identifiers, set by the card network.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `pending_request` The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.\n * `request_history` History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.\n * `status` The current status of the authorization in its lifecycle.\n * `token` [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.\n * `transactions` List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.\n * `treasury` [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).\n * `verification_data` \n * `wallet` The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.\n" @type t :: %__MODULE__{ amount: integer, amount_details: term | nil, @@ -42,6 +44,8 @@ defmodule Stripe.Issuing.Authorization do cardholder: (binary | Stripe.Issuing.Cardholder.t()) | nil, created: integer, currency: binary, + fleet: term | nil, + fuel: term | nil, id: binary, livemode: boolean, merchant_amount: integer, @@ -77,6 +81,17 @@ defmodule Stripe.Issuing.Authorization do } ) + ( + @typedoc "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry." + @type cardholder_prompt_data :: %{ + optional(:driver_id) => binary, + optional(:odometer) => integer, + optional(:unspecified_id) => binary, + optional(:user_id) => binary, + optional(:vehicle_number) => binary + } + ) + ( @typedoc nil @type created :: %{ @@ -87,6 +102,17 @@ defmodule Stripe.Issuing.Authorization do } ) + ( + @typedoc "Fleet-specific information for authorizations using Fleet cards." + @type fleet :: %{ + optional(:cardholder_prompt_data) => cardholder_prompt_data, + optional(:purchase_type) => + :fuel_and_non_fuel_purchase | :fuel_purchase | :non_fuel_purchase, + optional(:reported_breakdown) => reported_breakdown, + optional(:service_type) => :full_service | :non_fuel_transaction | :self_service + } + ) + ( @typedoc "Information about the flight that was purchased with this transaction." @type flight :: %{ @@ -99,14 +125,8 @@ defmodule Stripe.Issuing.Authorization do ) ( - @typedoc "Information about fuel that was purchased with this transaction." - @type fuel :: %{ - optional(:type) => - :diesel | :other | :unleaded_plus | :unleaded_regular | :unleaded_super, - optional(:unit) => :liter | :us_gallon, - optional(:unit_cost_decimal) => binary, - optional(:volume_decimal) => binary - } + @typedoc "Breakdown of fuel portion of the purchase." + @type fuel :: %{optional(:gross_amount_decimal) => binary} ) ( @@ -428,9 +448,15 @@ defmodule Stripe.Issuing.Authorization do @type network_data :: %{optional(:acquiring_institution_id) => binary} ) + ( + @typedoc "Breakdown of non-fuel portion of the purchase." + @type non_fuel :: %{optional(:gross_amount_decimal) => binary} + ) + ( @typedoc "Additional purchase information that is optionally provided by the merchant." @type purchase_details :: %{ + optional(:fleet) => fleet, optional(:flight) => flight, optional(:fuel) => fuel, optional(:lodging) => lodging, @@ -449,6 +475,15 @@ defmodule Stripe.Issuing.Authorization do } ) + ( + @typedoc "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data." + @type reported_breakdown :: %{ + optional(:fuel) => fuel, + optional(:non_fuel) => non_fuel, + optional(:tax) => tax + } + ) + ( @typedoc nil @type segments :: %{ @@ -461,6 +496,14 @@ defmodule Stripe.Issuing.Authorization do } ) + ( + @typedoc "Information about tax included in this transaction." + @type tax :: %{ + optional(:local_amount_decimal) => binary, + optional(:national_amount_decimal) => binary + } + ) + ( @typedoc "3D Secure details." @type three_d_secure :: %{ @@ -605,8 +648,7 @@ defmodule Stripe.Issuing.Authorization do ) ( - nil - + @deprecated "Stripe has deprecated this operation" @doc "

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. \nThis method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/authorizations/{authorization}/approve`\n" ( @spec approve( @@ -653,8 +695,7 @@ defmodule Stripe.Issuing.Authorization do ) ( - nil - + @deprecated "Stripe has deprecated this operation" @doc "

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.\nThis method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/authorizations/{authorization}/decline`\n" ( @spec decline( @@ -713,6 +754,8 @@ defmodule Stripe.Issuing.Authorization do optional(:card) => binary, optional(:currency) => binary, optional(:expand) => list(binary), + optional(:fleet) => fleet, + optional(:fuel) => fuel, optional(:is_amount_controllable) => boolean, optional(:merchant_data) => merchant_data, optional(:network_data) => network_data, @@ -744,24 +787,25 @@ defmodule Stripe.Issuing.Authorization do ( nil - @doc "

Increment a test-mode Authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/increment`\n" + @doc "

Capture a test-mode authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/capture`\n" ( - @spec increment( + @spec capture( authorization :: binary(), params :: %{ + optional(:capture_amount) => integer, + optional(:close_authorization) => boolean, optional(:expand) => list(binary), - optional(:increment_amount) => integer, - optional(:is_amount_controllable) => boolean + optional(:purchase_details) => purchase_details }, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Authorization.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def increment(authorization, params \\ %{}, opts \\ []) do + def capture(authorization, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/authorizations/{authorization}/increment", + "/v1/test_helpers/issuing/authorizations/{authorization}/capture", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -792,20 +836,20 @@ defmodule Stripe.Issuing.Authorization do ( nil - @doc "

Reverse a test-mode Authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/reverse`\n" + @doc "

Expire a test-mode Authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/expire`\n" ( - @spec reverse( + @spec expire( authorization :: binary(), - params :: %{optional(:expand) => list(binary), optional(:reverse_amount) => integer}, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Authorization.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def reverse(authorization, params \\ %{}, opts \\ []) do + def expire(authorization, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/authorizations/{authorization}/reverse", + "/v1/test_helpers/issuing/authorizations/{authorization}/expire", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -836,20 +880,25 @@ defmodule Stripe.Issuing.Authorization do ( nil - @doc "

Expire a test-mode Authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/expire`\n" + @doc "

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount`\n" ( - @spec expire( + @spec finalize_amount( authorization :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:final_amount) => integer, + optional(:fleet) => fleet, + optional(:fuel) => fuel + }, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Authorization.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def expire(authorization, params \\ %{}, opts \\ []) do + def finalize_amount(authorization, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/authorizations/{authorization}/expire", + "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -880,25 +929,68 @@ defmodule Stripe.Issuing.Authorization do ( nil - @doc "

Capture a test-mode authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/capture`\n" + @doc "

Increment a test-mode Authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/increment`\n" ( - @spec capture( + @spec increment( authorization :: binary(), params :: %{ - optional(:capture_amount) => integer, - optional(:close_authorization) => boolean, optional(:expand) => list(binary), - optional(:purchase_details) => purchase_details + optional(:increment_amount) => integer, + optional(:is_amount_controllable) => boolean }, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Authorization.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def capture(authorization, params \\ %{}, opts \\ []) do + def increment(authorization, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/authorizations/{authorization}/capture", + "/v1/test_helpers/issuing/authorizations/{authorization}/increment", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "authorization", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "authorization", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [authorization] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Reverse a test-mode Authorization.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/authorizations/{authorization}/reverse`\n" + ( + @spec reverse( + authorization :: binary(), + params :: %{optional(:expand) => list(binary), optional(:reverse_amount) => integer}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.Authorization.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def reverse(authorization, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/test_helpers/issuing/authorizations/{authorization}/reverse", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -925,4 +1017,4 @@ defmodule Stripe.Issuing.Authorization do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/issuing__card.ex b/lib/generated/issuing__card.ex index c53f0b98..93eb9680 100644 --- a/lib/generated/issuing__card.ex +++ b/lib/generated/issuing__card.ex @@ -19,6 +19,7 @@ defmodule Stripe.Issuing.Card do :metadata, :number, :object, + :personalization_design, :replaced_by, :replacement_for, :replacement_reason, @@ -29,7 +30,7 @@ defmodule Stripe.Issuing.Card do :wallets ] - @typedoc "The `issuing.card` type.\n\n * `brand` The brand of the card.\n * `cancellation_reason` The reason why the card was canceled.\n * `cardholder` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.\n * `cvc` The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.\n * `exp_month` The expiration month of the card.\n * `exp_year` The expiration year of the card.\n * `financial_account` The financial account this card is attached to.\n * `id` Unique identifier for the object.\n * `last4` The last 4 digits of the card number.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `number` The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `replaced_by` The latest card that replaces this card, if any.\n * `replacement_for` The card this card replaces, if any.\n * `replacement_reason` The reason why the previous card needed to be replaced.\n * `shipping` Where and how the card will be shipped.\n * `spending_controls` \n * `status` Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.\n * `type` The type of the card.\n * `wallets` Information relating to digital wallets (like Apple Pay and Google Pay).\n" + @typedoc "The `issuing.card` type.\n\n * `brand` The brand of the card.\n * `cancellation_reason` The reason why the card was canceled.\n * `cardholder` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.\n * `cvc` The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.\n * `exp_month` The expiration month of the card.\n * `exp_year` The expiration year of the card.\n * `financial_account` The financial account this card is attached to.\n * `id` Unique identifier for the object.\n * `last4` The last 4 digits of the card number.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `number` The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `personalization_design` The personalization design object belonging to this card.\n * `replaced_by` The latest card that replaces this card, if any.\n * `replacement_for` The card this card replaces, if any.\n * `replacement_reason` The reason why the previous card needed to be replaced.\n * `shipping` Where and how the card will be shipped.\n * `spending_controls` \n * `status` Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.\n * `type` The type of the card.\n * `wallets` Information relating to digital wallets (like Apple Pay and Google Pay).\n" @type t :: %__MODULE__{ brand: binary, cancellation_reason: binary | nil, @@ -46,6 +47,7 @@ defmodule Stripe.Issuing.Card do metadata: term, number: binary, object: binary, + personalization_design: (binary | Stripe.Issuing.PersonalizationDesign.t()) | nil, replaced_by: (binary | Stripe.Issuing.Card.t()) | nil, replacement_for: (binary | Stripe.Issuing.Card.t()) | nil, replacement_reason: binary | nil, @@ -69,6 +71,13 @@ defmodule Stripe.Issuing.Card do } ) + ( + @typedoc "Address validation settings." + @type address_validation :: %{ + optional(:mode) => :disabled | :normalization_only | :validation_and_normalization + } + ) + ( @typedoc nil @type created :: %{ @@ -85,7 +94,7 @@ defmodule Stripe.Issuing.Card do ) ( - @typedoc "The desired new PIN for this card." + @typedoc "The desired PIN for this card." @type pin :: %{optional(:encrypted_number) => binary} ) @@ -93,6 +102,7 @@ defmodule Stripe.Issuing.Card do @typedoc "The address where the card will be shipped." @type shipping :: %{ optional(:address) => address, + optional(:address_validation) => address_validation, optional(:customs) => customs, optional(:name) => binary, optional(:phone_number) => binary, @@ -403,6 +413,7 @@ defmodule Stripe.Issuing.Card do | :womens_ready_to_wear_stores | :wrecking_and_salvage_yards ), + optional(:allowed_merchant_countries) => list(binary), optional(:blocked_categories) => list( :ac_refrigeration_repair @@ -701,6 +712,7 @@ defmodule Stripe.Issuing.Card do | :womens_ready_to_wear_stores | :wrecking_and_salvage_yards ), + optional(:blocked_merchant_countries) => list(binary), optional(:spending_limits) => list(spending_limits) } ) @@ -1027,6 +1039,7 @@ defmodule Stripe.Issuing.Card do optional(:expand) => list(binary), optional(:last4) => binary, optional(:limit) => integer, + optional(:personalization_design) => binary, optional(:starting_after) => binary, optional(:status) => :active | :canceled | :inactive, optional(:type) => :physical | :virtual @@ -1048,40 +1061,6 @@ defmodule Stripe.Issuing.Card do ) ) - ( - nil - - @doc "

Creates an Issuing Card object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/cards`\n" - ( - @spec create( - params :: %{ - optional(:cardholder) => binary, - optional(:currency) => binary, - optional(:expand) => list(binary), - optional(:financial_account) => binary, - optional(:metadata) => %{optional(binary) => binary}, - optional(:replacement_for) => binary, - optional(:replacement_reason) => :damaged | :expired | :lost | :stolen, - optional(:shipping) => shipping, - optional(:spending_controls) => spending_controls, - optional(:status) => :active | :inactive, - optional(:type) => :physical | :virtual - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Issuing.Card.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/cards", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -1124,6 +1103,43 @@ defmodule Stripe.Issuing.Card do ) ) + ( + nil + + @doc "

Creates an Issuing Card object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/cards`\n" + ( + @spec create( + params :: %{ + optional(:cardholder) => binary, + optional(:currency) => binary, + optional(:expand) => list(binary), + optional(:financial_account) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:personalization_design) => binary, + optional(:pin) => pin, + optional(:replacement_for) => binary, + optional(:replacement_reason) => :damaged | :expired | :lost | :stolen, + optional(:second_line) => binary | binary, + optional(:shipping) => shipping, + optional(:spending_controls) => spending_controls, + optional(:status) => :active | :inactive, + optional(:type) => :physical | :virtual + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.Card.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/cards", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -1135,7 +1151,9 @@ defmodule Stripe.Issuing.Card do optional(:cancellation_reason) => :lost | :stolen, optional(:expand) => list(binary), optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:personalization_design) => binary, optional(:pin) => pin, + optional(:shipping) => shipping, optional(:spending_controls) => spending_controls, optional(:status) => :active | :canceled | :inactive }, @@ -1218,18 +1236,18 @@ defmodule Stripe.Issuing.Card do ( nil - @doc "

Updates the shipping status of the specified Issuing Card object to shipped.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/cards/{card}/shipping/ship`\n" + @doc "

Updates the shipping status of the specified Issuing Card object to failure.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/cards/{card}/shipping/fail`\n" ( - @spec ship_card( + @spec fail_card( card :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Card.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def ship_card(card, params \\ %{}, opts \\ []) do + def fail_card(card, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/cards/{card}/shipping/ship", + "/v1/test_helpers/issuing/cards/{card}/shipping/fail", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1302,18 +1320,18 @@ defmodule Stripe.Issuing.Card do ( nil - @doc "

Updates the shipping status of the specified Issuing Card object to failure.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/cards/{card}/shipping/fail`\n" + @doc "

Updates the shipping status of the specified Issuing Card object to shipped.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/cards/{card}/shipping/ship`\n" ( - @spec fail_card( + @spec ship_card( card :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Card.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def fail_card(card, params \\ %{}, opts \\ []) do + def ship_card(card, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/cards/{card}/shipping/fail", + "/v1/test_helpers/issuing/cards/{card}/shipping/ship", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1340,4 +1358,4 @@ defmodule Stripe.Issuing.Card do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/issuing__cardholder.ex b/lib/generated/issuing__cardholder.ex index 77fb2079..08b912c3 100644 --- a/lib/generated/issuing__cardholder.ex +++ b/lib/generated/issuing__cardholder.ex @@ -406,6 +406,7 @@ defmodule Stripe.Issuing.Cardholder do | :womens_ready_to_wear_stores | :wrecking_and_salvage_yards ), + optional(:allowed_merchant_countries) => list(binary), optional(:blocked_categories) => list( :ac_refrigeration_repair @@ -704,6 +705,7 @@ defmodule Stripe.Issuing.Cardholder do | :womens_ready_to_wear_stores | :wrecking_and_salvage_yards ), + optional(:blocked_merchant_countries) => list(binary), optional(:spending_limits) => list(spending_limits), optional(:spending_limits_currency) => binary } @@ -1064,43 +1066,6 @@ defmodule Stripe.Issuing.Cardholder do ) ) - ( - nil - - @doc "

Creates a new Issuing Cardholder object that can be issued cards.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/cardholders`\n" - ( - @spec create( - params :: %{ - optional(:billing) => billing, - optional(:company) => company, - optional(:email) => binary, - optional(:expand) => list(binary), - optional(:individual) => individual, - optional(:metadata) => %{optional(binary) => binary}, - optional(:name) => binary, - optional(:phone_number) => binary, - optional(:preferred_locales) => list(:de | :en | :es | :fr | :it), - optional(:spending_controls) => spending_controls, - optional(:status) => :active | :inactive, - optional(:type) => :company | :individual - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Issuing.Cardholder.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/cardholders", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -1145,6 +1110,43 @@ defmodule Stripe.Issuing.Cardholder do ) ) + ( + nil + + @doc "

Creates a new Issuing Cardholder object that can be issued cards.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/cardholders`\n" + ( + @spec create( + params :: %{ + optional(:billing) => billing, + optional(:company) => company, + optional(:email) => binary, + optional(:expand) => list(binary), + optional(:individual) => individual, + optional(:metadata) => %{optional(binary) => binary}, + optional(:name) => binary, + optional(:phone_number) => binary, + optional(:preferred_locales) => list(:de | :en | :es | :fr | :it), + optional(:spending_controls) => spending_controls, + optional(:status) => :active | :inactive, + optional(:type) => :company | :individual + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.Cardholder.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/cardholders", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -1199,4 +1201,4 @@ defmodule Stripe.Issuing.Cardholder do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/issuing__dispute.ex b/lib/generated/issuing__dispute.ex index 07a4b3b6..abd70a93 100644 --- a/lib/generated/issuing__dispute.ex +++ b/lib/generated/issuing__dispute.ex @@ -11,6 +11,7 @@ defmodule Stripe.Issuing.Dispute do :evidence, :id, :livemode, + :loss_reason, :metadata, :object, :status, @@ -18,7 +19,7 @@ defmodule Stripe.Issuing.Dispute do :treasury ] - @typedoc "The `issuing.dispute` type.\n\n * `amount` Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).\n * `balance_transactions` List of balance transactions associated with the dispute.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` The currency the `transaction` was made in.\n * `evidence` \n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` Current status of the dispute.\n * `transaction` The transaction being disputed.\n * `treasury` [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts\n" + @typedoc "The `issuing.dispute` type.\n\n * `amount` Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).\n * `balance_transactions` List of balance transactions associated with the dispute.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` The currency the `transaction` was made in.\n * `evidence` \n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `loss_reason` The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` Current status of the dispute.\n * `transaction` The transaction being disputed.\n * `treasury` [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts\n" @type t :: %__MODULE__{ amount: integer, balance_transactions: term | nil, @@ -27,6 +28,7 @@ defmodule Stripe.Issuing.Dispute do evidence: term, id: binary, livemode: boolean, + loss_reason: binary, metadata: term, object: binary, status: binary, @@ -80,6 +82,7 @@ defmodule Stripe.Issuing.Dispute do optional(:duplicate) => duplicate | binary, optional(:fraudulent) => fraudulent | binary, optional(:merchandise_not_as_described) => merchandise_not_as_described | binary, + optional(:no_valid_authorization) => no_valid_authorization | binary, optional(:not_received) => not_received | binary, optional(:other) => other | binary, optional(:reason) => @@ -87,6 +90,7 @@ defmodule Stripe.Issuing.Dispute do | :duplicate | :fraudulent | :merchandise_not_as_described + | :no_valid_authorization | :not_received | :other | :service_not_as_described, @@ -114,6 +118,14 @@ defmodule Stripe.Issuing.Dispute do } ) + ( + @typedoc nil + @type no_valid_authorization :: %{ + optional(:additional_documentation) => binary | binary, + optional(:explanation) => binary | binary + } + ) + ( @typedoc nil @type not_received :: %{ @@ -186,29 +198,42 @@ defmodule Stripe.Issuing.Dispute do ( nil - @doc "

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/disputes`\n" + @doc "

Retrieves an Issuing Dispute object.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/disputes/{dispute}`\n" ( - @spec create( - params :: %{ - optional(:amount) => integer, - optional(:evidence) => evidence, - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:transaction) => binary, - optional(:treasury) => treasury - }, + @spec retrieve( + dispute :: binary(), + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Dispute.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/disputes", [], []) + def retrieve(dispute, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/issuing/disputes/{dispute}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "dispute", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "dispute", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [dispute] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -217,42 +242,24 @@ defmodule Stripe.Issuing.Dispute do ( nil - @doc "

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/disputes/{dispute}`\n" + @doc "

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/disputes`\n" ( - @spec update( - dispute :: binary(), + @spec create( params :: %{ optional(:amount) => integer, optional(:evidence) => evidence, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary + optional(:metadata) => %{optional(binary) => binary}, + optional(:transaction) => binary, + optional(:treasury) => treasury }, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Dispute.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(dispute, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/issuing/disputes/{dispute}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "dispute", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "dispute", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [dispute] - ) + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/disputes", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -266,17 +273,22 @@ defmodule Stripe.Issuing.Dispute do ( nil - @doc "

Retrieves an Issuing Dispute object.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/disputes/{dispute}`\n" + @doc "

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/disputes/{dispute}`\n" ( - @spec retrieve( + @spec update( dispute :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:amount) => integer, + optional(:evidence) => evidence, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary + }, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Dispute.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(dispute, params \\ %{}, opts \\ []) do + def update(dispute, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/issuing/disputes/{dispute}", @@ -301,7 +313,7 @@ defmodule Stripe.Issuing.Dispute do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -353,4 +365,4 @@ defmodule Stripe.Issuing.Dispute do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/issuing__personalization_design.ex b/lib/generated/issuing__personalization_design.ex new file mode 100644 index 00000000..33c49c96 --- /dev/null +++ b/lib/generated/issuing__personalization_design.ex @@ -0,0 +1,385 @@ +defmodule Stripe.Issuing.PersonalizationDesign do + use Stripe.Entity + + @moduledoc "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line." + ( + defstruct [ + :card_logo, + :carrier_text, + :created, + :id, + :livemode, + :lookup_key, + :metadata, + :name, + :object, + :physical_bundle, + :preferences, + :rejection_reasons, + :status + ] + + @typedoc "The `issuing.personalization_design` type.\n\n * `card_logo` The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.\n * `carrier_text` Hash containing carrier text, for use with physical bundles that support carrier text.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `lookup_key` A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` Friendly display name.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `physical_bundle` The physical bundle object belonging to this personalization design.\n * `preferences` \n * `rejection_reasons` \n * `status` Whether this personalization design can be used to create cards.\n" + @type t :: %__MODULE__{ + card_logo: (binary | Stripe.File.t()) | nil, + carrier_text: term | nil, + created: integer, + id: binary, + livemode: boolean, + lookup_key: binary | nil, + metadata: term, + name: binary | nil, + object: binary, + physical_bundle: binary | Stripe.Issuing.PhysicalBundle.t(), + preferences: term, + rejection_reasons: term, + status: binary + } + ) + + ( + @typedoc "Hash containing carrier text, for use with physical bundles that support carrier text." + @type carrier_text :: %{ + optional(:footer_body) => binary | binary, + optional(:footer_title) => binary | binary, + optional(:header_body) => binary | binary, + optional(:header_title) => binary | binary + } + ) + + ( + @typedoc nil + @type preferences :: %{ + optional(:is_default) => boolean, + optional(:is_platform_default) => boolean + } + ) + + ( + @typedoc "The reason(s) the personalization design was rejected." + @type rejection_reasons :: %{ + optional(:card_logo) => + list( + :geographic_location + | :inappropriate + | :network_name + | :non_binary_image + | :non_fiat_currency + | :other + | :other_entity + | :promotional_material + ), + optional(:carrier_text) => + list( + :geographic_location + | :inappropriate + | :network_name + | :non_fiat_currency + | :other + | :other_entity + | :promotional_material + ) + } + ) + + ( + nil + + @doc "

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/personalization_designs`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:lookup_keys) => list(binary), + optional(:preferences) => preferences, + optional(:starting_after) => binary, + optional(:status) => :active | :inactive | :rejected | :review + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Issuing.PersonalizationDesign.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params("/v1/issuing/personalization_designs", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves a personalization design object.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/personalization_designs/{personalization_design}`\n" + ( + @spec retrieve( + personalization_design :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.PersonalizationDesign.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def retrieve(personalization_design, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/issuing/personalization_designs/{personalization_design}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "personalization_design", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "personalization_design", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [personalization_design] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a personalization design object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/personalization_designs`\n" + ( + @spec create( + params :: %{ + optional(:card_logo) => binary, + optional(:carrier_text) => carrier_text, + optional(:expand) => list(binary), + optional(:lookup_key) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:name) => binary, + optional(:physical_bundle) => binary, + optional(:preferences) => preferences, + optional(:transfer_lookup_key) => boolean + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.PersonalizationDesign.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params("/v1/issuing/personalization_designs", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates a card personalization object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/issuing/personalization_designs/{personalization_design}`\n" + ( + @spec update( + personalization_design :: binary(), + params :: %{ + optional(:card_logo) => binary | binary, + optional(:carrier_text) => carrier_text | binary, + optional(:expand) => list(binary), + optional(:lookup_key) => binary | binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:name) => binary | binary, + optional(:physical_bundle) => binary, + optional(:preferences) => preferences, + optional(:transfer_lookup_key) => boolean + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.PersonalizationDesign.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def update(personalization_design, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/issuing/personalization_designs/{personalization_design}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "personalization_design", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "personalization_design", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [personalization_design] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates the status of the specified testmode personalization design object to active.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate`\n" + ( + @spec activate( + personalization_design :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.PersonalizationDesign.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def activate(personalization_design, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "personalization_design", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "personalization_design", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [personalization_design] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates the status of the specified testmode personalization design object to inactive.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate`\n" + ( + @spec deactivate( + personalization_design :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.PersonalizationDesign.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def deactivate(personalization_design, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "personalization_design", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "personalization_design", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [personalization_design] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates the status of the specified testmode personalization design object to rejected.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject`\n" + ( + @spec reject( + personalization_design :: binary(), + params :: %{ + optional(:expand) => list(binary), + optional(:rejection_reasons) => rejection_reasons + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.PersonalizationDesign.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def reject(personalization_design, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "personalization_design", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "personalization_design", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [personalization_design] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/issuing__physical_bundle.ex b/lib/generated/issuing__physical_bundle.ex new file mode 100644 index 00000000..6980728e --- /dev/null +++ b/lib/generated/issuing__physical_bundle.ex @@ -0,0 +1,94 @@ +defmodule Stripe.Issuing.PhysicalBundle do + use Stripe.Entity + + @moduledoc "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card." + ( + defstruct [:features, :id, :livemode, :name, :object, :status, :type] + + @typedoc "The `issuing.physical_bundle` type.\n\n * `features` \n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `name` Friendly display name.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` Whether this physical bundle can be used to create cards.\n * `type` Whether this physical bundle is a standard Stripe offering or custom-made for you.\n" + @type t :: %__MODULE__{ + features: term, + id: binary, + livemode: boolean, + name: binary, + object: binary, + status: binary, + type: binary + } + ) + + ( + nil + + @doc "

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/physical_bundles`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :active | :inactive | :review, + optional(:type) => :custom | :standard + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Issuing.PhysicalBundle.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/issuing/physical_bundles", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves a physical bundle object.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/issuing/physical_bundles/{physical_bundle}`\n" + ( + @spec retrieve( + physical_bundle :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Issuing.PhysicalBundle.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def retrieve(physical_bundle, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/issuing/physical_bundles/{physical_bundle}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "physical_bundle", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "physical_bundle", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [physical_bundle] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/issuing__token.ex b/lib/generated/issuing__token.ex index 27593c3e..0a974608 100644 --- a/lib/generated/issuing__token.ex +++ b/lib/generated/issuing__token.ex @@ -18,7 +18,7 @@ defmodule Stripe.Issuing.Token do :wallet_provider ] - @typedoc "The `issuing.token` type.\n\n * `card` Card associated with this token.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `device_fingerprint` The hashed ID derived from the device ID from the card network associated with the token\n * `id` Unique identifier for the object.\n * `last4` The last four digits of the token.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `network` The token service provider / card network associated with the token.\n * `network_data` \n * `network_updated_at` Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The usage state of the token.\n * `wallet_provider` The digital wallet for this token, if one was used.\n" + @typedoc "The `issuing.token` type.\n\n * `card` Card associated with this token.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `device_fingerprint` The hashed ID derived from the device ID from the card network associated with the token.\n * `id` Unique identifier for the object.\n * `last4` The last four digits of the token.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `network` The token service provider / card network associated with the token.\n * `network_data` \n * `network_updated_at` Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The usage state of the token.\n * `wallet_provider` The digital wallet for this token, if one was used.\n" @type t :: %__MODULE__{ card: binary | Stripe.Issuing.Card.t(), created: integer, @@ -163,4 +163,4 @@ defmodule Stripe.Issuing.Token do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/issuing__transaction.ex b/lib/generated/issuing__transaction.ex index 45fb26c3..888d8e82 100644 --- a/lib/generated/issuing__transaction.ex +++ b/lib/generated/issuing__transaction.ex @@ -55,6 +55,17 @@ defmodule Stripe.Issuing.Transaction do } ) + ( + @typedoc "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry." + @type cardholder_prompt_data :: %{ + optional(:driver_id) => binary, + optional(:odometer) => integer, + optional(:unspecified_id) => binary, + optional(:user_id) => binary, + optional(:vehicle_number) => binary + } + ) + ( @typedoc nil @type created :: %{ @@ -65,6 +76,17 @@ defmodule Stripe.Issuing.Transaction do } ) + ( + @typedoc "Fleet-specific information for transactions using Fleet cards." + @type fleet :: %{ + optional(:cardholder_prompt_data) => cardholder_prompt_data, + optional(:purchase_type) => + :fuel_and_non_fuel_purchase | :fuel_purchase | :non_fuel_purchase, + optional(:reported_breakdown) => reported_breakdown, + optional(:service_type) => :full_service | :non_fuel_transaction | :self_service + } + ) + ( @typedoc "Information about the flight that was purchased with this transaction." @type flight :: %{ @@ -77,14 +99,8 @@ defmodule Stripe.Issuing.Transaction do ) ( - @typedoc "Information about fuel that was purchased with this transaction." - @type fuel :: %{ - optional(:type) => - :diesel | :other | :unleaded_plus | :unleaded_regular | :unleaded_super, - optional(:unit) => :liter | :us_gallon, - optional(:unit_cost_decimal) => binary, - optional(:volume_decimal) => binary - } + @typedoc "Breakdown of fuel portion of the purchase." + @type fuel :: %{optional(:gross_amount_decimal) => binary} ) ( @@ -401,9 +417,15 @@ defmodule Stripe.Issuing.Transaction do } ) + ( + @typedoc "Breakdown of non-fuel portion of the purchase." + @type non_fuel :: %{optional(:gross_amount_decimal) => binary} + ) + ( @typedoc "Additional purchase information that is optionally provided by the merchant." @type purchase_details :: %{ + optional(:fleet) => fleet, optional(:flight) => flight, optional(:fuel) => fuel, optional(:lodging) => lodging, @@ -422,6 +444,15 @@ defmodule Stripe.Issuing.Transaction do } ) + ( + @typedoc "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data." + @type reported_breakdown :: %{ + optional(:fuel) => fuel, + optional(:non_fuel) => non_fuel, + optional(:tax) => tax + } + ) + ( @typedoc nil @type segments :: %{ @@ -434,6 +465,14 @@ defmodule Stripe.Issuing.Transaction do } ) + ( + @typedoc "Information about tax included in this transaction." + @type tax :: %{ + optional(:local_amount_decimal) => binary, + optional(:national_amount_decimal) => binary + } + ) + ( nil @@ -561,28 +600,36 @@ defmodule Stripe.Issuing.Transaction do ( nil - @doc "

Allows the user to capture an arbitrary amount, also known as a forced capture.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/transactions/create_force_capture`\n" + @doc "

Refund a test-mode Transaction.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/transactions/{transaction}/refund`\n" ( - @spec create_force_capture( - params :: %{ - optional(:amount) => integer, - optional(:card) => binary, - optional(:currency) => binary, - optional(:expand) => list(binary), - optional(:merchant_data) => merchant_data, - optional(:purchase_details) => purchase_details - }, + @spec refund( + transaction :: binary(), + params :: %{optional(:expand) => list(binary), optional(:refund_amount) => integer}, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Transaction.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create_force_capture(params \\ %{}, opts \\ []) do + def refund(transaction, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/transactions/create_force_capture", - [], - [] + "/v1/test_helpers/issuing/transactions/{transaction}/refund", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "transaction", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "transaction", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [transaction] ) Stripe.Request.new_request(opts) @@ -597,9 +644,9 @@ defmodule Stripe.Issuing.Transaction do ( nil - @doc "

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/transactions/create_unlinked_refund`\n" + @doc "

Allows the user to capture an arbitrary amount, also known as a forced capture.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/transactions/create_force_capture`\n" ( - @spec create_unlinked_refund( + @spec create_force_capture( params :: %{ optional(:amount) => integer, optional(:card) => binary, @@ -613,10 +660,10 @@ defmodule Stripe.Issuing.Transaction do {:ok, Stripe.Issuing.Transaction.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create_unlinked_refund(params \\ %{}, opts \\ []) do + def create_force_capture(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/transactions/create_unlinked_refund", + "/v1/test_helpers/issuing/transactions/create_force_capture", [], [] ) @@ -633,36 +680,28 @@ defmodule Stripe.Issuing.Transaction do ( nil - @doc "

Refund a test-mode Transaction.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/transactions/{transaction}/refund`\n" + @doc "

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/issuing/transactions/create_unlinked_refund`\n" ( - @spec refund( - transaction :: binary(), - params :: %{optional(:expand) => list(binary), optional(:refund_amount) => integer}, + @spec create_unlinked_refund( + params :: %{ + optional(:amount) => integer, + optional(:card) => binary, + optional(:currency) => binary, + optional(:expand) => list(binary), + optional(:merchant_data) => merchant_data, + optional(:purchase_details) => purchase_details + }, opts :: Keyword.t() ) :: {:ok, Stripe.Issuing.Transaction.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def refund(transaction, params \\ %{}, opts \\ []) do + def create_unlinked_refund(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/issuing/transactions/{transaction}/refund", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "transaction", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "transaction", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [transaction] + "/v1/test_helpers/issuing/transactions/create_unlinked_refund", + [], + [] ) Stripe.Request.new_request(opts) @@ -673,4 +712,4 @@ defmodule Stripe.Issuing.Transaction do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/item.ex b/lib/generated/item.ex index 115ca6f5..2d473e44 100644 --- a/lib/generated/item.ex +++ b/lib/generated/item.ex @@ -33,4 +33,4 @@ defmodule Stripe.Item do taxes: term } ) -end +end \ No newline at end of file diff --git a/lib/generated/line_item.ex b/lib/generated/line_item.ex index 23cf21d8..f7bd1294 100644 --- a/lib/generated/line_item.ex +++ b/lib/generated/line_item.ex @@ -1,6 +1,7 @@ defmodule Stripe.LineItem do use Stripe.Entity - @moduledoc "" + + @moduledoc "Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items)." ( defstruct [ :amount, @@ -11,6 +12,7 @@ defmodule Stripe.LineItem do :discountable, :discounts, :id, + :invoice, :invoice_item, :livemode, :metadata, @@ -29,7 +31,7 @@ defmodule Stripe.LineItem do :unit_amount_excluding_tax ] - @typedoc "The `line_item` type.\n\n * `amount` The amount, in cents (or local equivalent).\n * `amount_excluding_tax` The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `discount_amounts` The amount of discount calculated per discount for this line item.\n * `discountable` If true, discounts will apply to this line item. Always false for prorations.\n * `discounts` The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.\n * `id` Unique identifier for the object.\n * `invoice_item` The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `period` \n * `plan` The plan of the subscription, if the line item is a subscription or a proration.\n * `price` The price of the line item.\n * `proration` Whether this is a proration.\n * `proration_details` Additional details for proration line items\n * `quantity` The quantity of the subscription, if the line item is a subscription or a proration.\n * `subscription` The subscription that the invoice item pertains to, if any.\n * `subscription_item` The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.\n * `tax_amounts` The amount of tax calculated per tax rate for this line item\n * `tax_rates` The tax rates which apply to the line item.\n * `type` A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.\n * `unit_amount_excluding_tax` The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.\n" + @typedoc "The `line_item` type.\n\n * `amount` The amount, in cents (or local equivalent).\n * `amount_excluding_tax` The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `discount_amounts` The amount of discount calculated per discount for this line item.\n * `discountable` If true, discounts will apply to this line item. Always false for prorations.\n * `discounts` The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.\n * `id` Unique identifier for the object.\n * `invoice` The ID of the invoice that contains this line item.\n * `invoice_item` The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `period` \n * `plan` The plan of the subscription, if the line item is a subscription or a proration.\n * `price` The price of the line item.\n * `proration` Whether this is a proration.\n * `proration_details` Additional details for proration line items\n * `quantity` The quantity of the subscription, if the line item is a subscription or a proration.\n * `subscription` The subscription that the invoice item pertains to, if any.\n * `subscription_item` The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.\n * `tax_amounts` The amount of tax calculated per tax rate for this line item\n * `tax_rates` The tax rates which apply to the line item.\n * `type` A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.\n * `unit_amount_excluding_tax` The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.\n" @type t :: %__MODULE__{ amount: integer, amount_excluding_tax: integer | nil, @@ -37,8 +39,9 @@ defmodule Stripe.LineItem do description: binary | nil, discount_amounts: term | nil, discountable: boolean, - discounts: term | nil, + discounts: term, id: binary, + invoice: binary | nil, invoice_item: binary | Stripe.Invoiceitem.t(), livemode: boolean, metadata: term, @@ -60,7 +63,11 @@ defmodule Stripe.LineItem do ( @typedoc nil - @type discounts :: %{optional(:coupon) => binary, optional(:discount) => binary} + @type discounts :: %{ + optional(:coupon) => binary, + optional(:discount) => binary, + optional(:promotion_code) => binary + } ) ( @@ -69,7 +76,7 @@ defmodule Stripe.LineItem do ) ( - @typedoc "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline." + @typedoc "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required." @type price_data :: %{ optional(:currency) => binary, optional(:product) => binary, @@ -122,7 +129,6 @@ defmodule Stripe.LineItem do | :qst | :rst | :sales_tax - | :service_tax | :vat } ) @@ -243,4 +249,4 @@ defmodule Stripe.LineItem do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/login_link.ex b/lib/generated/login_link.ex index dedb786e..becfc2a4 100644 --- a/lib/generated/login_link.ex +++ b/lib/generated/login_link.ex @@ -1,7 +1,7 @@ defmodule Stripe.LoginLink do use Stripe.Entity - @moduledoc "Login Links are single-use login link for an Express account to access their Stripe dashboard." + @moduledoc "Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard." ( defstruct [:created, :object, :url] @@ -12,7 +12,7 @@ defmodule Stripe.LoginLink do ( nil - @doc "

Creates a single-use login link for an Express account to access their Stripe dashboard.

\n\n

You may only create login links for Express accounts connected to your platform.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/login_links`\n" + @doc "

Creates a single-use login link for a connected account to access the Express Dashboard.

\n\n

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/accounts/{account}/login_links`\n" ( @spec create( account :: binary(), @@ -49,4 +49,4 @@ defmodule Stripe.LoginLink do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/mandate.ex b/lib/generated/mandate.ex index 870a0f5a..8d6c0470 100644 --- a/lib/generated/mandate.ex +++ b/lib/generated/mandate.ex @@ -73,4 +73,4 @@ defmodule Stripe.Mandate do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/payment_intent.ex b/lib/generated/payment_intent.ex index fa72a35f..80967b25 100644 --- a/lib/generated/payment_intent.ex +++ b/lib/generated/payment_intent.ex @@ -4,49 +4,49 @@ defmodule Stripe.PaymentIntent do @moduledoc "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)" ( defstruct [ + :canceled_at, :shipping, - :id, - :transfer_data, - :statement_descriptor_suffix, - :application_fee_amount, + :livemode, + :customer, + :statement_descriptor, + :amount_capturable, + :capture_method, + :receipt_email, + :processing, :amount_details, - :transfer_group, - :status, - :payment_method_configuration_details, - :cancellation_reason, + :payment_method, :created, - :currency, - :canceled_at, - :last_payment_error, + :transfer_data, :source, - :object, - :receipt_email, - :client_secret, :application, :latest_charge, - :statement_descriptor, - :automatic_payment_methods, + :statement_descriptor_suffix, :invoice, - :amount, - :customer, + :status, + :description, + :id, + :application_fee_amount, + :payment_method_options, + :currency, + :object, :on_behalf_of, + :cancellation_reason, + :client_secret, + :payment_method_types, + :automatic_payment_methods, :next_action, - :confirmation_method, + :transfer_group, + :amount_received, :review, - :amount_capturable, - :payment_method_types, - :description, + :amount, :metadata, - :amount_received, - :payment_method_options, - :capture_method, - :processing, - :livemode, - :payment_method, - :setup_future_usage + :setup_future_usage, + :last_payment_error, + :payment_method_configuration_details, + :confirmation_method ] - @typedoc "The `payment_intent` type.\n\n * `amount` Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).\n * `amount_capturable` Amount that can be captured from this PaymentIntent.\n * `amount_details` \n * `amount_received` Amount that this PaymentIntent collects.\n * `application` ID of the Connect application that created the PaymentIntent.\n * `application_fee_amount` The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).\n * `automatic_payment_methods` Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)\n * `canceled_at` Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.\n * `cancellation_reason` Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).\n * `capture_method` Controls when the funds will be captured from the customer's account.\n * `client_secret` The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.\n * `confirmation_method` Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `id` Unique identifier for the object.\n * `invoice` ID of the invoice that created this PaymentIntent, if it exists.\n * `last_payment_error` The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.\n * `latest_charge` The latest charge created by this PaymentIntent.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).\n * `next_action` If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.\n * `payment_method` ID of the payment method used in this PaymentIntent.\n * `payment_method_configuration_details` Information about the payment method configuration used for this PaymentIntent.\n * `payment_method_options` Payment-method-specific configuration for this PaymentIntent.\n * `payment_method_types` The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.\n * `processing` If present, this property tells you about the processing state of the payment.\n * `receipt_email` Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).\n * `review` ID of the review associated with this PaymentIntent, if any.\n * `setup_future_usage` Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n * `shipping` Shipping information for this PaymentIntent.\n * `source` This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.\n * `statement_descriptor` For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.\n * `statement_descriptor_suffix` Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.\n * `status` Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).\n * `transfer_data` 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).\n * `transfer_group` A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).\n" + @typedoc "The `payment_intent` type.\n\n * `amount` Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).\n * `amount_capturable` Amount that can be captured from this PaymentIntent.\n * `amount_details` \n * `amount_received` Amount that this PaymentIntent collects.\n * `application` ID of the Connect application that created the PaymentIntent.\n * `application_fee_amount` The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).\n * `automatic_payment_methods` Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)\n * `canceled_at` Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.\n * `cancellation_reason` Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).\n * `capture_method` Controls when the funds will be captured from the customer's account.\n * `client_secret` The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.\n * `confirmation_method` Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `id` Unique identifier for the object.\n * `invoice` ID of the invoice that created this PaymentIntent, if it exists.\n * `last_payment_error` The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.\n * `latest_charge` ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).\n * `next_action` If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.\n * `payment_method` ID of the payment method used in this PaymentIntent.\n * `payment_method_configuration_details` Information about the payment method configuration used for this PaymentIntent.\n * `payment_method_options` Payment-method-specific configuration for this PaymentIntent.\n * `payment_method_types` The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.\n * `processing` If present, this property tells you about the processing state of the payment.\n * `receipt_email` Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).\n * `review` ID of the review associated with this PaymentIntent, if any.\n * `setup_future_usage` Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n * `shipping` Shipping information for this PaymentIntent.\n * `source` This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.\n * `statement_descriptor` Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.\n * `statement_descriptor_suffix` Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.\n * `status` Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).\n * `transfer_data` 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).\n * `transfer_group` A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).\n" @type t :: %__MODULE__{ amount: integer, amount_capturable: integer, @@ -137,7 +137,15 @@ defmodule Stripe.PaymentIntent do ( @typedoc nil - @type au_becs_debit :: %{optional(:setup_future_usage) => :none | :off_session | :on_session} + @type amazon_pay :: %{ + optional(:capture_method) => :manual, + optional(:setup_future_usage) => :none | :off_session + } + ) + + ( + @typedoc "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account." + @type au_becs_debit :: %{optional(:account_number) => binary, optional(:bsb_number) => binary} ) ( @@ -188,15 +196,12 @@ defmodule Stripe.PaymentIntent do ( @typedoc nil - @type blik :: %{optional(:code) => binary} + @type blik :: %{optional(:code) => binary, optional(:setup_future_usage) => :none} ) ( - @typedoc nil - @type boleto :: %{ - optional(:expires_after_days) => integer, - optional(:setup_future_usage) => :none | :off_session | :on_session - } + @typedoc "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method." + @type boleto :: %{optional(:tax_id) => binary} ) ( @@ -213,6 +218,7 @@ defmodule Stripe.PaymentIntent do | :diners | :discover | :eftpos_au + | :girocard | :interac | :jcb | :mastercard @@ -224,6 +230,7 @@ defmodule Stripe.PaymentIntent do optional(:request_multicapture) => :if_available | :never, optional(:request_overcapture) => :if_available | :never, optional(:request_three_d_secure) => :any | :automatic | :challenge, + optional(:require_cvc_recollection) => boolean, optional(:setup_future_usage) => :none | :off_session | :on_session, optional(:statement_descriptor_suffix_kana) => binary | binary, optional(:statement_descriptor_suffix_kanji) => binary | binary, @@ -235,7 +242,8 @@ defmodule Stripe.PaymentIntent do @typedoc nil @type card_present :: %{ optional(:request_extended_authorization) => boolean, - optional(:request_incremental_authorization_support) => boolean + optional(:request_incremental_authorization_support) => boolean, + optional(:routing) => routing } ) @@ -304,12 +312,18 @@ defmodule Stripe.PaymentIntent do @type eu_bank_transfer :: %{optional(:country) => binary} ) + ( + @typedoc "Provide filters for the linked accounts that the customer can select for the payment method" + @type filters :: %{optional(:account_subcategories) => list(:checking | :savings)} + ) + ( @typedoc "Additional fields for Financial Connections Session creation" @type financial_connections :: %{ + optional(:filters) => filters, optional(:permissions) => list(:balances | :ownership | :payment_method | :transactions), - optional(:prefetch) => list(:balances | :transactions), + optional(:prefetch) => list(:balances | :ownership | :transactions), optional(:return_url) => binary } ) @@ -341,6 +355,7 @@ defmodule Stripe.PaymentIntent do | :knab | :moneyou | :n26 + | :nn | :rabobank | :regiobank | :revolut @@ -387,6 +402,7 @@ defmodule Stripe.PaymentIntent do | :"en-NZ" | :"en-PL" | :"en-PT" + | :"en-RO" | :"en-SE" | :"en-US" | :"es-ES" @@ -403,6 +419,7 @@ defmodule Stripe.PaymentIntent do | :"nl-NL" | :"pl-PL" | :"pt-PT" + | :"ro-RO" | :"sv-FI" | :"sv-SE", optional(:setup_future_usage) => :none @@ -449,6 +466,19 @@ defmodule Stripe.PaymentIntent do } ) + ( + @typedoc nil + @type mobilepay :: %{ + optional(:capture_method) => :manual, + optional(:setup_future_usage) => :none + } + ) + + ( + @typedoc nil + @type multibanco :: %{optional(:setup_future_usage) => :none} + ) + ( @typedoc "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly" @type network_options :: %{optional(:cartes_bancaires) => cartes_bancaires} @@ -483,38 +513,45 @@ defmodule Stripe.PaymentIntent do ( @typedoc "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent." @type payment_method_data :: %{ - optional(:pix) => map(), - optional(:fpx) => fpx, - optional(:affirm) => map(), - optional(:acss_debit) => acss_debit, - optional(:bacs_debit) => bacs_debit, + optional(:sofort) => sofort, + optional(:customer_balance) => map(), + optional(:boleto) => boleto, optional(:alipay) => map(), - optional(:giropay) => map(), + optional(:au_becs_debit) => au_becs_debit, + optional(:amazon_pay) => map(), + optional(:metadata) => %{optional(binary) => binary}, + optional(:bancontact) => map(), + optional(:interac_present) => map(), + optional(:bacs_debit) => bacs_debit, + optional(:affirm) => map(), + optional(:billing_details) => billing_details, + optional(:mobilepay) => map(), + optional(:grabpay) => map(), + optional(:eps) => eps, optional(:ideal) => ideal, + optional(:pix) => map(), + optional(:giropay) => map(), + optional(:multibanco) => map(), optional(:revolut_pay) => map(), - optional(:radar_options) => radar_options, - optional(:metadata) => %{optional(binary) => binary}, + optional(:klarna) => klarna, + optional(:twint) => map(), + optional(:acss_debit) => acss_debit, optional(:link) => map(), - optional(:promptpay) => map(), - optional(:cashapp) => map(), - optional(:oxxo) => map(), - optional(:interac_present) => map(), - optional(:us_bank_account) => us_bank_account, - optional(:zip) => map(), - optional(:paypal) => map(), - optional(:boleto) => boleto, optional(:konbini) => map(), - optional(:billing_details) => billing_details, optional(:blik) => map(), - optional(:wechat_pay) => map(), - optional(:sofort) => sofort, optional(:p24) => p24, - optional(:afterpay_clearpay) => map(), + optional(:paypal) => map(), + optional(:fpx) => fpx, + optional(:oxxo) => map(), + optional(:paynow) => map(), + optional(:wechat_pay) => map(), + optional(:promptpay) => map(), optional(:type) => :acss_debit | :affirm | :afterpay_clearpay | :alipay + | :amazon_pay | :au_becs_debit | :bacs_debit | :bancontact @@ -530,6 +567,8 @@ defmodule Stripe.PaymentIntent do | :klarna | :konbini | :link + | :mobilepay + | :multibanco | :oxxo | :p24 | :paynow @@ -539,57 +578,64 @@ defmodule Stripe.PaymentIntent do | :revolut_pay | :sepa_debit | :sofort + | :swish + | :twint | :us_bank_account | :wechat_pay | :zip, - optional(:grabpay) => map(), - optional(:bancontact) => map(), - optional(:au_becs_debit) => au_becs_debit, - optional(:customer_balance) => map(), + optional(:radar_options) => radar_options, + optional(:cashapp) => map(), optional(:sepa_debit) => sepa_debit, - optional(:klarna) => klarna, - optional(:paynow) => map(), - optional(:eps) => eps + optional(:afterpay_clearpay) => map(), + optional(:allow_redisplay) => :always | :limited | :unspecified, + optional(:us_bank_account) => us_bank_account, + optional(:swish) => map(), + optional(:zip) => map() } ) ( @typedoc "Payment method-specific configuration for this PaymentIntent." @type payment_method_options :: %{ - optional(:pix) => pix | binary, - optional(:fpx) => fpx | binary, - optional(:affirm) => affirm | binary, - optional(:acss_debit) => acss_debit | binary, - optional(:bacs_debit) => bacs_debit | binary, + optional(:sofort) => sofort | binary, + optional(:customer_balance) => customer_balance | binary, + optional(:boleto) => boleto | binary, optional(:alipay) => alipay | binary, - optional(:giropay) => giropay | binary, + optional(:au_becs_debit) => au_becs_debit | binary, + optional(:amazon_pay) => amazon_pay | binary, + optional(:card_present) => card_present | binary, + optional(:bancontact) => bancontact | binary, + optional(:interac_present) => map() | binary, + optional(:bacs_debit) => bacs_debit | binary, + optional(:affirm) => affirm | binary, + optional(:mobilepay) => mobilepay | binary, + optional(:grabpay) => grabpay | binary, + optional(:eps) => eps | binary, optional(:ideal) => ideal | binary, + optional(:pix) => pix | binary, + optional(:giropay) => giropay | binary, + optional(:multibanco) => multibanco | binary, optional(:revolut_pay) => revolut_pay | binary, + optional(:klarna) => klarna | binary, optional(:card) => card | binary, + optional(:twint) => twint | binary, + optional(:acss_debit) => acss_debit | binary, optional(:link) => link | binary, - optional(:promptpay) => promptpay | binary, - optional(:cashapp) => cashapp | binary, - optional(:oxxo) => oxxo | binary, - optional(:interac_present) => map() | binary, - optional(:us_bank_account) => us_bank_account | binary, - optional(:zip) => zip | binary, - optional(:paypal) => paypal | binary, - optional(:boleto) => boleto | binary, optional(:konbini) => konbini | binary, optional(:blik) => blik | binary, - optional(:wechat_pay) => wechat_pay | binary, - optional(:sofort) => sofort | binary, optional(:p24) => p24 | binary, - optional(:afterpay_clearpay) => afterpay_clearpay | binary, - optional(:grabpay) => grabpay | binary, - optional(:bancontact) => bancontact | binary, - optional(:au_becs_debit) => au_becs_debit | binary, - optional(:customer_balance) => customer_balance | binary, - optional(:card_present) => card_present | binary, - optional(:sepa_debit) => sepa_debit | binary, - optional(:klarna) => klarna | binary, + optional(:paypal) => paypal | binary, + optional(:fpx) => fpx | binary, + optional(:oxxo) => oxxo | binary, optional(:paynow) => paynow | binary, - optional(:eps) => eps | binary + optional(:wechat_pay) => wechat_pay | binary, + optional(:promptpay) => promptpay | binary, + optional(:cashapp) => cashapp | binary, + optional(:sepa_debit) => sepa_debit | binary, + optional(:afterpay_clearpay) => afterpay_clearpay | binary, + optional(:us_bank_account) => us_bank_account | binary, + optional(:swish) => swish | binary, + optional(:zip) => zip | binary } ) @@ -654,13 +700,21 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information." + @typedoc "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session)." @type radar_options :: %{optional(:session) => binary} ) ( @typedoc nil - @type revolut_pay :: %{optional(:setup_future_usage) => :none | :off_session} + @type revolut_pay :: %{ + optional(:capture_method) => :manual, + optional(:setup_future_usage) => :none | :off_session + } + ) + + ( + @typedoc "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes." + @type routing :: %{optional(:requested_priority) => :domestic | :international} ) ( @@ -680,8 +734,19 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method." - @type sofort :: %{optional(:country) => :AT | :BE | :DE | :ES | :IT | :NL} + @typedoc nil + @type sofort :: %{ + optional(:preferred_language) => :de | :en | :es | :fr | :it | :nl | :pl, + optional(:setup_future_usage) => :none | :off_session + } + ) + + ( + @typedoc nil + @type swish :: %{ + optional(:reference) => binary | binary, + optional(:setup_future_usage) => :none + } ) ( @@ -703,6 +768,11 @@ defmodule Stripe.PaymentIntent do @type transfer_data :: %{optional(:amount) => integer, optional(:destination) => binary} ) + ( + @typedoc nil + @type twint :: %{optional(:setup_future_usage) => :none} + ) + ( @typedoc "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method." @type us_bank_account :: %{ @@ -728,6 +798,79 @@ defmodule Stripe.PaymentIntent do @type zip :: %{optional(:setup_future_usage) => :none} ) + ( + nil + + @doc "

Returns a list of PaymentIntents.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_intents`\n" + ( + @spec list( + params :: %{ + optional(:created) => created | integer, + optional(:customer) => binary, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.PaymentIntent.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_intents", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves the details of a PaymentIntent that has previously been created.

\n\n

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

\n\n

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_intents/{intent}`\n" + ( + @spec retrieve( + intent :: binary(), + params :: %{optional(:client_secret) => binary, optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.PaymentIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(intent, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/payment_intents/{intent}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "intent", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "intent", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [intent] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -770,6 +913,7 @@ defmodule Stripe.PaymentIntent do optional(:capture_method) => :automatic | :automatic_async | :manual, optional(:confirm) => boolean, optional(:confirmation_method) => :automatic | :manual, + optional(:confirmation_token) => binary, optional(:currency) => binary, optional(:customer) => binary, optional(:description) => binary, @@ -811,79 +955,6 @@ defmodule Stripe.PaymentIntent do ) ) - ( - nil - - @doc "

Returns a list of PaymentIntents.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_intents`\n" - ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:customer) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.PaymentIntent.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_intents", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Retrieves the details of a PaymentIntent that has previously been created.

\n\n

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

\n\n

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_intents/{intent}`\n" - ( - @spec retrieve( - intent :: binary(), - params :: %{optional(:client_secret) => binary, optional(:expand) => list(binary)}, - opts :: Keyword.t() - ) :: - {:ok, Stripe.PaymentIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(intent, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/payment_intents/{intent}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "intent", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "intent", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [intent] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -950,34 +1021,22 @@ defmodule Stripe.PaymentIntent do ( nil - @doc "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt. Read the expanded documentation\nto learn more about manual confirmation.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/confirm`\n" + @doc "

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/apply_customer_balance`\n" ( - @spec confirm( + @spec apply_customer_balance( intent :: binary(), params :: %{ - optional(:capture_method) => :automatic | :automatic_async | :manual, - optional(:error_on_requires_action) => boolean, - optional(:expand) => list(binary), - optional(:mandate) => binary, - optional(:mandate_data) => mandate_data | binary | mandate_data, - optional(:off_session) => boolean | :one_off | :recurring, - optional(:payment_method) => binary, - optional(:payment_method_data) => payment_method_data, - optional(:payment_method_options) => payment_method_options, - optional(:radar_options) => radar_options, - optional(:receipt_email) => binary | binary, - optional(:return_url) => binary, - optional(:setup_future_usage) => :off_session | :on_session, - optional(:shipping) => shipping | binary, - optional(:use_stripe_sdk) => boolean + optional(:amount) => integer, + optional(:currency) => binary, + optional(:expand) => list(binary) }, opts :: Keyword.t() ) :: {:ok, Stripe.PaymentIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def confirm(intent, params \\ %{}, opts \\ []) do + def apply_customer_balance(intent, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/payment_intents/{intent}/confirm", + "/v1/payment_intents/{intent}/apply_customer_balance", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1105,26 +1164,36 @@ defmodule Stripe.PaymentIntent do ( nil - @doc "

Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.

\n\n

Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.

\n\n

If the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.

\n\n

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.

\n\n

Learn more about incremental authorizations.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/increment_authorization`\n" + @doc "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.\nThere is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/confirm`\n" ( - @spec increment_authorization( + @spec confirm( intent :: binary(), params :: %{ - optional(:amount) => integer, - optional(:application_fee_amount) => integer, - optional(:description) => binary, + optional(:capture_method) => :automatic | :automatic_async | :manual, + optional(:confirmation_token) => binary, + optional(:error_on_requires_action) => boolean, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:statement_descriptor) => binary, - optional(:transfer_data) => transfer_data + optional(:mandate) => binary, + optional(:mandate_data) => mandate_data | binary | mandate_data, + optional(:off_session) => boolean | :one_off | :recurring, + optional(:payment_method) => binary, + optional(:payment_method_data) => payment_method_data, + optional(:payment_method_options) => payment_method_options, + optional(:payment_method_types) => list(binary), + optional(:radar_options) => radar_options, + optional(:receipt_email) => binary | binary, + optional(:return_url) => binary, + optional(:setup_future_usage) => :off_session | :on_session, + optional(:shipping) => shipping | binary, + optional(:use_stripe_sdk) => boolean }, opts :: Keyword.t() ) :: {:ok, Stripe.PaymentIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def increment_authorization(intent, params \\ %{}, opts \\ []) do + def confirm(intent, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/payment_intents/{intent}/increment_authorization", + "/v1/payment_intents/{intent}/confirm", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1155,22 +1224,26 @@ defmodule Stripe.PaymentIntent do ( nil - @doc "

Verifies microdeposits on a PaymentIntent object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/verify_microdeposits`\n" + @doc "

Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.

\n\n

Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.

\n\n

If the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.

\n\n

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.

\n\n

Learn more about incremental authorizations.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/increment_authorization`\n" ( - @spec verify_microdeposits( + @spec increment_authorization( intent :: binary(), params :: %{ - optional(:amounts) => list(integer), - optional(:descriptor_code) => binary, - optional(:expand) => list(binary) + optional(:amount) => integer, + optional(:application_fee_amount) => integer, + optional(:description) => binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary}, + optional(:statement_descriptor) => binary, + optional(:transfer_data) => transfer_data }, opts :: Keyword.t() ) :: {:ok, Stripe.PaymentIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def verify_microdeposits(intent, params \\ %{}, opts \\ []) do + def increment_authorization(intent, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/payment_intents/{intent}/verify_microdeposits", + "/v1/payment_intents/{intent}/increment_authorization", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1201,22 +1274,22 @@ defmodule Stripe.PaymentIntent do ( nil - @doc "

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/apply_customer_balance`\n" + @doc "

Verifies microdeposits on a PaymentIntent object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_intents/{intent}/verify_microdeposits`\n" ( - @spec apply_customer_balance( + @spec verify_microdeposits( intent :: binary(), params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, + optional(:amounts) => list(integer), + optional(:descriptor_code) => binary, optional(:expand) => list(binary) }, opts :: Keyword.t() ) :: {:ok, Stripe.PaymentIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def apply_customer_balance(intent, params \\ %{}, opts \\ []) do + def verify_microdeposits(intent, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/payment_intents/{intent}/apply_customer_balance", + "/v1/payment_intents/{intent}/verify_microdeposits", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -1243,4 +1316,4 @@ defmodule Stripe.PaymentIntent do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/payment_link.ex b/lib/generated/payment_link.ex index ee573196..8959001b 100644 --- a/lib/generated/payment_link.ex +++ b/lib/generated/payment_link.ex @@ -4,42 +4,42 @@ defmodule Stripe.PaymentLink do @moduledoc "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payment-links)" ( defstruct [ - :shipping_options, - :restrictions, - :id, + :line_items, + :allow_promotion_codes, + :consent_collection, + :livemode, + :billing_address_collection, + :subscription_data, :transfer_data, + :application, + :inactive_message, + :customer_creation, + :id, + :automatic_tax, + :restrictions, + :phone_number_collection, + :invoice_creation, :application_fee_amount, - :payment_intent_data, - :billing_address_collection, - :allow_promotion_codes, - :url, - :payment_method_collection, :currency, - :tax_id_collection, - :automatic_tax, + :url, :object, - :application, - :after_completion, - :custom_text, - :submit_type, - :invoice_creation, + :payment_method_collection, :on_behalf_of, - :phone_number_collection, - :inactive_message, - :consent_collection, - :shipping_address_collection, :payment_method_types, + :tax_id_collection, + :payment_intent_data, + :shipping_options, + :after_completion, :active, - :subscription_data, - :metadata, - :customer_creation, :custom_fields, - :line_items, - :livemode, + :metadata, + :custom_text, + :shipping_address_collection, + :submit_type, :application_fee_percent ] - @typedoc "The `payment_link` type.\n\n * `active` Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.\n * `after_completion` \n * `allow_promotion_codes` Whether user redeemable promotion codes are enabled.\n * `application` The ID of the Connect application that created the Payment Link.\n * `application_fee_amount` The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.\n * `application_fee_percent` This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.\n * `automatic_tax` \n * `billing_address_collection` Configuration for collecting the customer's billing address.\n * `consent_collection` When set, provides configuration to gather active consent from customers.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `custom_fields` Collect additional information from your customer using custom fields. Up to 2 fields are supported.\n * `custom_text` \n * `customer_creation` Configuration for Customer creation during checkout.\n * `id` Unique identifier for the object.\n * `inactive_message` The custom message to be displayed to a customer when a payment link is no longer active.\n * `invoice_creation` Configuration for creating invoice for payment mode payment links.\n * `line_items` The line items representing what is being sold.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.\n * `payment_intent_data` Indicates the parameters to be passed to PaymentIntent creation during checkout.\n * `payment_method_collection` Configuration for collecting a payment method during checkout.\n * `payment_method_types` The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).\n * `phone_number_collection` \n * `restrictions` Settings that restrict the usage of a payment link.\n * `shipping_address_collection` Configuration for collecting the customer's shipping address.\n * `shipping_options` The shipping rate options applied to the session.\n * `submit_type` Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.\n * `subscription_data` When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.\n * `tax_id_collection` \n * `transfer_data` The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.\n * `url` The public URL that can be shared with customers.\n" + @typedoc "The `payment_link` type.\n\n * `active` Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.\n * `after_completion` \n * `allow_promotion_codes` Whether user redeemable promotion codes are enabled.\n * `application` The ID of the Connect application that created the Payment Link.\n * `application_fee_amount` The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.\n * `application_fee_percent` This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.\n * `automatic_tax` \n * `billing_address_collection` Configuration for collecting the customer's billing address. Defaults to `auto`.\n * `consent_collection` When set, provides configuration to gather active consent from customers.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `custom_fields` Collect additional information from your customer using custom fields. Up to 3 fields are supported.\n * `custom_text` \n * `customer_creation` Configuration for Customer creation during checkout.\n * `id` Unique identifier for the object.\n * `inactive_message` The custom message to be displayed to a customer when a payment link is no longer active.\n * `invoice_creation` Configuration for creating invoice for payment mode payment links.\n * `line_items` The line items representing what is being sold.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.\n * `payment_intent_data` Indicates the parameters to be passed to PaymentIntent creation during checkout.\n * `payment_method_collection` Configuration for collecting a payment method during checkout. Defaults to `always`.\n * `payment_method_types` The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).\n * `phone_number_collection` \n * `restrictions` Settings that restrict the usage of a payment link.\n * `shipping_address_collection` Configuration for collecting the customer's shipping address.\n * `shipping_options` The shipping rate options applied to the session.\n * `submit_type` Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.\n * `subscription_data` When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.\n * `tax_id_collection` \n * `transfer_data` The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.\n * `url` The public URL that can be shared with customers.\n" @type t :: %__MODULE__{ active: boolean, after_completion: term, @@ -102,7 +102,7 @@ defmodule Stripe.PaymentLink do ( @typedoc "Configuration for automatic tax collection." - @type automatic_tax :: %{optional(:enabled) => boolean} + @type automatic_tax :: %{optional(:enabled) => boolean, optional(:liability) => liability} ) ( @@ -121,15 +121,7 @@ defmodule Stripe.PaymentLink do ( @typedoc nil - @type custom_fields :: %{ - optional(:dropdown) => dropdown, - optional(:key) => binary, - optional(:label) => label, - optional(:numeric) => numeric, - optional(:optional) => boolean, - optional(:text) => text, - optional(:type) => :dropdown | :numeric | :text - } + @type custom_fields :: %{optional(:name) => binary, optional(:value) => binary} ) ( @@ -174,16 +166,32 @@ defmodule Stripe.PaymentLink do optional(:custom_fields) => list(custom_fields) | binary, optional(:description) => binary, optional(:footer) => binary, + optional(:issuer) => issuer, optional(:metadata) => %{optional(binary) => binary} | binary, optional(:rendering_options) => rendering_options | binary } ) + ( + @typedoc "All invoices will be billed using the specified settings." + @type invoice_settings :: %{optional(:issuer) => issuer} + ) + + ( + @typedoc "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account." + @type issuer :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + ( @typedoc "The label for the field, displayed to the customer." @type label :: %{optional(:custom) => binary, optional(:type) => :custom} ) + ( + @typedoc "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." + @type liability :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + ( @typedoc nil @type line_items :: %{ @@ -508,6 +516,7 @@ defmodule Stripe.PaymentLink do @typedoc "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`." @type subscription_data :: %{ optional(:description) => binary, + optional(:invoice_settings) => invoice_settings, optional(:metadata) => %{optional(binary) => binary}, optional(:trial_period_days) => integer, optional(:trial_settings) => trial_settings @@ -705,6 +714,8 @@ defmodule Stripe.PaymentLink do | :klarna | :konbini | :link + | :mobilepay + | :multibanco | :oxxo | :p24 | :paynow @@ -713,8 +724,11 @@ defmodule Stripe.PaymentLink do | :promptpay | :sepa_debit | :sofort + | :swish + | :twint | :us_bank_account | :wechat_pay + | :zip ), optional(:phone_number_collection) => phone_number_collection, optional(:restrictions) => restrictions, @@ -782,6 +796,8 @@ defmodule Stripe.PaymentLink do | :klarna | :konbini | :link + | :mobilepay + | :multibanco | :oxxo | :p24 | :paynow @@ -790,13 +806,17 @@ defmodule Stripe.PaymentLink do | :promptpay | :sepa_debit | :sofort + | :swish + | :twint | :us_bank_account | :wechat_pay + | :zip ) | binary, optional(:restrictions) => restrictions | binary, optional(:shipping_address_collection) => shipping_address_collection | binary, - optional(:subscription_data) => subscription_data + optional(:subscription_data) => subscription_data, + optional(:tax_id_collection) => tax_id_collection }, opts :: Keyword.t() ) :: {:ok, Stripe.PaymentLink.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} @@ -830,4 +850,4 @@ defmodule Stripe.PaymentLink do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/payment_method.ex b/lib/generated/payment_method.ex index 42991cc7..2a365b5f 100644 --- a/lib/generated/payment_method.ex +++ b/lib/generated/payment_method.ex @@ -4,57 +4,65 @@ defmodule Stripe.PaymentMethod do @moduledoc "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios)." ( defstruct [ - :eps, - :id, - :paynow, - :klarna, + :zip, + :swish, + :us_bank_account, + :allow_redisplay, + :afterpay_clearpay, :sepa_debit, - :card_present, - :customer_balance, - :au_becs_debit, - :bancontact, - :grabpay, + :cashapp, + :radar_options, + :livemode, + :customer, :type, - :afterpay_clearpay, + :promptpay, + :wechat_pay, + :paynow, + :oxxo, :created, + :fpx, + :paypal, :p24, - :sofort, - :wechat_pay, :blik, - :billing_details, :konbini, - :object, - :boleto, - :paypal, - :zip, - :us_bank_account, - :customer, - :interac_present, - :oxxo, - :cashapp, - :promptpay, :link, - :metadata, - :radar_options, + :acss_debit, + :id, + :twint, :card, + :klarna, :revolut_pay, - :ideal, + :multibanco, :giropay, - :alipay, - :bacs_debit, - :acss_debit, - :livemode, + :object, + :pix, + :ideal, + :eps, + :grabpay, + :mobilepay, + :billing_details, :affirm, - :fpx, - :pix + :bacs_debit, + :interac_present, + :bancontact, + :card_present, + :metadata, + :amazon_pay, + :au_becs_debit, + :alipay, + :boleto, + :customer_balance, + :sofort ] - @typedoc "The `payment_method` type.\n\n * `acss_debit` \n * `affirm` \n * `afterpay_clearpay` \n * `alipay` \n * `au_becs_debit` \n * `bacs_debit` \n * `bancontact` \n * `billing_details` \n * `blik` \n * `boleto` \n * `card` \n * `card_present` \n * `cashapp` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.\n * `customer_balance` \n * `eps` \n * `fpx` \n * `giropay` \n * `grabpay` \n * `id` Unique identifier for the object.\n * `ideal` \n * `interac_present` \n * `klarna` \n * `konbini` \n * `link` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `oxxo` \n * `p24` \n * `paynow` \n * `paypal` \n * `pix` \n * `promptpay` \n * `radar_options` \n * `revolut_pay` \n * `sepa_debit` \n * `sofort` \n * `type` The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.\n * `us_bank_account` \n * `wechat_pay` \n * `zip` \n" + @typedoc "The `payment_method` type.\n\n * `acss_debit` \n * `affirm` \n * `afterpay_clearpay` \n * `alipay` \n * `allow_redisplay` This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.\n * `amazon_pay` \n * `au_becs_debit` \n * `bacs_debit` \n * `bancontact` \n * `billing_details` \n * `blik` \n * `boleto` \n * `card` \n * `card_present` \n * `cashapp` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.\n * `customer_balance` \n * `eps` \n * `fpx` \n * `giropay` \n * `grabpay` \n * `id` Unique identifier for the object.\n * `ideal` \n * `interac_present` \n * `klarna` \n * `konbini` \n * `link` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `mobilepay` \n * `multibanco` \n * `object` String representing the object's type. Objects of the same type share the same value.\n * `oxxo` \n * `p24` \n * `paynow` \n * `paypal` \n * `pix` \n * `promptpay` \n * `radar_options` \n * `revolut_pay` \n * `sepa_debit` \n * `sofort` \n * `swish` \n * `twint` \n * `type` The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.\n * `us_bank_account` \n * `wechat_pay` \n * `zip` \n" @type t :: %__MODULE__{ acss_debit: term, affirm: term, afterpay_clearpay: term, alipay: term, + allow_redisplay: binary, + amazon_pay: term, au_becs_debit: term, bacs_debit: term, bancontact: term, @@ -79,6 +87,8 @@ defmodule Stripe.PaymentMethod do link: term, livemode: boolean, metadata: term | nil, + mobilepay: term, + multibanco: term, object: binary, oxxo: term, p24: term, @@ -90,6 +100,8 @@ defmodule Stripe.PaymentMethod do revolut_pay: term, sepa_debit: term, sofort: term, + swish: term, + twint: term, type: binary, us_bank_account: term, wechat_pay: term, @@ -149,6 +161,7 @@ defmodule Stripe.PaymentMethod do optional(:cvc) => binary, optional(:exp_month) => integer, optional(:exp_year) => integer, + optional(:networks) => networks, optional(:number) => binary } ) @@ -239,6 +252,7 @@ defmodule Stripe.PaymentMethod do | :knab | :moneyou | :n26 + | :nn | :rabobank | :regiobank | :revolut @@ -254,6 +268,11 @@ defmodule Stripe.PaymentMethod do @type klarna :: %{optional(:dob) => dob} ) + ( + @typedoc "Contains information about card networks used to process the payment." + @type networks :: %{optional(:preferred) => :cartes_bancaires | :mastercard | :visa} + ) + ( @typedoc "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method." @type p24 :: %{ @@ -282,6 +301,7 @@ defmodule Stripe.PaymentMethod do | :santander_przelew24 | :tmobile_usbugi_bankowe | :toyota_bank + | :velobank | :volkswagen_bank } ) @@ -315,46 +335,21 @@ defmodule Stripe.PaymentMethod do ( nil - @doc "

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

\n\n

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods`\n" + @doc "

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_methods`\n" ( - @spec create( + @spec list( params :: %{ - optional(:pix) => map(), - optional(:payment_method) => binary, - optional(:fpx) => fpx, - optional(:affirm) => map(), - optional(:acss_debit) => acss_debit, - optional(:bacs_debit) => bacs_debit, - optional(:alipay) => map(), - optional(:giropay) => map(), - optional(:ideal) => ideal, - optional(:revolut_pay) => map(), - optional(:expand) => list(binary), - optional(:card) => card | card, - optional(:radar_options) => radar_options, - optional(:metadata) => %{optional(binary) => binary}, - optional(:link) => map(), - optional(:promptpay) => map(), - optional(:cashapp) => map(), - optional(:oxxo) => map(), - optional(:interac_present) => map(), optional(:customer) => binary, - optional(:us_bank_account) => us_bank_account, - optional(:zip) => map(), - optional(:paypal) => map(), - optional(:boleto) => boleto, - optional(:konbini) => map(), - optional(:billing_details) => billing_details, - optional(:blik) => map(), - optional(:wechat_pay) => map(), - optional(:sofort) => sofort, - optional(:p24) => p24, - optional(:afterpay_clearpay) => map(), + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, optional(:type) => :acss_debit | :affirm | :afterpay_clearpay | :alipay + | :amazon_pay | :au_becs_debit | :bacs_debit | :bancontact @@ -371,6 +366,8 @@ defmodule Stripe.PaymentMethod do | :klarna | :konbini | :link + | :mobilepay + | :multibanco | :oxxo | :p24 | :paynow @@ -380,28 +377,24 @@ defmodule Stripe.PaymentMethod do | :revolut_pay | :sepa_debit | :sofort + | :swish + | :twint | :us_bank_account | :wechat_pay - | :zip, - optional(:grabpay) => map(), - optional(:bancontact) => map(), - optional(:au_becs_debit) => au_becs_debit, - optional(:customer_balance) => map(), - optional(:sepa_debit) => sepa_debit, - optional(:klarna) => klarna, - optional(:paynow) => map(), - optional(:eps) => eps + | :zip }, opts :: Keyword.t() ) :: - {:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + {:ok, Stripe.List.t(Stripe.PaymentMethod.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_methods", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -452,69 +445,51 @@ defmodule Stripe.PaymentMethod do ( nil - @doc "

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods/{payment_method}`\n" + @doc "

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

\n\n

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods`\n" ( - @spec update( - payment_method :: binary(), + @spec create( params :: %{ + optional(:sofort) => sofort, + optional(:customer_balance) => map(), + optional(:boleto) => boleto, + optional(:alipay) => map(), + optional(:au_becs_debit) => au_becs_debit, + optional(:amazon_pay) => map(), + optional(:metadata) => %{optional(binary) => binary}, + optional(:bancontact) => map(), + optional(:interac_present) => map(), + optional(:bacs_debit) => bacs_debit, + optional(:affirm) => map(), optional(:billing_details) => billing_details, - optional(:card) => card, - optional(:expand) => list(binary), + optional(:mobilepay) => map(), + optional(:grabpay) => map(), + optional(:eps) => eps, + optional(:ideal) => ideal, + optional(:pix) => map(), + optional(:giropay) => map(), + optional(:multibanco) => map(), + optional(:revolut_pay) => map(), + optional(:klarna) => klarna, + optional(:card) => card | card, + optional(:twint) => map(), + optional(:acss_debit) => acss_debit, optional(:link) => map(), - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:us_bank_account) => us_bank_account - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(payment_method, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/payment_methods/{payment_method}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "payment_method", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "payment_method", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [payment_method] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_methods`\n" - ( - @spec list( - params :: %{ - optional(:customer) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, + optional(:konbini) => map(), + optional(:blik) => map(), + optional(:p24) => p24, + optional(:paypal) => map(), + optional(:fpx) => fpx, + optional(:payment_method) => binary, + optional(:oxxo) => map(), + optional(:paynow) => map(), + optional(:wechat_pay) => map(), + optional(:promptpay) => map(), optional(:type) => :acss_debit | :affirm | :afterpay_clearpay | :alipay + | :amazon_pay | :au_becs_debit | :bacs_debit | :bancontact @@ -531,6 +506,8 @@ defmodule Stripe.PaymentMethod do | :klarna | :konbini | :link + | :mobilepay + | :multibanco | :oxxo | :p24 | :paynow @@ -540,22 +517,82 @@ defmodule Stripe.PaymentMethod do | :revolut_pay | :sepa_debit | :sofort + | :swish + | :twint | :us_bank_account | :wechat_pay - | :zip + | :zip, + optional(:customer) => binary, + optional(:expand) => list(binary), + optional(:radar_options) => radar_options, + optional(:cashapp) => map(), + optional(:sepa_debit) => sepa_debit, + optional(:afterpay_clearpay) => map(), + optional(:allow_redisplay) => :always | :limited | :unspecified, + optional(:us_bank_account) => us_bank_account, + optional(:swish) => map(), + optional(:zip) => map() }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.PaymentMethod.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do + {:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_methods", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods/{payment_method}`\n" + ( + @spec update( + payment_method :: binary(), + params :: %{ + optional(:allow_redisplay) => :always | :limited | :unspecified, + optional(:billing_details) => billing_details, + optional(:card) => card, + optional(:expand) => list(binary), + optional(:link) => map(), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:us_bank_account) => us_bank_account + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(payment_method, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/payment_methods/{payment_method}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "payment_method", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "payment_method", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [payment_method] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -644,4 +681,4 @@ defmodule Stripe.PaymentMethod do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/payment_method_configuration.ex b/lib/generated/payment_method_configuration.ex index e26450bb..2e3af7c5 100644 --- a/lib/generated/payment_method_configuration.ex +++ b/lib/generated/payment_method_configuration.ex @@ -4,56 +4,64 @@ defmodule Stripe.PaymentMethodConfiguration do @moduledoc "PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.\n\nThere are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):\n\n**Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.\n\n**Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.\n\nChild configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.\n\nRelated guides:\n- [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)\n- [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)\n- [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)" ( defstruct [ - :eps, - :id, - :paynow, - :klarna, - :sepa_debit, - :au_becs_debit, - :bancontact, - :parent, - :grabpay, - :cartes_bancaires, + :zip, + :swish, + :us_bank_account, :afterpay_clearpay, + :sepa_debit, + :cashapp, + :livemode, + :promptpay, + :wechat_pay, + :paynow, + :oxxo, :google_pay, + :fpx, + :paypal, + :application, + :cartes_bancaires, :p24, - :apple_pay, - :sofort, - :wechat_pay, :blik, :konbini, - :object, - :jcb, - :boleto, - :paypal, - :application, - :us_bank_account, - :oxxo, - :cashapp, - :promptpay, :link, - :active, + :acss_debit, + :is_default, + :name, + :id, + :twint, :card, + :apple_pay, + :klarna, :revolut_pay, - :ideal, + :multibanco, :giropay, - :alipay, - :is_default, - :bacs_debit, - :acss_debit, - :livemode, + :object, + :ideal, + :eps, + :grabpay, + :jcb, + :mobilepay, :affirm, - :name, - :fpx + :bacs_debit, + :bancontact, + :active, + :parent, + :amazon_pay, + :au_becs_debit, + :alipay, + :boleto, + :customer_balance, + :sofort ] - @typedoc "The `payment_method_configuration` type.\n\n * `acss_debit` \n * `active` Whether the configuration can be used for new payments.\n * `affirm` \n * `afterpay_clearpay` \n * `alipay` \n * `apple_pay` \n * `application` For child configs, the Connect application associated with the configuration.\n * `au_becs_debit` \n * `bacs_debit` \n * `bancontact` \n * `blik` \n * `boleto` \n * `card` \n * `cartes_bancaires` \n * `cashapp` \n * `eps` \n * `fpx` \n * `giropay` \n * `google_pay` \n * `grabpay` \n * `id` Unique identifier for the object.\n * `ideal` \n * `is_default` The default configuration is used whenever a payment method configuration is not specified.\n * `jcb` \n * `klarna` \n * `konbini` \n * `link` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `name` The configuration's name.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `oxxo` \n * `p24` \n * `parent` For child configs, the configuration's parent configuration.\n * `paynow` \n * `paypal` \n * `promptpay` \n * `revolut_pay` \n * `sepa_debit` \n * `sofort` \n * `us_bank_account` \n * `wechat_pay` \n" + @typedoc "The `payment_method_configuration` type.\n\n * `acss_debit` \n * `active` Whether the configuration can be used for new payments.\n * `affirm` \n * `afterpay_clearpay` \n * `alipay` \n * `amazon_pay` \n * `apple_pay` \n * `application` For child configs, the Connect application associated with the configuration.\n * `au_becs_debit` \n * `bacs_debit` \n * `bancontact` \n * `blik` \n * `boleto` \n * `card` \n * `cartes_bancaires` \n * `cashapp` \n * `customer_balance` \n * `eps` \n * `fpx` \n * `giropay` \n * `google_pay` \n * `grabpay` \n * `id` Unique identifier for the object.\n * `ideal` \n * `is_default` The default configuration is used whenever a payment method configuration is not specified.\n * `jcb` \n * `klarna` \n * `konbini` \n * `link` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `mobilepay` \n * `multibanco` \n * `name` The configuration's name.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `oxxo` \n * `p24` \n * `parent` For child configs, the configuration's parent configuration.\n * `paynow` \n * `paypal` \n * `promptpay` \n * `revolut_pay` \n * `sepa_debit` \n * `sofort` \n * `swish` \n * `twint` \n * `us_bank_account` \n * `wechat_pay` \n * `zip` \n" @type t :: %__MODULE__{ acss_debit: term, active: boolean, affirm: term, afterpay_clearpay: term, alipay: term, + amazon_pay: term, apple_pay: term, application: binary | nil, au_becs_debit: term, @@ -64,6 +72,7 @@ defmodule Stripe.PaymentMethodConfiguration do card: term, cartes_bancaires: term, cashapp: term, + customer_balance: term, eps: term, fpx: term, giropay: term, @@ -77,6 +86,8 @@ defmodule Stripe.PaymentMethodConfiguration do konbini: term, link: term, livemode: boolean, + mobilepay: term, + multibanco: term, name: binary, object: binary, oxxo: term, @@ -88,8 +99,11 @@ defmodule Stripe.PaymentMethodConfiguration do revolut_pay: term, sepa_debit: term, sofort: term, + swish: term, + twint: term, us_bank_account: term, - wechat_pay: term + wechat_pay: term, + zip: term } ) @@ -113,6 +127,11 @@ defmodule Stripe.PaymentMethodConfiguration do @type alipay :: %{optional(:display_preference) => display_preference} ) + ( + @typedoc "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon." + @type amazon_pay :: %{optional(:display_preference) => display_preference} + ) + ( @typedoc "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details." @type apple_pay :: %{optional(:display_preference) => display_preference} @@ -163,6 +182,11 @@ defmodule Stripe.PaymentMethodConfiguration do @type cashapp :: %{optional(:display_preference) => display_preference} ) + ( + @typedoc "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details." + @type customer_balance :: %{optional(:display_preference) => display_preference} + ) + ( @typedoc "Whether or not the payment method should be displayed." @type display_preference :: %{optional(:preference) => :none | :off | :on} @@ -218,6 +242,16 @@ defmodule Stripe.PaymentMethodConfiguration do @type link :: %{optional(:display_preference) => display_preference} ) + ( + @typedoc "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details." + @type mobilepay :: %{optional(:display_preference) => display_preference} + ) + + ( + @typedoc "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method." + @type multibanco :: %{optional(:display_preference) => display_preference} + ) + ( @typedoc "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details." @type oxxo :: %{optional(:display_preference) => display_preference} @@ -258,6 +292,16 @@ defmodule Stripe.PaymentMethodConfiguration do @type sofort :: %{optional(:display_preference) => display_preference} ) + ( + @typedoc "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details." + @type swish :: %{optional(:display_preference) => display_preference} + ) + + ( + @typedoc "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details." + @type twint :: %{optional(:display_preference) => display_preference} + ) + ( @typedoc "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details." @type us_bank_account :: %{optional(:display_preference) => display_preference} @@ -268,6 +312,11 @@ defmodule Stripe.PaymentMethodConfiguration do @type wechat_pay :: %{optional(:display_preference) => display_preference} ) + ( + @typedoc "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability." + @type zip :: %{optional(:display_preference) => display_preference} + ) + ( nil @@ -276,7 +325,10 @@ defmodule Stripe.PaymentMethodConfiguration do @spec list( params :: %{ optional(:application) => binary | binary, - optional(:expand) => list(binary) + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() ) :: @@ -343,75 +395,63 @@ defmodule Stripe.PaymentMethodConfiguration do ( nil - @doc "

Update payment method configuration

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_method_configurations/{configuration}`\n" + @doc "

Creates a payment method configuration

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_method_configurations`\n" ( - @spec update( - configuration :: binary(), + @spec create( params :: %{ - optional(:fpx) => fpx, - optional(:name) => binary, - optional(:affirm) => affirm, - optional(:acss_debit) => acss_debit, - optional(:bacs_debit) => bacs_debit, + optional(:sofort) => sofort, + optional(:customer_balance) => customer_balance, + optional(:boleto) => boleto, optional(:alipay) => alipay, - optional(:giropay) => giropay, + optional(:au_becs_debit) => au_becs_debit, + optional(:amazon_pay) => amazon_pay, + optional(:parent) => binary, + optional(:bancontact) => bancontact, + optional(:bacs_debit) => bacs_debit, + optional(:affirm) => affirm, + optional(:mobilepay) => mobilepay, + optional(:jcb) => jcb, + optional(:grabpay) => grabpay, + optional(:eps) => eps, optional(:ideal) => ideal, + optional(:giropay) => giropay, + optional(:multibanco) => multibanco, optional(:revolut_pay) => revolut_pay, - optional(:expand) => list(binary), + optional(:klarna) => klarna, + optional(:apple_pay) => apple_pay, optional(:card) => card, - optional(:active) => boolean, + optional(:twint) => twint, + optional(:name) => binary, + optional(:acss_debit) => acss_debit, optional(:link) => link, - optional(:promptpay) => promptpay, - optional(:cashapp) => cashapp, - optional(:oxxo) => oxxo, - optional(:us_bank_account) => us_bank_account, - optional(:paypal) => paypal, - optional(:boleto) => boleto, - optional(:jcb) => jcb, optional(:konbini) => konbini, optional(:blik) => blik, - optional(:wechat_pay) => wechat_pay, - optional(:sofort) => sofort, - optional(:apple_pay) => apple_pay, optional(:p24) => p24, - optional(:google_pay) => google_pay, - optional(:afterpay_clearpay) => afterpay_clearpay, optional(:cartes_bancaires) => cartes_bancaires, - optional(:grabpay) => grabpay, + optional(:paypal) => paypal, + optional(:fpx) => fpx, + optional(:google_pay) => google_pay, + optional(:oxxo) => oxxo, + optional(:paynow) => paynow, + optional(:wechat_pay) => wechat_pay, + optional(:promptpay) => promptpay, + optional(:expand) => list(binary), + optional(:cashapp) => cashapp, optional(:apple_pay_later) => apple_pay_later, - optional(:bancontact) => bancontact, - optional(:au_becs_debit) => au_becs_debit, optional(:sepa_debit) => sepa_debit, - optional(:klarna) => klarna, - optional(:paynow) => paynow, - optional(:eps) => eps + optional(:afterpay_clearpay) => afterpay_clearpay, + optional(:us_bank_account) => us_bank_account, + optional(:swish) => swish, + optional(:zip) => zip }, opts :: Keyword.t() ) :: {:ok, Stripe.PaymentMethodConfiguration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(configuration, params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/payment_method_configurations/{configuration}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "configuration", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "configuration", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [configuration] - ) + Stripe.OpenApi.Path.replace_path_params("/v1/payment_method_configurations", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -425,56 +465,82 @@ defmodule Stripe.PaymentMethodConfiguration do ( nil - @doc "

Creates a payment method configuration

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_method_configurations`\n" + @doc "

Update payment method configuration

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_method_configurations/{configuration}`\n" ( - @spec create( + @spec update( + configuration :: binary(), params :: %{ - optional(:fpx) => fpx, - optional(:name) => binary, - optional(:affirm) => affirm, - optional(:acss_debit) => acss_debit, - optional(:bacs_debit) => bacs_debit, + optional(:sofort) => sofort, + optional(:customer_balance) => customer_balance, + optional(:boleto) => boleto, optional(:alipay) => alipay, - optional(:giropay) => giropay, + optional(:au_becs_debit) => au_becs_debit, + optional(:amazon_pay) => amazon_pay, + optional(:active) => boolean, + optional(:bancontact) => bancontact, + optional(:bacs_debit) => bacs_debit, + optional(:affirm) => affirm, + optional(:mobilepay) => mobilepay, + optional(:jcb) => jcb, + optional(:grabpay) => grabpay, + optional(:eps) => eps, optional(:ideal) => ideal, + optional(:giropay) => giropay, + optional(:multibanco) => multibanco, optional(:revolut_pay) => revolut_pay, - optional(:expand) => list(binary), + optional(:klarna) => klarna, + optional(:apple_pay) => apple_pay, optional(:card) => card, + optional(:twint) => twint, + optional(:name) => binary, + optional(:acss_debit) => acss_debit, optional(:link) => link, - optional(:promptpay) => promptpay, - optional(:cashapp) => cashapp, - optional(:oxxo) => oxxo, - optional(:us_bank_account) => us_bank_account, - optional(:paypal) => paypal, - optional(:boleto) => boleto, - optional(:jcb) => jcb, optional(:konbini) => konbini, optional(:blik) => blik, - optional(:wechat_pay) => wechat_pay, - optional(:sofort) => sofort, - optional(:apple_pay) => apple_pay, optional(:p24) => p24, - optional(:google_pay) => google_pay, - optional(:afterpay_clearpay) => afterpay_clearpay, optional(:cartes_bancaires) => cartes_bancaires, - optional(:grabpay) => grabpay, + optional(:paypal) => paypal, + optional(:fpx) => fpx, + optional(:google_pay) => google_pay, + optional(:oxxo) => oxxo, + optional(:paynow) => paynow, + optional(:wechat_pay) => wechat_pay, + optional(:promptpay) => promptpay, + optional(:expand) => list(binary), + optional(:cashapp) => cashapp, optional(:apple_pay_later) => apple_pay_later, - optional(:parent) => binary, - optional(:bancontact) => bancontact, - optional(:au_becs_debit) => au_becs_debit, optional(:sepa_debit) => sepa_debit, - optional(:klarna) => klarna, - optional(:paynow) => paynow, - optional(:eps) => eps + optional(:afterpay_clearpay) => afterpay_clearpay, + optional(:us_bank_account) => us_bank_account, + optional(:swish) => swish, + optional(:zip) => zip }, opts :: Keyword.t() ) :: {:ok, Stripe.PaymentMethodConfiguration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def update(configuration, params \\ %{}, opts \\ []) do path = - Stripe.OpenApi.Path.replace_path_params("/v1/payment_method_configurations", [], []) + Stripe.OpenApi.Path.replace_path_params( + "/v1/payment_method_configurations/{configuration}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "configuration", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "configuration", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [configuration] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -484,4 +550,4 @@ defmodule Stripe.PaymentMethodConfiguration do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/payment_method_domain.ex b/lib/generated/payment_method_domain.ex index dc2c98d2..fd46db88 100644 --- a/lib/generated/payment_method_domain.ex +++ b/lib/generated/payment_method_domain.ex @@ -1,7 +1,7 @@ defmodule Stripe.PaymentMethodDomain do use Stripe.Entity - @moduledoc "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration)." + @moduledoc "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration)." ( defstruct [ :apple_pay, @@ -31,6 +31,37 @@ defmodule Stripe.PaymentMethodDomain do } ) + ( + nil + + @doc "

Lists the details of existing payment method domains.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_method_domains`\n" + ( + @spec list( + params :: %{ + optional(:domain_name) => binary, + optional(:enabled) => boolean, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.PaymentMethodDomain.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_method_domains", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -75,37 +106,6 @@ defmodule Stripe.PaymentMethodDomain do ) ) - ( - nil - - @doc "

Lists the details of existing payment method domains.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_method_domains`\n" - ( - @spec list( - params :: %{ - optional(:domain_name) => binary, - optional(:enabled) => boolean, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.PaymentMethodDomain.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_method_domains", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -221,4 +221,4 @@ defmodule Stripe.PaymentMethodDomain do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/payment_source.ex b/lib/generated/payment_source.ex index d8c96642..b5111788 100644 --- a/lib/generated/payment_source.ex +++ b/lib/generated/payment_source.ex @@ -159,4 +159,4 @@ defmodule Stripe.PaymentSource do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/payout.ex b/lib/generated/payout.ex index bf2acbcb..ebdd37be 100644 --- a/lib/generated/payout.ex +++ b/lib/generated/payout.ex @@ -5,6 +5,8 @@ defmodule Stripe.Payout do ( defstruct [ :amount, + :application_fee, + :application_fee_amount, :arrival_date, :automatic, :balance_transaction, @@ -29,9 +31,11 @@ defmodule Stripe.Payout do :type ] - @typedoc "The `payout` type.\n\n * `amount` The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.\n * `arrival_date` Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.\n * `automatic` Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).\n * `balance_transaction` ID of the balance transaction that describes the impact of this payout on your account balance.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination` ID of the bank account or card the payout is sent to.\n * `failure_balance_transaction` If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.\n * `failure_code` Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).\n * `failure_message` Message that provides the reason for a payout failure, if available.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `method` The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `original_payout` If the payout reverses another, this is the ID of the original payout.\n * `reconciliation_status` If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.\n * `reversed_by` If the payout reverses, this is the ID of the payout that reverses this payout.\n * `source_type` The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.\n * `statement_descriptor` Extra information about a payout that displays on the user's bank statement.\n * `status` Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.\n * `type` Can be `bank_account` or `card`.\n" + @typedoc "The `payout` type.\n\n * `amount` The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.\n * `application_fee` The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.\n * `application_fee_amount` The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.\n * `arrival_date` Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.\n * `automatic` Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).\n * `balance_transaction` ID of the balance transaction that describes the impact of this payout on your account balance.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination` ID of the bank account or card the payout is sent to.\n * `failure_balance_transaction` If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.\n * `failure_code` Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).\n * `failure_message` Message that provides the reason for a payout failure, if available.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `method` The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `original_payout` If the payout reverses another, this is the ID of the original payout.\n * `reconciliation_status` If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.\n * `reversed_by` If the payout reverses, this is the ID of the payout that reverses this payout.\n * `source_type` The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.\n * `statement_descriptor` Extra information about a payout that displays on the user's bank statement.\n * `status` Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.\n * `type` Can be `bank_account` or `card`.\n" @type t :: %__MODULE__{ amount: integer, + application_fee: (binary | Stripe.ApplicationFee.t()) | nil, + application_fee_amount: integer | nil, arrival_date: integer, automatic: boolean, balance_transaction: (binary | Stripe.BalanceTransaction.t()) | nil, @@ -78,6 +82,39 @@ defmodule Stripe.Payout do } ) + ( + nil + + @doc "

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payouts`\n" + ( + @spec list( + params :: %{ + optional(:arrival_date) => arrival_date | integer, + optional(:created) => created | integer, + optional(:destination) => binary, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Payout.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/payouts", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -119,39 +156,6 @@ defmodule Stripe.Payout do ) ) - ( - nil - - @doc "

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payouts`\n" - ( - @spec list( - params :: %{ - optional(:arrival_date) => arrival_date | integer, - optional(:created) => created | integer, - optional(:destination) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:status) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Payout.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/payouts", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -230,7 +234,7 @@ defmodule Stripe.Payout do ( nil - @doc "

You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payouts/{payout}/cancel`\n" + @doc "

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payouts/{payout}/cancel`\n" ( @spec cancel( payout :: binary(), @@ -271,7 +275,7 @@ defmodule Stripe.Payout do ( nil - @doc "

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the pending status, use /v1/payouts/:id/cancel instead.

\n\n

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payouts/{payout}/reverse`\n" + @doc "

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

\n\n

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payouts/{payout}/reverse`\n" ( @spec reverse( payout :: binary(), @@ -311,4 +315,4 @@ defmodule Stripe.Payout do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/person.ex b/lib/generated/person.ex index 807556c3..fc55ebcf 100644 --- a/lib/generated/person.ex +++ b/lib/generated/person.ex @@ -1,7 +1,7 @@ defmodule Stripe.Person do use Stripe.Entity - @moduledoc "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps.\n\nRelated guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information)" + @moduledoc "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information)." ( defstruct [ :account, @@ -88,7 +88,7 @@ defmodule Stripe.Person do ) ( - @typedoc "Details on the legal guardian's acceptance of the required Stripe agreements." + @typedoc "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements." @type additional_tos_acceptances :: %{optional(:account) => account} ) @@ -199,6 +199,56 @@ defmodule Stripe.Person do @type visa :: %{optional(:files) => list(binary | binary)} ) + ( + nil + + @doc "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}/persons/{person}`\n" + ( + @spec delete(account :: binary(), person :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedPerson.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def delete(account, person, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/accounts/{account}/persons/{person}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "account", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "account", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + }, + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "person", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "person", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [account, person] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -457,54 +507,4 @@ defmodule Stripe.Person do end ) ) - - ( - nil - - @doc "

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/accounts/{account}/persons/{person}`\n" - ( - @spec delete(account :: binary(), person :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedPerson.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(account, person, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/accounts/{account}/persons/{person}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "account", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "account", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - }, - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "person", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "person", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [account, person] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/plan.ex b/lib/generated/plan.ex index b0255626..d5d29679 100644 --- a/lib/generated/plan.ex +++ b/lib/generated/plan.ex @@ -16,6 +16,7 @@ defmodule Stripe.Plan do :interval_count, :livemode, :metadata, + :meter, :nickname, :object, :product, @@ -26,7 +27,7 @@ defmodule Stripe.Plan do :usage_type ] - @typedoc "The `plan` type.\n\n * `active` Whether the plan can be used for new purchases.\n * `aggregate_usage` Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.\n * `amount` The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.\n * `amount_decimal` The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.\n * `billing_scheme` Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `id` Unique identifier for the object.\n * `interval` The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.\n * `interval_count` The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `nickname` A brief description of the plan, hidden from customers.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `product` The product whose pricing this plan determines.\n * `tiers` Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.\n * `tiers_mode` Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.\n * `transform_usage` Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.\n * `trial_period_days` Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).\n * `usage_type` Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.\n" + @typedoc "The `plan` type.\n\n * `active` Whether the plan can be used for new purchases.\n * `aggregate_usage` Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.\n * `amount` The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.\n * `amount_decimal` The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.\n * `billing_scheme` Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `id` Unique identifier for the object.\n * `interval` The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.\n * `interval_count` The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `meter` The meter tracking the usage of a metered price\n * `nickname` A brief description of the plan, hidden from customers.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `product` The product whose pricing this plan determines.\n * `tiers` Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.\n * `tiers_mode` Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.\n * `transform_usage` Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.\n * `trial_period_days` Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).\n * `usage_type` Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.\n" @type t :: %__MODULE__{ active: boolean, aggregate_usage: binary | nil, @@ -40,6 +41,7 @@ defmodule Stripe.Plan do interval_count: integer, livemode: boolean, metadata: term | nil, + meter: binary | nil, nickname: binary | nil, object: binary, product: (binary | Stripe.Product.t() | Stripe.DeletedProduct.t()) | nil, @@ -90,6 +92,43 @@ defmodule Stripe.Plan do @type transform_usage :: %{optional(:divide_by) => integer, optional(:round) => :down | :up} ) + ( + nil + + @doc "

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/plans/{plan}`\n" + ( + @spec delete(plan :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedPlan.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def delete(plan, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/plans/{plan}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "plan", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "plan", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [plan] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -122,46 +161,6 @@ defmodule Stripe.Plan do ) ) - ( - nil - - @doc "

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/plans`\n" - ( - @spec create( - params :: %{ - optional(:active) => boolean, - optional(:aggregate_usage) => :last_during_period | :last_ever | :max | :sum, - optional(:amount) => integer, - optional(:amount_decimal) => binary, - optional(:billing_scheme) => :per_unit | :tiered, - optional(:currency) => binary, - optional(:expand) => list(binary), - optional(:id) => binary, - optional(:interval) => :day | :month | :week | :year, - optional(:interval_count) => integer, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:nickname) => binary, - optional(:product) => product | binary, - optional(:tiers) => list(tiers), - optional(:tiers_mode) => :graduated | :volume, - optional(:transform_usage) => transform_usage, - optional(:trial_period_days) => integer, - optional(:usage_type) => :licensed | :metered - }, - opts :: Keyword.t() - ) :: {:ok, Stripe.Plan.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/plans", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -206,41 +205,34 @@ defmodule Stripe.Plan do ( nil - @doc "

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/plans/{plan}`\n" + @doc "

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/plans`\n" ( - @spec update( - plan :: binary(), + @spec create( params :: %{ optional(:active) => boolean, + optional(:aggregate_usage) => :last_during_period | :last_ever | :max | :sum, + optional(:amount) => integer, + optional(:amount_decimal) => binary, + optional(:billing_scheme) => :per_unit | :tiered, + optional(:currency) => binary, optional(:expand) => list(binary), + optional(:id) => binary, + optional(:interval) => :day | :month | :week | :year, + optional(:interval_count) => integer, optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:meter) => binary, optional(:nickname) => binary, - optional(:product) => binary, - optional(:trial_period_days) => integer + optional(:product) => product | binary, + optional(:tiers) => list(tiers), + optional(:tiers_mode) => :graduated | :volume, + optional(:transform_usage) => transform_usage, + optional(:trial_period_days) => integer, + optional(:usage_type) => :licensed | :metered }, opts :: Keyword.t() ) :: {:ok, Stripe.Plan.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(plan, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/plans/{plan}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "plan", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "plan", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [plan] - ) + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/plans", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -254,11 +246,21 @@ defmodule Stripe.Plan do ( nil - @doc "

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/plans/{plan}`\n" + @doc "

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/plans/{plan}`\n" ( - @spec delete(plan :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedPlan.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(plan, opts \\ []) do + @spec update( + plan :: binary(), + params :: %{ + optional(:active) => boolean, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:nickname) => binary, + optional(:product) => binary, + optional(:trial_period_days) => integer + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Plan.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(plan, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/plans/{plan}", @@ -282,9 +284,10 @@ defmodule Stripe.Plan do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/price.ex b/lib/generated/price.ex index 80d3c1f6..b7052aa7 100644 --- a/lib/generated/price.ex +++ b/lib/generated/price.ex @@ -90,6 +90,7 @@ defmodule Stripe.Price do @typedoc nil @type recurring :: %{ optional(:interval) => :day | :month | :week | :year, + optional(:meter) => binary, optional(:usage_type) => :licensed | :metered } ) @@ -116,22 +117,29 @@ defmodule Stripe.Price do ( nil - @doc "

Search for prices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices/search`\n" + @doc "

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices`\n" ( - @spec search( + @spec list( params :: %{ + optional(:active) => boolean, + optional(:created) => created | integer, + optional(:currency) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:limit) => integer, - optional(:page) => binary, - optional(:query) => binary + optional(:lookup_keys) => list(binary), + optional(:product) => binary, + optional(:recurring) => recurring, + optional(:starting_after) => binary, + optional(:type) => :one_time | :recurring }, opts :: Keyword.t() ) :: - {:ok, Stripe.SearchResult.t(Stripe.Price.t())} + {:ok, Stripe.List.t(Stripe.Price.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def search(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/prices/search", [], []) + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/prices", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -145,29 +153,63 @@ defmodule Stripe.Price do ( nil - @doc "

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices`\n" + @doc "

Retrieves the price with the given ID.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices/{price}`\n" ( - @spec list( + @spec retrieve( + price :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: {:ok, Stripe.Price.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(price, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/prices/{price}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "price", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "price", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [price] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Search for prices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices/search`\n" + ( + @spec search( params :: %{ - optional(:active) => boolean, - optional(:created) => created | integer, - optional(:currency) => binary, - optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:limit) => integer, - optional(:lookup_keys) => list(binary), - optional(:product) => binary, - optional(:recurring) => recurring, - optional(:starting_after) => binary, - optional(:type) => :one_time | :recurring + optional(:page) => binary, + optional(:query) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Price.t())} + {:ok, Stripe.SearchResult.t(Stripe.Price.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/prices", [], []) + def search(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/prices/search", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -219,47 +261,6 @@ defmodule Stripe.Price do ) ) - ( - nil - - @doc "

Retrieves the price with the given ID.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices/{price}`\n" - ( - @spec retrieve( - price :: binary(), - params :: %{optional(:expand) => list(binary)}, - opts :: Keyword.t() - ) :: {:ok, Stripe.Price.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(price, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/prices/{price}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "price", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "price", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [price] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -309,4 +310,4 @@ defmodule Stripe.Price do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/product.ex b/lib/generated/product.ex index a489e7a4..c72373ec 100644 --- a/lib/generated/product.ex +++ b/lib/generated/product.ex @@ -8,10 +8,10 @@ defmodule Stripe.Product do :created, :default_price, :description, - :features, :id, :images, :livemode, + :marketing_features, :metadata, :name, :object, @@ -25,16 +25,16 @@ defmodule Stripe.Product do :url ] - @typedoc "The `product` type.\n\n * `active` Whether the product is currently available for purchase.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `default_price` The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.\n * `description` The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.\n * `features` A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).\n * `id` Unique identifier for the object.\n * `images` A list of up to 8 URLs of images for this product, meant to be displayable to the customer.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` The product's name, meant to be displayable to the customer.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `package_dimensions` The dimensions of this product for shipping purposes.\n * `shippable` Whether this product is shipped (i.e., physical goods).\n * `statement_descriptor` Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.\n * `tax_code` A [tax code](https://stripe.com/docs/tax/tax-categories) ID.\n * `type` The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.\n * `unit_label` A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.\n * `updated` Time at which the object was last updated. Measured in seconds since the Unix epoch.\n * `url` A URL of a publicly-accessible webpage for this product.\n" + @typedoc "The `product` type.\n\n * `active` Whether the product is currently available for purchase.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `default_price` The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.\n * `description` The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.\n * `id` Unique identifier for the object.\n * `images` A list of up to 8 URLs of images for this product, meant to be displayable to the customer.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `marketing_features` A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `name` The product's name, meant to be displayable to the customer.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `package_dimensions` The dimensions of this product for shipping purposes.\n * `shippable` Whether this product is shipped (i.e., physical goods).\n * `statement_descriptor` Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.\n * `tax_code` A [tax code](https://stripe.com/docs/tax/tax-categories) ID.\n * `type` The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.\n * `unit_label` A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.\n * `updated` Time at which the object was last updated. Measured in seconds since the Unix epoch.\n * `url` A URL of a publicly-accessible webpage for this product.\n" @type t :: %__MODULE__{ active: boolean, created: integer, default_price: (binary | Stripe.Price.t()) | nil, description: binary | nil, - features: term, id: binary, images: term, livemode: boolean, + marketing_features: term, metadata: term, name: binary, object: binary, @@ -73,7 +73,7 @@ defmodule Stripe.Product do ( @typedoc nil - @type features :: %{optional(:name) => binary} + @type marketing_features :: %{optional(:name) => binary} ) ( @@ -97,27 +97,35 @@ defmodule Stripe.Product do ( nil - @doc "

Search for products you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/products/search`\n" + @doc "

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/products/{id}`\n" ( - @spec search( - params :: %{ - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:page) => binary, - optional(:query) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.SearchResult.t(Stripe.Product.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def search(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/products/search", [], []) + @spec delete(id :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedProduct.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def delete(id, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/products/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -126,36 +134,33 @@ defmodule Stripe.Product do ( nil - @doc "

Creates a new product object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/products`\n" + @doc "

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/products`\n" ( - @spec create( + @spec list( params :: %{ optional(:active) => boolean, - optional(:default_price_data) => default_price_data, - optional(:description) => binary, + optional(:created) => created | integer, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:features) => list(features), - optional(:id) => binary, - optional(:images) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:name) => binary, - optional(:package_dimensions) => package_dimensions, + optional(:ids) => list(binary), + optional(:limit) => integer, optional(:shippable) => boolean, - optional(:statement_descriptor) => binary, - optional(:tax_code) => binary, + optional(:starting_after) => binary, optional(:type) => :good | :service, - optional(:unit_label) => binary, optional(:url) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Product.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Product.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/products", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -205,54 +210,27 @@ defmodule Stripe.Product do ( nil - @doc "

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/products/{id}`\n" + @doc "

Search for products you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/products/search`\n" ( - @spec update( - id :: binary(), + @spec search( params :: %{ - optional(:active) => boolean, - optional(:default_price) => binary, - optional(:description) => binary | binary, optional(:expand) => list(binary), - optional(:features) => list(features) | binary, - optional(:images) => list(binary) | binary, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:name) => binary, - optional(:package_dimensions) => package_dimensions | binary, - optional(:shippable) => boolean, - optional(:statement_descriptor) => binary, - optional(:tax_code) => binary | binary, - optional(:unit_label) => binary | binary, - optional(:url) => binary | binary + optional(:limit) => integer, + optional(:page) => binary, + optional(:query) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Product.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(id, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/products/{id}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "id", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "id", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [id] - ) + ) :: + {:ok, Stripe.SearchResult.t(Stripe.Product.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def search(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/products/search", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -261,33 +239,36 @@ defmodule Stripe.Product do ( nil - @doc "

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/products`\n" + @doc "

Creates a new product object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/products`\n" ( - @spec list( + @spec create( params :: %{ optional(:active) => boolean, - optional(:created) => created | integer, - optional(:ending_before) => binary, + optional(:default_price_data) => default_price_data, + optional(:description) => binary, optional(:expand) => list(binary), - optional(:ids) => list(binary), - optional(:limit) => integer, + optional(:id) => binary, + optional(:images) => list(binary), + optional(:marketing_features) => list(marketing_features), + optional(:metadata) => %{optional(binary) => binary}, + optional(:name) => binary, + optional(:package_dimensions) => package_dimensions, optional(:shippable) => boolean, - optional(:starting_after) => binary, + optional(:statement_descriptor) => binary, + optional(:tax_code) => binary, optional(:type) => :good | :service, + optional(:unit_label) => binary, optional(:url) => binary }, opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Product.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do + ) :: {:ok, Stripe.Product.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/products", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -296,11 +277,29 @@ defmodule Stripe.Product do ( nil - @doc "

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/products/{id}`\n" + @doc "

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/products/{id}`\n" ( - @spec delete(id :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedProduct.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(id, opts \\ []) do + @spec update( + id :: binary(), + params :: %{ + optional(:active) => boolean, + optional(:default_price) => binary, + optional(:description) => binary | binary, + optional(:expand) => list(binary), + optional(:images) => list(binary) | binary, + optional(:marketing_features) => list(marketing_features) | binary, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:name) => binary, + optional(:package_dimensions) => package_dimensions | binary, + optional(:shippable) => boolean, + optional(:statement_descriptor) => binary, + optional(:tax_code) => binary | binary, + optional(:unit_label) => binary | binary, + optional(:url) => binary | binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Product.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/products/{id}", @@ -324,9 +323,10 @@ defmodule Stripe.Product do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/product_feature.ex b/lib/generated/product_feature.ex new file mode 100644 index 00000000..ab0348cf --- /dev/null +++ b/lib/generated/product_feature.ex @@ -0,0 +1,218 @@ +defmodule Stripe.ProductFeature do + use Stripe.Entity + + @moduledoc "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer." + ( + defstruct [:entitlement_feature, :id, :livemode, :object] + + @typedoc "The `product_feature` type.\n\n * `entitlement_feature` \n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n" + @type t :: %__MODULE__{ + entitlement_feature: Stripe.Entitlements.Feature.t(), + id: binary, + livemode: boolean, + object: binary + } + ) + + ( + nil + + @doc "

Deletes the feature attachment to a product

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/products/{product}/features/{id}`\n" + ( + @spec delete(id :: binary(), product :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedProductFeature.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def delete(id, product, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/products/{product}/features/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + }, + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "product", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "product", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id, product] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieve a list of features for a product

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/products/{product}/features`\n" + ( + @spec list( + product :: binary(), + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.ProductFeature.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(product, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/products/{product}/features", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "product", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "product", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [product] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Retrieves a product_feature, which represents a feature attachment to a product

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/products/{product}/features/{id}`\n" + ( + @spec retrieve( + id :: binary(), + product :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.ProductFeature.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(id, product, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/products/{product}/features/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + }, + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "product", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "product", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id, product] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a product_feature, which represents a feature attachment to a product

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/products/{product}/features`\n" + ( + @spec create( + product :: binary(), + params :: %{ + optional(:entitlement_feature) => binary, + optional(:expand) => list(binary) + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.ProductFeature.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(product, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/products/{product}/features", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "product", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "product", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [product] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/promotion_code.ex b/lib/generated/promotion_code.ex index fcd29994..933b989b 100644 --- a/lib/generated/promotion_code.ex +++ b/lib/generated/promotion_code.ex @@ -57,6 +57,40 @@ defmodule Stripe.PromotionCode do } ) + ( + nil + + @doc "

Returns a list of your promotion codes.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/promotion_codes`\n" + ( + @spec list( + params :: %{ + optional(:active) => boolean, + optional(:code) => binary, + optional(:coupon) => binary, + optional(:created) => created | integer, + optional(:customer) => binary, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.PromotionCode.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/promotion_codes", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -177,38 +211,4 @@ defmodule Stripe.PromotionCode do end ) ) - - ( - nil - - @doc "

Returns a list of your promotion codes.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/promotion_codes`\n" - ( - @spec list( - params :: %{ - optional(:active) => boolean, - optional(:code) => binary, - optional(:coupon) => binary, - optional(:created) => created | integer, - optional(:customer) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.PromotionCode.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/promotion_codes", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/quote.ex b/lib/generated/quote.ex index d8d10d93..2411780c 100644 --- a/lib/generated/quote.ex +++ b/lib/generated/quote.ex @@ -4,40 +4,40 @@ defmodule Stripe.Quote do @moduledoc "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule." ( defstruct [ - :default_tax_rates, - :id, + :line_items, + :livemode, + :customer, + :collection_method, + :header, + :subscription_data, + :created, :transfer_data, - :application_fee_amount, - :number, - :from_quote, + :application, + :expires_at, + :invoice, + :subscription_schedule, :status, - :subscription, :amount_total, - :amount_subtotal, - :discounts, - :created, - :currency, - :automatic_tax, - :test_clock, + :description, + :id, + :footer, :status_transitions, - :expires_at, - :total_details, + :number, + :default_tax_rates, + :automatic_tax, + :computed, :invoice_settings, + :application_fee_amount, + :currency, :object, - :application, - :invoice, - :customer, :on_behalf_of, - :subscription_schedule, - :header, - :footer, - :description, - :subscription_data, + :discounts, + :total_details, + :subscription, + :test_clock, + :amount_subtotal, :metadata, - :line_items, - :collection_method, - :livemode, - :computed, + :from_quote, :application_fee_percent ] @@ -83,12 +83,16 @@ defmodule Stripe.Quote do ( @typedoc "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions." - @type automatic_tax :: %{optional(:enabled) => boolean} + @type automatic_tax :: %{optional(:enabled) => boolean, optional(:liability) => liability} ) ( @typedoc nil - @type discounts :: %{optional(:coupon) => binary, optional(:discount) => binary} + @type discounts :: %{ + optional(:coupon) => binary, + optional(:discount) => binary, + optional(:promotion_code) => binary + } ) ( @@ -98,12 +102,23 @@ defmodule Stripe.Quote do ( @typedoc "All invoices will be billed using the specified settings." - @type invoice_settings :: %{optional(:days_until_due) => integer} + @type invoice_settings :: %{optional(:days_until_due) => integer, optional(:issuer) => issuer} + ) + + ( + @typedoc "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account." + @type issuer :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + + ( + @typedoc "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." + @type liability :: %{optional(:account) => binary, optional(:type) => :account | :self} ) ( @typedoc nil @type line_items :: %{ + optional(:discounts) => list(discounts) | binary, optional(:price) => binary, optional(:price_data) => price_data, optional(:quantity) => integer, @@ -150,6 +165,38 @@ defmodule Stripe.Quote do } ) + ( + nil + + @doc "

Returns a list of your quotes.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes`\n" + ( + @spec list( + params :: %{ + optional(:customer) => binary, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :accepted | :canceled | :draft | :open, + optional(:test_clock) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Quote.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/quotes", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -194,78 +241,25 @@ defmodule Stripe.Quote do ( nil - @doc "

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes`\n" - ( - @spec create( - params :: %{ - optional(:application_fee_amount) => integer | binary, - optional(:application_fee_percent) => number | binary, - optional(:automatic_tax) => automatic_tax, - optional(:collection_method) => :charge_automatically | :send_invoice, - optional(:customer) => binary, - optional(:default_tax_rates) => list(binary) | binary, - optional(:description) => binary | binary, - optional(:discounts) => list(discounts) | binary, - optional(:expand) => list(binary), - optional(:expires_at) => integer, - optional(:footer) => binary | binary, - optional(:from_quote) => from_quote, - optional(:header) => binary | binary, - optional(:invoice_settings) => invoice_settings, - optional(:line_items) => list(line_items), - optional(:metadata) => %{optional(binary) => binary}, - optional(:on_behalf_of) => binary | binary, - optional(:subscription_data) => subscription_data, - optional(:test_clock) => binary, - optional(:transfer_data) => transfer_data | binary - }, - opts :: Keyword.t() - ) :: {:ok, Stripe.Quote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/quotes", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

A quote models prices and services for a customer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes/{quote}`\n" + @doc "

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes/{quote}/computed_upfront_line_items`\n" ( - @spec update( + @spec list_computed_upfront_line_items( quote :: binary(), params :: %{ - optional(:application_fee_amount) => integer | binary, - optional(:application_fee_percent) => number | binary, - optional(:automatic_tax) => automatic_tax, - optional(:collection_method) => :charge_automatically | :send_invoice, - optional(:customer) => binary, - optional(:default_tax_rates) => list(binary) | binary, - optional(:description) => binary | binary, - optional(:discounts) => list(discounts) | binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:expires_at) => integer, - optional(:footer) => binary | binary, - optional(:header) => binary | binary, - optional(:invoice_settings) => invoice_settings, - optional(:line_items) => list(line_items), - optional(:metadata) => %{optional(binary) => binary}, - optional(:on_behalf_of) => binary | binary, - optional(:subscription_data) => subscription_data, - optional(:transfer_data) => transfer_data | binary + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() - ) :: {:ok, Stripe.Quote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(quote, params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Item.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list_computed_upfront_line_items(quote, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/quotes/{quote}", + "/v1/quotes/{quote}/computed_upfront_line_items", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -287,7 +281,7 @@ defmodule Stripe.Quote do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -296,17 +290,25 @@ defmodule Stripe.Quote do ( nil - @doc "

Cancels the quote.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes/{quote}/cancel`\n" + @doc "

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes/{quote}/line_items`\n" ( - @spec cancel( + @spec list_line_items( quote :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, opts :: Keyword.t() - ) :: {:ok, Stripe.Quote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def cancel(quote, params \\ %{}, opts \\ []) do + ) :: + {:ok, Stripe.List.t(Stripe.Item.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list_line_items(quote, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/quotes/{quote}/cancel", + "/v1/quotes/{quote}/line_items", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -325,6 +327,48 @@ defmodule Stripe.Quote do [quote] ) + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes`\n" + ( + @spec create( + params :: %{ + optional(:application_fee_amount) => integer | binary, + optional(:application_fee_percent) => number | binary, + optional(:automatic_tax) => automatic_tax, + optional(:collection_method) => :charge_automatically | :send_invoice, + optional(:customer) => binary, + optional(:default_tax_rates) => list(binary) | binary, + optional(:description) => binary | binary, + optional(:discounts) => list(discounts) | binary, + optional(:expand) => list(binary), + optional(:expires_at) => integer, + optional(:footer) => binary | binary, + optional(:from_quote) => from_quote, + optional(:header) => binary | binary, + optional(:invoice_settings) => invoice_settings, + optional(:line_items) => list(line_items), + optional(:metadata) => %{optional(binary) => binary}, + optional(:on_behalf_of) => binary | binary, + optional(:subscription_data) => subscription_data, + optional(:test_clock) => binary, + optional(:transfer_data) => transfer_data | binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Quote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/quotes", [], []) + Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) @@ -337,17 +381,36 @@ defmodule Stripe.Quote do ( nil - @doc "

Finalizes the quote.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes/{quote}/finalize`\n" + @doc "

A quote models prices and services for a customer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes/{quote}`\n" ( - @spec finalize_quote( + @spec update( quote :: binary(), - params :: %{optional(:expand) => list(binary), optional(:expires_at) => integer}, + params :: %{ + optional(:application_fee_amount) => integer | binary, + optional(:application_fee_percent) => number | binary, + optional(:automatic_tax) => automatic_tax, + optional(:collection_method) => :charge_automatically | :send_invoice, + optional(:customer) => binary, + optional(:default_tax_rates) => list(binary) | binary, + optional(:description) => binary | binary, + optional(:discounts) => list(discounts) | binary, + optional(:expand) => list(binary), + optional(:expires_at) => integer, + optional(:footer) => binary | binary, + optional(:header) => binary | binary, + optional(:invoice_settings) => invoice_settings, + optional(:line_items) => list(line_items), + optional(:metadata) => %{optional(binary) => binary}, + optional(:on_behalf_of) => binary | binary, + optional(:subscription_data) => subscription_data, + optional(:transfer_data) => transfer_data | binary + }, opts :: Keyword.t() ) :: {:ok, Stripe.Quote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def finalize_quote(quote, params \\ %{}, opts \\ []) do + def update(quote, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/quotes/{quote}/finalize", + "/v1/quotes/{quote}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -419,57 +482,17 @@ defmodule Stripe.Quote do ( nil - @doc "

Returns a list of your quotes.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes`\n" - ( - @spec list( - params :: %{ - optional(:customer) => binary, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:status) => :accepted | :canceled | :draft | :open, - optional(:test_clock) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Quote.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/quotes", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes/{quote}/line_items`\n" + @doc "

Cancels the quote.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes/{quote}/cancel`\n" ( - @spec list_line_items( + @spec cancel( quote :: binary(), - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Item.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list_line_items(quote, params \\ %{}, opts \\ []) do + ) :: {:ok, Stripe.Quote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def cancel(quote, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/quotes/{quote}/line_items", + "/v1/quotes/{quote}/cancel", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -491,7 +514,7 @@ defmodule Stripe.Quote do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -500,25 +523,17 @@ defmodule Stripe.Quote do ( nil - @doc "

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes/{quote}/computed_upfront_line_items`\n" + @doc "

Finalizes the quote.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/quotes/{quote}/finalize`\n" ( - @spec list_computed_upfront_line_items( + @spec finalize_quote( quote :: binary(), - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, + params :: %{optional(:expand) => list(binary), optional(:expires_at) => integer}, opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Item.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list_computed_upfront_line_items(quote, params \\ %{}, opts \\ []) do + ) :: {:ok, Stripe.Quote.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def finalize_quote(quote, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/quotes/{quote}/computed_upfront_line_items", + "/v1/quotes/{quote}/finalize", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -540,7 +555,7 @@ defmodule Stripe.Quote do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -549,7 +564,7 @@ defmodule Stripe.Quote do ( nil - @doc "

Download the PDF for a finalized quote

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes/{quote}/pdf`\n" + @doc "

Download the PDF for a finalized quote. Explanation for special handling can be found here

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/quotes/{quote}/pdf`\n" ( @spec pdf( quote :: binary(), @@ -586,4 +601,4 @@ defmodule Stripe.Quote do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/radar__early_fraud_warning.ex b/lib/generated/radar__early_fraud_warning.ex index 4aabfedb..09779635 100644 --- a/lib/generated/radar__early_fraud_warning.ex +++ b/lib/generated/radar__early_fraud_warning.ex @@ -112,4 +112,4 @@ defmodule Stripe.Radar.EarlyFraudWarning do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/radar__value_list.ex b/lib/generated/radar__value_list.ex index 6c0df254..b68b2cc3 100644 --- a/lib/generated/radar__value_list.ex +++ b/lib/generated/radar__value_list.ex @@ -41,6 +41,45 @@ defmodule Stripe.Radar.ValueList do } ) + ( + nil + + @doc "

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/radar/value_lists/{value_list}`\n" + ( + @spec delete(value_list :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedRadar.ValueList.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def delete(value_list, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/radar/value_lists/{value_list}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "value_list", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "value_list", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [value_list] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -205,43 +244,4 @@ defmodule Stripe.Radar.ValueList do end ) ) - - ( - nil - - @doc "

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/radar/value_lists/{value_list}`\n" - ( - @spec delete(value_list :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedRadar.ValueList.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete(value_list, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/radar/value_lists/{value_list}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "value_list", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "value_list", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [value_list] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/radar__value_list_item.ex b/lib/generated/radar__value_list_item.ex index 71eaee3e..081c05ab 100644 --- a/lib/generated/radar__value_list_item.ex +++ b/lib/generated/radar__value_list_item.ex @@ -27,6 +27,45 @@ defmodule Stripe.Radar.ValueListItem do } ) + ( + nil + + @doc "

Deletes a ValueListItem object, removing it from its parent value list.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/radar/value_list_items/{item}`\n" + ( + @spec delete(item :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedRadar.ValueListItem.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def delete(item, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/radar/value_list_items/{item}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "item", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "item", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [item] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -130,43 +169,4 @@ defmodule Stripe.Radar.ValueListItem do end ) ) - - ( - nil - - @doc "

Deletes a ValueListItem object, removing it from its parent value list.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/radar/value_list_items/{item}`\n" - ( - @spec delete(item :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedRadar.ValueListItem.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete(item, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/radar/value_list_items/{item}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "item", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "item", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [item] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/refund.ex b/lib/generated/refund.ex index e4e82dc9..368523e3 100644 --- a/lib/generated/refund.ex +++ b/lib/generated/refund.ex @@ -314,4 +314,4 @@ defmodule Stripe.Refund do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/reporting__report_run.ex b/lib/generated/reporting__report_run.ex index eaafed1c..7c2726de 100644 --- a/lib/generated/reporting__report_run.ex +++ b/lib/generated/reporting__report_run.ex @@ -690,6 +690,36 @@ defmodule Stripe.Reporting.ReportRun do } ) + ( + nil + + @doc "

Returns a list of Report Runs, with the most recent appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/reporting/report_runs`\n" + ( + @spec list( + params :: %{ + optional(:created) => created | integer, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Reporting.ReportRun.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/reporting/report_runs", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -761,34 +791,4 @@ defmodule Stripe.Reporting.ReportRun do end ) ) - - ( - nil - - @doc "

Returns a list of Report Runs, with the most recent appearing first.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/reporting/report_runs`\n" - ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Reporting.ReportRun.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/reporting/report_runs", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/reporting__report_type.ex b/lib/generated/reporting__report_type.ex index 790e4da6..d0cef3e7 100644 --- a/lib/generated/reporting__report_type.ex +++ b/lib/generated/reporting__report_type.ex @@ -29,6 +29,27 @@ defmodule Stripe.Reporting.ReportType do } ) + ( + nil + + @doc "

Returns a full list of Report Types.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/reporting/report_types`\n" + ( + @spec list(params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t()) :: + {:ok, Stripe.List.t(Stripe.Reporting.ReportType.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/reporting/report_types", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -72,25 +93,4 @@ defmodule Stripe.Reporting.ReportType do end ) ) - - ( - nil - - @doc "

Returns a full list of Report Types.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/reporting/report_types`\n" - ( - @spec list(params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t()) :: - {:ok, Stripe.List.t(Stripe.Reporting.ReportType.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/reporting/report_types", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/review.ex b/lib/generated/review.ex index 523572e7..b037cdba 100644 --- a/lib/generated/review.ex +++ b/lib/generated/review.ex @@ -160,4 +160,4 @@ defmodule Stripe.Review do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/scheduled_query_run.ex b/lib/generated/scheduled_query_run.ex index 65b4478d..0ececfa6 100644 --- a/lib/generated/scheduled_query_run.ex +++ b/lib/generated/scheduled_query_run.ex @@ -105,4 +105,4 @@ defmodule Stripe.ScheduledQueryRun do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/setup_attempt.ex b/lib/generated/setup_attempt.ex index aeb5e018..335ef77f 100644 --- a/lib/generated/setup_attempt.ex +++ b/lib/generated/setup_attempt.ex @@ -81,4 +81,4 @@ defmodule Stripe.SetupAttempt do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/setup_intent.ex b/lib/generated/setup_intent.ex index 19bffe52..85900b68 100644 --- a/lib/generated/setup_intent.ex +++ b/lib/generated/setup_intent.ex @@ -1,7 +1,7 @@ defmodule Stripe.SetupIntent do use Stripe.Entity - @moduledoc "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)" + @moduledoc "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)" ( defstruct [ :application, @@ -31,7 +31,7 @@ defmodule Stripe.SetupIntent do :usage ] - @typedoc "The `setup_intent` type.\n\n * `application` ID of the Connect application that created the SetupIntent.\n * `attach_to_self` If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.\n * `automatic_payment_methods` Settings for dynamic payment methods compatible with this Setup Intent\n * `cancellation_reason` Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.\n * `client_secret` The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `flow_directions` Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.\n * `id` Unique identifier for the object.\n * `last_setup_error` The error encountered in the previous SetupIntent confirmation.\n * `latest_attempt` The most recent SetupAttempt for this SetupIntent.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `mandate` ID of the multi use Mandate generated by the SetupIntent.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `next_action` If present, this property tells you what actions you need to take in order for your customer to continue payment setup.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) for which the setup is intended.\n * `payment_method` ID of the payment method used with this SetupIntent.\n * `payment_method_configuration_details` Information about the payment method configuration used for this Setup Intent.\n * `payment_method_options` Payment method-specific configuration for this SetupIntent.\n * `payment_method_types` The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.\n * `single_use_mandate` ID of the single_use Mandate generated by the SetupIntent.\n * `status` [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.\n * `usage` Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.\n" + @typedoc "The `setup_intent` type.\n\n * `application` ID of the Connect application that created the SetupIntent.\n * `attach_to_self` If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.\n * `automatic_payment_methods` Settings for dynamic payment methods compatible with this Setup Intent\n * `cancellation_reason` Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.\n * `client_secret` The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `flow_directions` Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.\n * `id` Unique identifier for the object.\n * `last_setup_error` The error encountered in the previous SetupIntent confirmation.\n * `latest_attempt` The most recent SetupAttempt for this SetupIntent.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `mandate` ID of the multi use Mandate generated by the SetupIntent.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `next_action` If present, this property tells you what actions you need to take in order for your customer to continue payment setup.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) for which the setup is intended.\n * `payment_method` ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.\n * `payment_method_configuration_details` Information about the payment method configuration used for this Setup Intent.\n * `payment_method_options` Payment method-specific configuration for this SetupIntent.\n * `payment_method_types` The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.\n * `single_use_mandate` ID of the single_use Mandate generated by the SetupIntent.\n * `status` [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.\n * `usage` Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.\n" @type t :: %__MODULE__{ application: (binary | term) | nil, attach_to_self: boolean, @@ -96,8 +96,8 @@ defmodule Stripe.SetupIntent do ) ( - @typedoc "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account." - @type bacs_debit :: %{optional(:account_number) => binary, optional(:sort_code) => binary} + @typedoc "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options." + @type bacs_debit :: %{optional(:mandate_options) => map()} ) ( @@ -126,6 +126,7 @@ defmodule Stripe.SetupIntent do | :diners | :discover | :eftpos_au + | :girocard | :interac | :jcb | :mastercard @@ -210,12 +211,18 @@ defmodule Stripe.SetupIntent do } ) + ( + @typedoc "Provide filters for the linked accounts that the customer can select for the payment method" + @type filters :: %{optional(:account_subcategories) => list(:checking | :savings)} + ) + ( @typedoc "Additional fields for Financial Connections Session creation" @type financial_connections :: %{ + optional(:filters) => filters, optional(:permissions) => list(:balances | :ownership | :payment_method | :transactions), - optional(:prefetch) => list(:balances | :transactions), + optional(:prefetch) => list(:balances | :ownership | :transactions), optional(:return_url) => binary } ) @@ -262,6 +269,7 @@ defmodule Stripe.SetupIntent do | :knab | :moneyou | :n26 + | :nn | :rabobank | :regiobank | :revolut @@ -335,6 +343,7 @@ defmodule Stripe.SetupIntent do | :santander_przelew24 | :tmobile_usbugi_bankowe | :toyota_bank + | :velobank | :volkswagen_bank } ) @@ -342,38 +351,45 @@ defmodule Stripe.SetupIntent do ( @typedoc "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent." @type payment_method_data :: %{ - optional(:pix) => map(), - optional(:fpx) => fpx, - optional(:affirm) => map(), - optional(:acss_debit) => acss_debit, - optional(:bacs_debit) => bacs_debit, + optional(:sofort) => sofort, + optional(:customer_balance) => map(), + optional(:boleto) => boleto, optional(:alipay) => map(), - optional(:giropay) => map(), + optional(:au_becs_debit) => au_becs_debit, + optional(:amazon_pay) => map(), + optional(:metadata) => %{optional(binary) => binary}, + optional(:bancontact) => map(), + optional(:interac_present) => map(), + optional(:bacs_debit) => bacs_debit, + optional(:affirm) => map(), + optional(:billing_details) => billing_details, + optional(:mobilepay) => map(), + optional(:grabpay) => map(), + optional(:eps) => eps, optional(:ideal) => ideal, + optional(:pix) => map(), + optional(:giropay) => map(), + optional(:multibanco) => map(), optional(:revolut_pay) => map(), - optional(:radar_options) => radar_options, - optional(:metadata) => %{optional(binary) => binary}, + optional(:klarna) => klarna, + optional(:twint) => map(), + optional(:acss_debit) => acss_debit, optional(:link) => map(), - optional(:promptpay) => map(), - optional(:cashapp) => map(), - optional(:oxxo) => map(), - optional(:interac_present) => map(), - optional(:us_bank_account) => us_bank_account, - optional(:zip) => map(), - optional(:paypal) => map(), - optional(:boleto) => boleto, optional(:konbini) => map(), - optional(:billing_details) => billing_details, optional(:blik) => map(), - optional(:wechat_pay) => map(), - optional(:sofort) => sofort, optional(:p24) => p24, - optional(:afterpay_clearpay) => map(), + optional(:paypal) => map(), + optional(:fpx) => fpx, + optional(:oxxo) => map(), + optional(:paynow) => map(), + optional(:wechat_pay) => map(), + optional(:promptpay) => map(), optional(:type) => :acss_debit | :affirm | :afterpay_clearpay | :alipay + | :amazon_pay | :au_becs_debit | :bacs_debit | :bancontact @@ -389,6 +405,8 @@ defmodule Stripe.SetupIntent do | :klarna | :konbini | :link + | :mobilepay + | :multibanco | :oxxo | :p24 | :paynow @@ -398,17 +416,19 @@ defmodule Stripe.SetupIntent do | :revolut_pay | :sepa_debit | :sofort + | :swish + | :twint | :us_bank_account | :wechat_pay | :zip, - optional(:grabpay) => map(), - optional(:bancontact) => map(), - optional(:au_becs_debit) => au_becs_debit, - optional(:customer_balance) => map(), + optional(:radar_options) => radar_options, + optional(:cashapp) => map(), optional(:sepa_debit) => sepa_debit, - optional(:klarna) => klarna, - optional(:paynow) => map(), - optional(:eps) => eps + optional(:afterpay_clearpay) => map(), + optional(:allow_redisplay) => :always | :limited | :unspecified, + optional(:us_bank_account) => us_bank_account, + optional(:swish) => map(), + optional(:zip) => map() } ) @@ -416,7 +436,10 @@ defmodule Stripe.SetupIntent do @typedoc "Payment method-specific configuration for this SetupIntent." @type payment_method_options :: %{ optional(:acss_debit) => acss_debit, + optional(:amazon_pay) => map(), + optional(:bacs_debit) => bacs_debit, optional(:card) => card, + optional(:card_present) => map(), optional(:link) => link, optional(:paypal) => paypal, optional(:sepa_debit) => sepa_debit, @@ -472,47 +495,6 @@ defmodule Stripe.SetupIntent do } ) - ( - nil - - @doc "

Creates a SetupIntent object.

\n\n

After you create the SetupIntent, attach a payment method and confirm\nit to collect any required permissions to charge the payment method later.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/setup_intents`\n" - ( - @spec create( - params :: %{ - optional(:attach_to_self) => boolean, - optional(:automatic_payment_methods) => automatic_payment_methods, - optional(:confirm) => boolean, - optional(:customer) => binary, - optional(:description) => binary, - optional(:expand) => list(binary), - optional(:flow_directions) => list(:inbound | :outbound), - optional(:mandate_data) => mandate_data | binary, - optional(:metadata) => %{optional(binary) => binary}, - optional(:on_behalf_of) => binary, - optional(:payment_method) => binary, - optional(:payment_method_configuration) => binary, - optional(:payment_method_data) => payment_method_data, - optional(:payment_method_options) => payment_method_options, - optional(:payment_method_types) => list(binary), - optional(:return_url) => binary, - optional(:single_use) => single_use, - optional(:usage) => :off_session | :on_session, - optional(:use_stripe_sdk) => boolean - }, - opts :: Keyword.t() - ) :: {:ok, Stripe.SetupIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/setup_intents", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -587,6 +569,48 @@ defmodule Stripe.SetupIntent do ) ) + ( + nil + + @doc "

Creates a SetupIntent object.

\n\n

After you create the SetupIntent, attach a payment method and confirm\nit to collect any required permissions to charge the payment method later.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/setup_intents`\n" + ( + @spec create( + params :: %{ + optional(:attach_to_self) => boolean, + optional(:automatic_payment_methods) => automatic_payment_methods, + optional(:confirm) => boolean, + optional(:confirmation_token) => binary, + optional(:customer) => binary, + optional(:description) => binary, + optional(:expand) => list(binary), + optional(:flow_directions) => list(:inbound | :outbound), + optional(:mandate_data) => mandate_data | binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:on_behalf_of) => binary, + optional(:payment_method) => binary, + optional(:payment_method_configuration) => binary, + optional(:payment_method_data) => payment_method_data, + optional(:payment_method_options) => payment_method_options, + optional(:payment_method_types) => list(binary), + optional(:return_url) => binary, + optional(:single_use) => single_use, + optional(:usage) => :off_session | :on_session, + optional(:use_stripe_sdk) => boolean + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.SetupIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/setup_intents", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -643,25 +667,21 @@ defmodule Stripe.SetupIntent do ( nil - @doc "

Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.

\n\n

If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.

\n\n

Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status or the canceled status if the\nconfirmation limit is reached.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/setup_intents/{intent}/confirm`\n" + @doc "

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

\n\n

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/setup_intents/{intent}/cancel`\n" ( - @spec confirm( + @spec cancel( intent :: binary(), params :: %{ - optional(:expand) => list(binary), - optional(:mandate_data) => mandate_data | binary | mandate_data, - optional(:payment_method) => binary, - optional(:payment_method_data) => payment_method_data, - optional(:payment_method_options) => payment_method_options, - optional(:return_url) => binary, - optional(:use_stripe_sdk) => boolean + optional(:cancellation_reason) => + :abandoned | :duplicate | :requested_by_customer, + optional(:expand) => list(binary) }, opts :: Keyword.t() ) :: {:ok, Stripe.SetupIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def confirm(intent, params \\ %{}, opts \\ []) do + def cancel(intent, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/setup_intents/{intent}/confirm", + "/v1/setup_intents/{intent}/cancel", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -692,21 +712,26 @@ defmodule Stripe.SetupIntent do ( nil - @doc "

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

\n\n

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/setup_intents/{intent}/cancel`\n" + @doc "

Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.

\n\n

If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.

\n\n

Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status or the canceled status if the\nconfirmation limit is reached.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/setup_intents/{intent}/confirm`\n" ( - @spec cancel( + @spec confirm( intent :: binary(), params :: %{ - optional(:cancellation_reason) => - :abandoned | :duplicate | :requested_by_customer, - optional(:expand) => list(binary) + optional(:confirmation_token) => binary, + optional(:expand) => list(binary), + optional(:mandate_data) => mandate_data | binary | mandate_data, + optional(:payment_method) => binary, + optional(:payment_method_data) => payment_method_data, + optional(:payment_method_options) => payment_method_options, + optional(:return_url) => binary, + optional(:use_stripe_sdk) => boolean }, opts :: Keyword.t() ) :: {:ok, Stripe.SetupIntent.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def cancel(intent, params \\ %{}, opts \\ []) do + def confirm(intent, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/setup_intents/{intent}/cancel", + "/v1/setup_intents/{intent}/confirm", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -778,4 +803,4 @@ defmodule Stripe.SetupIntent do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/shipping_rate.ex b/lib/generated/shipping_rate.ex index 09d0e132..13510745 100644 --- a/lib/generated/shipping_rate.ex +++ b/lib/generated/shipping_rate.ex @@ -18,7 +18,7 @@ defmodule Stripe.ShippingRate do :type ] - @typedoc "The `shipping_rate` type.\n\n * `active` Whether the shipping rate can be used for new purchases. Defaults to `true`.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `delivery_estimate` The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.\n * `display_name` The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.\n * `fixed_amount` \n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `tax_behavior` Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.\n * `tax_code` A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.\n * `type` The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.\n" + @typedoc "The `shipping_rate` type.\n\n * `active` Whether the shipping rate can be used for new purchases. Defaults to `true`.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `delivery_estimate` The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.\n * `display_name` The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.\n * `fixed_amount` \n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `tax_behavior` Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.\n * `tax_code` A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.\n * `type` The type of calculation to use on the shipping rate.\n" @type t :: %__MODULE__{ active: boolean, created: integer, @@ -227,4 +227,4 @@ defmodule Stripe.ShippingRate do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/source.ex b/lib/generated/source.ex index c2ce663c..b29061bf 100644 --- a/lib/generated/source.ex +++ b/lib/generated/source.ex @@ -4,44 +4,44 @@ defmodule Stripe.Source do @moduledoc "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers)." ( defstruct [ - :eps, - :owner, - :id, - :source_order, - :klarna, :sepa_debit, :flow, - :card_present, - :au_becs_debit, :three_d_secure, - :bancontact, - :status, + :livemode, + :customer, + :statement_descriptor, :type, + :redirect, + :source_order, + :wechat, :created, - :currency, :p24, - :sofort, + :acss_debit, + :status, + :code_verification, + :id, + :card, + :currency, + :klarna, + :usage, + :multibanco, + :giropay, :object, - :client_secret, - :wechat, - :statement_descriptor, - :amount, - :ach_credit_transfer, - :customer, + :owner, :receiver, - :usage, + :ideal, + :client_secret, + :eps, + :bancontact, + :ach_debit, :sepa_credit_transfer, - :multibanco, + :ach_credit_transfer, + :card_present, + :amount, :metadata, - :card, - :code_verification, - :ideal, - :redirect, - :giropay, + :au_becs_debit, :alipay, - :ach_debit, - :acss_debit, - :livemode + :sofort ] @typedoc "The `source` type.\n\n * `ach_credit_transfer` \n * `ach_debit` \n * `acss_debit` \n * `alipay` \n * `amount` A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.\n * `au_becs_debit` \n * `bancontact` \n * `card` \n * `card_present` \n * `client_secret` The client secret of the source. Used for client-side retrieval using a publishable key.\n * `code_verification` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.\n * `customer` The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.\n * `eps` \n * `flow` The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.\n * `giropay` \n * `id` Unique identifier for the object.\n * `ideal` \n * `klarna` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `multibanco` \n * `object` String representing the object's type. Objects of the same type share the same value.\n * `owner` Information about the owner of the payment instrument that may be used or required by particular source types.\n * `p24` \n * `receiver` \n * `redirect` \n * `sepa_credit_transfer` \n * `sepa_debit` \n * `sofort` \n * `source_order` \n * `statement_descriptor` Extra information about a source. This will appear on your customer's statement every time you charge the source.\n * `status` The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.\n * `three_d_secure` \n * `type` The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.\n * `usage` Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.\n * `wechat` \n" @@ -285,6 +285,55 @@ defmodule Stripe.Source do ) ) + ( + nil + + @doc "

List source transactions for a given source.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/sources/{source}/source_transactions`\n" + ( + @spec source_transactions( + source :: binary(), + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.SourceTransaction.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def source_transactions(source, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/sources/{source}/source_transactions", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "source", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "source", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [source] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -411,53 +460,4 @@ defmodule Stripe.Source do end ) ) - - ( - nil - - @doc "

List source transactions for a given source.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/sources/{source}/source_transactions`\n" - ( - @spec source_transactions( - source :: binary(), - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.SourceTransaction.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def source_transactions(source, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/sources/{source}/source_transactions", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "source", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "source", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [source] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/source_transaction.ex b/lib/generated/source_transaction.ex index 16909522..df69e660 100644 --- a/lib/generated/source_transaction.ex +++ b/lib/generated/source_transaction.ex @@ -38,4 +38,4 @@ defmodule Stripe.SourceTransaction do type: binary } ) -end +end \ No newline at end of file diff --git a/lib/generated/subscription.ex b/lib/generated/subscription.ex index 164142c5..38d8a855 100644 --- a/lib/generated/subscription.ex +++ b/lib/generated/subscription.ex @@ -4,53 +4,55 @@ defmodule Stripe.Subscription do @moduledoc "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)" ( defstruct [ - :default_tax_rates, - :pending_update, - :id, - :transfer_data, + :schedule, + :next_pending_invoice_item_invoice, + :canceled_at, + :start_date, + :cancellation_details, + :livemode, + :customer, + :collection_method, + :discount, + :latest_invoice, :items, - :status, - :current_period_start, - :trial_start, - :trial_settings, - :cancel_at, - :trial_end, :created, - :currency, - :latest_invoice, + :transfer_data, + :application, + :billing_thresholds, + :cancel_at, + :trial_start, + :status, + :description, + :id, :current_period_end, - :canceled_at, - :schedule, + :pause_collection, + :default_tax_rates, :automatic_tax, - :test_clock, + :invoice_settings, + :currency, + :default_source, + :pending_update, + :object, + :pending_setup_intent, + :on_behalf_of, + :discounts, :billing_cycle_anchor, + :pending_invoice_item_interval, + :trial_end, + :current_period_start, :billing_cycle_anchor_config, - :object, :cancel_at_period_end, - :default_source, - :next_pending_invoice_item_invoice, - :billing_thresholds, - :pending_invoice_item_interval, - :application, - :payment_settings, + :test_clock, + :default_payment_method, :days_until_due, - :ended_at, - :customer, - :pause_collection, - :on_behalf_of, - :start_date, - :discount, - :pending_setup_intent, - :cancellation_details, - :description, + :payment_settings, :metadata, - :default_payment_method, - :collection_method, - :livemode, + :ended_at, + :trial_settings, :application_fee_percent ] - @typedoc "The `subscription` type.\n\n * `application` ID of the Connect Application that created the subscription.\n * `application_fee_percent` A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.\n * `automatic_tax` \n * `billing_cycle_anchor` The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.\n * `billing_cycle_anchor_config` The fixed values used to calculate the `billing_cycle_anchor`.\n * `billing_thresholds` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period\n * `cancel_at` A date in the future at which the subscription will automatically get canceled\n * `cancel_at_period_end` If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.\n * `canceled_at` If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.\n * `cancellation_details` Details about why this subscription was cancelled\n * `collection_method` Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `current_period_end` End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.\n * `current_period_start` Start of the current period that the subscription has been invoiced for.\n * `customer` ID of the customer who owns the subscription.\n * `days_until_due` Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.\n * `default_payment_method` ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).\n * `default_source` ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).\n * `default_tax_rates` The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.\n * `description` The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.\n * `discount` Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.\n * `ended_at` If the subscription has ended, the date the subscription ended.\n * `id` Unique identifier for the object.\n * `items` List of subscription items, each with an attached price.\n * `latest_invoice` The most recent invoice this subscription has generated.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `next_pending_invoice_item_invoice` Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.\n * `pause_collection` If specified, payment collection for this subscription will be paused.\n * `payment_settings` Payment settings passed on to invoices created by the subscription.\n * `pending_invoice_item_interval` Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.\n * `pending_setup_intent` You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).\n * `pending_update` 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.\n * `schedule` The schedule attached to the subscription\n * `start_date` Date when the subscription was first created. The date might differ from the `created` date due to backdating.\n * `status` Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.\n * `test_clock` ID of the test clock this subscription belongs to.\n * `transfer_data` The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.\n * `trial_end` If the subscription has a trial, the end of that trial.\n * `trial_settings` Settings related to subscription trials.\n * `trial_start` If the subscription has a trial, the beginning of that trial.\n" + @typedoc "The `subscription` type.\n\n * `application` ID of the Connect Application that created the subscription.\n * `application_fee_percent` A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.\n * `automatic_tax` \n * `billing_cycle_anchor` The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.\n * `billing_cycle_anchor_config` The fixed values used to calculate the `billing_cycle_anchor`.\n * `billing_thresholds` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period\n * `cancel_at` A date in the future at which the subscription will automatically get canceled\n * `cancel_at_period_end` Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.\n * `canceled_at` If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.\n * `cancellation_details` Details about why this subscription was cancelled\n * `collection_method` Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `current_period_end` End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.\n * `current_period_start` Start of the current period that the subscription has been invoiced for.\n * `customer` ID of the customer who owns the subscription.\n * `days_until_due` Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.\n * `default_payment_method` ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).\n * `default_source` ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).\n * `default_tax_rates` The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.\n * `description` The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.\n * `discount` Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.\n * `discounts` The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.\n * `ended_at` If the subscription has ended, the date the subscription ended.\n * `id` Unique identifier for the object.\n * `invoice_settings` \n * `items` List of subscription items, each with an attached price.\n * `latest_invoice` The most recent invoice this subscription has generated.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `next_pending_invoice_item_invoice` Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `on_behalf_of` The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.\n * `pause_collection` If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).\n * `payment_settings` Payment settings passed on to invoices created by the subscription.\n * `pending_invoice_item_interval` Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.\n * `pending_setup_intent` You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).\n * `pending_update` 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.\n * `schedule` The schedule attached to the subscription\n * `start_date` Date when the subscription was first created. The date might differ from the `created` date due to backdating.\n * `status` Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.\n * `test_clock` ID of the test clock this subscription belongs to.\n * `transfer_data` The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.\n * `trial_end` If the subscription has a trial, the end of that trial.\n * `trial_settings` Settings related to subscription trials.\n * `trial_start` If the subscription has a trial, the beginning of that trial.\n" @type t :: %__MODULE__{ application: (binary | term | term) | nil, application_fee_percent: term | nil, @@ -74,8 +76,10 @@ defmodule Stripe.Subscription do default_tax_rates: term | nil, description: binary | nil, discount: term | nil, + discounts: term, ended_at: integer | nil, id: binary, + invoice_settings: term, items: term, latest_invoice: (binary | Stripe.Invoice.t()) | nil, livemode: boolean, @@ -110,6 +114,7 @@ defmodule Stripe.Subscription do ( @typedoc nil @type add_invoice_items :: %{ + optional(:discounts) => list(discounts), optional(:price) => binary, optional(:price_data) => price_data, optional(:quantity) => integer, @@ -180,13 +185,14 @@ defmodule Stripe.Subscription do | :diners | :discover | :eftpos_au + | :girocard | :interac | :jcb | :mastercard | :unionpay | :unknown | :visa, - optional(:request_three_d_secure) => :any | :automatic + optional(:request_three_d_secure) => :any | :automatic | :challenge } ) @@ -228,6 +234,15 @@ defmodule Stripe.Subscription do } ) + ( + @typedoc nil + @type discounts :: %{ + optional(:coupon) => binary, + optional(:discount) => binary, + optional(:promotion_code) => binary + } + ) + ( @typedoc "Defines how the subscription should behave when the user's free trial ends." @type end_behavior :: %{ @@ -240,19 +255,39 @@ defmodule Stripe.Subscription do @type eu_bank_transfer :: %{optional(:country) => binary} ) + ( + @typedoc "Provide filters for the linked accounts that the customer can select for the payment method." + @type filters :: %{optional(:account_subcategories) => list(:checking | :savings)} + ) + ( @typedoc "Additional fields for Financial Connections Session creation" @type financial_connections :: %{ + optional(:filters) => filters, optional(:permissions) => list(:balances | :ownership | :payment_method | :transactions), - optional(:prefetch) => list(:balances | :transactions) + optional(:prefetch) => list(:balances | :ownership | :transactions) + } + ) + + ( + @typedoc "All invoices will be billed using the specified settings." + @type invoice_settings :: %{ + optional(:account_tax_ids) => list(binary) | binary, + optional(:issuer) => issuer } ) + ( + @typedoc "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account." + @type issuer :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + ( @typedoc nil @type items :: %{ optional(:billing_thresholds) => billing_thresholds | binary, + optional(:discounts) => list(discounts) | binary, optional(:metadata) => %{optional(binary) => binary}, optional(:plan) => binary, optional(:price) => binary, @@ -262,6 +297,11 @@ defmodule Stripe.Subscription do } ) + ( + @typedoc "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." + @type liability :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + ( @typedoc "Additional fields for Mandate creation" @type mandate_options :: %{optional(:transaction_type) => :business | :personal} @@ -283,6 +323,7 @@ defmodule Stripe.Subscription do optional(:card) => card | binary, optional(:customer_balance) => customer_balance | binary, optional(:konbini) => map() | binary, + optional(:sepa_debit) => map() | binary, optional(:us_bank_account) => us_bank_account | binary } ) @@ -296,6 +337,7 @@ defmodule Stripe.Subscription do :ach_credit_transfer | :ach_debit | :acss_debit + | :amazon_pay | :au_becs_debit | :bacs_debit | :bancontact @@ -310,13 +352,16 @@ defmodule Stripe.Subscription do | :ideal | :konbini | :link + | :multibanco | :p24 | :paynow | :paypal | :promptpay + | :revolut_pay | :sepa_credit_transfer | :sepa_debit | :sofort + | :swish | :us_bank_account | :wechat_pay ) @@ -377,27 +422,84 @@ defmodule Stripe.Subscription do ( nil - @doc "

Search for subscriptions you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/subscriptions/search`\n" + @doc "

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

\n\n

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

\n\n

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" ( - @spec search( + @spec cancel( + subscription_exposed_id :: binary(), params :: %{ + optional(:cancellation_details) => cancellation_details, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:page) => binary, - optional(:query) => binary + optional(:invoice_now) => boolean, + optional(:prorate) => boolean }, opts :: Keyword.t() ) :: - {:ok, Stripe.SearchResult.t(Stripe.Subscription.t())} + {:ok, Stripe.Subscription.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def cancel(subscription_exposed_id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/subscriptions/{subscription_exposed_id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "subscription_exposed_id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "subscription_exposed_id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [subscription_exposed_id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Removes the currently applied discount on a subscription.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/subscriptions/{subscription_exposed_id}/discount`\n" + ( + @spec delete_discount(subscription_exposed_id :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedDiscount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def search(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/subscriptions/search", [], []) + def delete_discount(subscription_exposed_id, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/subscriptions/{subscription_exposed_id}/discount", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "subscription_exposed_id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "subscription_exposed_id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [subscription_exposed_id] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -455,113 +557,15 @@ defmodule Stripe.Subscription do ( nil - @doc "

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

\n\n

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.\nThe payment_behavior parameter determines the exact behavior of the initial payment.

\n\n

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.\nSchedules provide the flexibility to model more complex billing configurations that change over time.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscriptions`\n" - ( - @spec create( - params :: %{ - optional(:application_fee_percent) => number, - optional(:add_invoice_items) => list(add_invoice_items), - optional(:collection_method) => :charge_automatically | :send_invoice, - optional(:default_payment_method) => binary, - optional(:expand) => list(binary), - optional(:coupon) => binary, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:description) => binary, - optional(:on_behalf_of) => binary | binary, - optional(:customer) => binary, - optional(:days_until_due) => integer, - optional(:promotion_code) => binary, - optional(:payment_settings) => payment_settings, - optional(:pending_invoice_item_interval) => - pending_invoice_item_interval | binary, - optional(:billing_thresholds) => billing_thresholds | binary, - optional(:default_source) => binary, - optional(:cancel_at_period_end) => boolean, - optional(:trial_from_plan) => boolean, - optional(:billing_cycle_anchor_config) => billing_cycle_anchor_config, - optional(:billing_cycle_anchor) => integer, - optional(:trial_period_days) => integer, - optional(:automatic_tax) => automatic_tax, - optional(:currency) => binary, - optional(:trial_end) => :now | integer, - optional(:cancel_at) => integer, - optional(:trial_settings) => trial_settings, - optional(:payment_behavior) => - :allow_incomplete - | :default_incomplete - | :error_if_incomplete - | :pending_if_incomplete, - optional(:items) => list(items), - optional(:transfer_data) => transfer_data, - optional(:proration_behavior) => :always_invoice | :create_prorations | :none, - optional(:off_session) => boolean, - optional(:default_tax_rates) => list(binary) | binary, - optional(:backdate_start_date) => integer - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Subscription.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/subscriptions", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.

\n\n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n\n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n\n\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

\n\n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

\n\n

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

\n\n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" + @doc "

Retrieves the subscription with the given ID.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" ( - @spec update( + @spec retrieve( subscription_exposed_id :: binary(), - params :: %{ - optional(:add_invoice_items) => list(add_invoice_items), - optional(:application_fee_percent) => number, - optional(:automatic_tax) => automatic_tax, - optional(:billing_cycle_anchor) => :now | :unchanged, - optional(:billing_thresholds) => billing_thresholds | binary, - optional(:cancel_at) => integer | binary, - optional(:cancel_at_period_end) => boolean, - optional(:cancellation_details) => cancellation_details, - optional(:collection_method) => :charge_automatically | :send_invoice, - optional(:coupon) => binary, - optional(:days_until_due) => integer, - optional(:default_payment_method) => binary, - optional(:default_source) => binary | binary, - optional(:default_tax_rates) => list(binary) | binary, - optional(:description) => binary | binary, - optional(:expand) => list(binary), - optional(:items) => list(items), - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:off_session) => boolean, - optional(:on_behalf_of) => binary | binary, - optional(:pause_collection) => pause_collection | binary, - optional(:payment_behavior) => - :allow_incomplete - | :default_incomplete - | :error_if_incomplete - | :pending_if_incomplete, - optional(:payment_settings) => payment_settings, - optional(:pending_invoice_item_interval) => - pending_invoice_item_interval | binary, - optional(:promotion_code) => binary, - optional(:proration_behavior) => :always_invoice | :create_prorations | :none, - optional(:proration_date) => integer, - optional(:transfer_data) => transfer_data | binary, - optional(:trial_end) => :now | integer, - optional(:trial_from_plan) => boolean, - optional(:trial_settings) => trial_settings - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Subscription.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(subscription_exposed_id, params \\ %{}, opts \\ []) do + def retrieve(subscription_exposed_id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/subscriptions/{subscription_exposed_id}", @@ -586,7 +590,7 @@ defmodule Stripe.Subscription do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -595,35 +599,22 @@ defmodule Stripe.Subscription do ( nil - @doc "

Retrieves the subscription with the given ID.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" + @doc "

Search for subscriptions you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/subscriptions/search`\n" ( - @spec retrieve( - subscription_exposed_id :: binary(), - params :: %{optional(:expand) => list(binary)}, + @spec search( + params :: %{ + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:page) => binary, + optional(:query) => binary + }, opts :: Keyword.t() ) :: - {:ok, Stripe.Subscription.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(subscription_exposed_id, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/subscriptions/{subscription_exposed_id}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "subscription_exposed_id", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "subscription_exposed_id", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [subscription_exposed_id] - ) + {:ok, Stripe.SearchResult.t(Stripe.Subscription.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def search(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/subscriptions/search", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -637,45 +628,61 @@ defmodule Stripe.Subscription do ( nil - @doc "

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

\n\n

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

\n\n

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" + @doc "

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

\n\n

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.\nThe payment_behavior parameter determines the exact behavior of the initial payment.

\n\n

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.\nSchedules provide the flexibility to model more complex billing configurations that change over time.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscriptions`\n" ( - @spec cancel( - subscription_exposed_id :: binary(), + @spec create( params :: %{ - optional(:cancellation_details) => cancellation_details, + optional(:application_fee_percent) => number | binary, + optional(:trial_settings) => trial_settings, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:payment_settings) => payment_settings, + optional(:days_until_due) => integer, + optional(:default_payment_method) => binary, + optional(:cancel_at_period_end) => boolean, + optional(:billing_cycle_anchor_config) => billing_cycle_anchor_config, + optional(:proration_behavior) => :always_invoice | :create_prorations | :none, + optional(:add_invoice_items) => list(add_invoice_items), + optional(:trial_end) => :now | integer, + optional(:pending_invoice_item_interval) => + pending_invoice_item_interval | binary, + optional(:billing_cycle_anchor) => integer, + optional(:payment_behavior) => + :allow_incomplete + | :default_incomplete + | :error_if_incomplete + | :pending_if_incomplete, + optional(:discounts) => list(discounts) | binary, + optional(:on_behalf_of) => binary | binary, + optional(:default_source) => binary, + optional(:currency) => binary, + optional(:invoice_settings) => invoice_settings, + optional(:coupon) => binary, + optional(:trial_from_plan) => boolean, + optional(:automatic_tax) => automatic_tax, + optional(:default_tax_rates) => list(binary) | binary, + optional(:description) => binary, + optional(:trial_period_days) => integer, + optional(:cancel_at) => integer, + optional(:billing_thresholds) => billing_thresholds | binary, + optional(:transfer_data) => transfer_data, + optional(:promotion_code) => binary, + optional(:items) => list(items), + optional(:backdate_start_date) => integer, + optional(:collection_method) => :charge_automatically | :send_invoice, + optional(:customer) => binary, optional(:expand) => list(binary), - optional(:invoice_now) => boolean, - optional(:prorate) => boolean + optional(:off_session) => boolean }, opts :: Keyword.t() ) :: {:ok, Stripe.Subscription.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def cancel(subscription_exposed_id, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/subscriptions/{subscription_exposed_id}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "subscription_exposed_id", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "subscription_exposed_id", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [subscription_exposed_id] - ) + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/subscriptions", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -731,16 +738,57 @@ defmodule Stripe.Subscription do ( nil - @doc "

Removes the currently applied discount on a subscription.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/subscriptions/{subscription_exposed_id}/discount`\n" + @doc "

Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the create preview endpoint.

\n\n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n\n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n\n\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

\n\n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

\n\n

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

\n\n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" ( - @spec delete_discount(subscription_exposed_id :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedDiscount.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete_discount(subscription_exposed_id, opts \\ []) do + @spec update( + subscription_exposed_id :: binary(), + params :: %{ + optional(:application_fee_percent) => number | binary, + optional(:trial_settings) => trial_settings, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:payment_settings) => payment_settings, + optional(:days_until_due) => integer, + optional(:default_payment_method) => binary, + optional(:cancel_at_period_end) => boolean, + optional(:proration_behavior) => :always_invoice | :create_prorations | :none, + optional(:add_invoice_items) => list(add_invoice_items), + optional(:trial_end) => :now | integer, + optional(:pending_invoice_item_interval) => + pending_invoice_item_interval | binary, + optional(:billing_cycle_anchor) => :now | :unchanged, + optional(:payment_behavior) => + :allow_incomplete + | :default_incomplete + | :error_if_incomplete + | :pending_if_incomplete, + optional(:discounts) => list(discounts) | binary, + optional(:on_behalf_of) => binary | binary, + optional(:default_source) => binary | binary, + optional(:invoice_settings) => invoice_settings, + optional(:coupon) => binary, + optional(:trial_from_plan) => boolean, + optional(:automatic_tax) => automatic_tax, + optional(:default_tax_rates) => list(binary) | binary, + optional(:pause_collection) => pause_collection | binary, + optional(:description) => binary | binary, + optional(:cancel_at) => integer | binary, + optional(:billing_thresholds) => billing_thresholds | binary, + optional(:transfer_data) => transfer_data | binary, + optional(:promotion_code) => binary, + optional(:items) => list(items), + optional(:collection_method) => :charge_automatically | :send_invoice, + optional(:cancellation_details) => cancellation_details, + optional(:proration_date) => integer, + optional(:expand) => list(binary), + optional(:off_session) => boolean + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Subscription.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def update(subscription_exposed_id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/subscriptions/{subscription_exposed_id}/discount", + "/v1/subscriptions/{subscription_exposed_id}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -761,9 +809,10 @@ defmodule Stripe.Subscription do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/subscription_item.ex b/lib/generated/subscription_item.ex index d4c1120e..6b172a84 100644 --- a/lib/generated/subscription_item.ex +++ b/lib/generated/subscription_item.ex @@ -6,6 +6,7 @@ defmodule Stripe.SubscriptionItem do defstruct [ :billing_thresholds, :created, + :discounts, :id, :metadata, :object, @@ -16,10 +17,11 @@ defmodule Stripe.SubscriptionItem do :tax_rates ] - @typedoc "The `subscription_item` type.\n\n * `billing_thresholds` Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `id` Unique identifier for the object.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `plan` \n * `price` \n * `quantity` The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.\n * `subscription` The `subscription` this `subscription_item` belongs to.\n * `tax_rates` The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.\n" + @typedoc "The `subscription_item` type.\n\n * `billing_thresholds` Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `discounts` The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.\n * `id` Unique identifier for the object.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `plan` \n * `price` \n * `quantity` The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.\n * `subscription` The `subscription` this `subscription_item` belongs to.\n * `tax_rates` The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.\n" @type t :: %__MODULE__{ billing_thresholds: term | nil, created: integer, + discounts: term, id: binary, metadata: term, object: binary, @@ -36,6 +38,15 @@ defmodule Stripe.SubscriptionItem do @type billing_thresholds :: %{optional(:usage_gte) => integer} ) + ( + @typedoc nil + @type discounts :: %{ + optional(:coupon) => binary, + optional(:discount) => binary, + optional(:promotion_code) => binary + } + ) + ( @typedoc "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline." @type price_data :: %{ @@ -56,6 +67,54 @@ defmodule Stripe.SubscriptionItem do } ) + ( + nil + + @doc "

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/subscription_items/{item}`\n" + ( + @spec delete( + item :: binary(), + params :: %{ + optional(:clear_usage) => boolean, + optional(:proration_behavior) => :always_invoice | :create_prorations | :none, + optional(:proration_date) => integer + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.DeletedSubscriptionItem.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def delete(item, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/subscription_items/{item}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "item", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "item", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [item] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -130,6 +189,55 @@ defmodule Stripe.SubscriptionItem do ) ) + ( + nil + + @doc "

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

\n\n

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/subscription_items/{subscription_item}/usage_record_summaries`\n" + ( + @spec usage_record_summaries( + subscription_item :: binary(), + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.UsageRecordSummary.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def usage_record_summaries(subscription_item, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/subscription_items/{subscription_item}/usage_record_summaries", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "subscription_item", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "subscription_item", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [subscription_item] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -138,6 +246,7 @@ defmodule Stripe.SubscriptionItem do @spec create( params :: %{ optional(:billing_thresholds) => billing_thresholds | binary, + optional(:discounts) => list(discounts) | binary, optional(:expand) => list(binary), optional(:metadata) => %{optional(binary) => binary}, optional(:payment_behavior) => @@ -180,6 +289,7 @@ defmodule Stripe.SubscriptionItem do item :: binary(), params :: %{ optional(:billing_thresholds) => billing_thresholds | binary, + optional(:discounts) => list(discounts) | binary, optional(:expand) => list(binary), optional(:metadata) => %{optional(binary) => binary} | binary, optional(:off_session) => boolean, @@ -231,101 +341,4 @@ defmodule Stripe.SubscriptionItem do end ) ) - - ( - nil - - @doc "

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/subscription_items/{item}`\n" - ( - @spec delete( - item :: binary(), - params :: %{ - optional(:clear_usage) => boolean, - optional(:proration_behavior) => :always_invoice | :create_prorations | :none, - optional(:proration_date) => integer - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.DeletedSubscriptionItem.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete(item, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/subscription_items/{item}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "item", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "item", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [item] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:delete) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

\n\n

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/subscription_items/{subscription_item}/usage_record_summaries`\n" - ( - @spec usage_record_summaries( - subscription_item :: binary(), - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.UsageRecordSummary.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def usage_record_summaries(subscription_item, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/subscription_items/{subscription_item}/usage_record_summaries", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "subscription_item", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "subscription_item", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [subscription_item] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/subscription_schedule.ex b/lib/generated/subscription_schedule.ex index e7bc820c..9eca4bb2 100644 --- a/lib/generated/subscription_schedule.ex +++ b/lib/generated/subscription_schedule.ex @@ -50,6 +50,7 @@ defmodule Stripe.SubscriptionSchedule do ( @typedoc nil @type add_invoice_items :: %{ + optional(:discounts) => list(discounts), optional(:price) => binary, optional(:price_data) => price_data, optional(:quantity) => integer, @@ -59,7 +60,7 @@ defmodule Stripe.SubscriptionSchedule do ( @typedoc "Automatic tax settings for this phase." - @type automatic_tax :: %{optional(:enabled) => boolean} + @type automatic_tax :: %{optional(:enabled) => boolean, optional(:liability) => liability} ) ( @@ -116,15 +117,34 @@ defmodule Stripe.SubscriptionSchedule do } ) + ( + @typedoc nil + @type discounts :: %{ + optional(:coupon) => binary, + optional(:discount) => binary, + optional(:promotion_code) => binary + } + ) + ( @typedoc "All invoices will be billed using the specified settings." - @type invoice_settings :: %{optional(:days_until_due) => integer} + @type invoice_settings :: %{ + optional(:account_tax_ids) => list(binary) | binary, + optional(:days_until_due) => integer, + optional(:issuer) => issuer + } + ) + + ( + @typedoc "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account." + @type issuer :: %{optional(:account) => binary, optional(:type) => :account | :self} ) ( @typedoc nil @type items :: %{ optional(:billing_thresholds) => billing_thresholds | binary, + optional(:discounts) => list(discounts) | binary, optional(:metadata) => %{optional(binary) => binary}, optional(:plan) => binary, optional(:price) => binary, @@ -134,6 +154,11 @@ defmodule Stripe.SubscriptionSchedule do } ) + ( + @typedoc "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." + @type liability :: %{optional(:account) => binary, optional(:type) => :account | :self} + ) + ( @typedoc nil @type phases :: %{ @@ -148,6 +173,7 @@ defmodule Stripe.SubscriptionSchedule do optional(:default_payment_method) => binary, optional(:default_tax_rates) => list(binary) | binary, optional(:description) => binary | binary, + optional(:discounts) => list(discounts) | binary, optional(:end_date) => integer, optional(:invoice_settings) => invoice_settings, optional(:items) => list(items), @@ -234,39 +260,6 @@ defmodule Stripe.SubscriptionSchedule do ) ) - ( - nil - - @doc "

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscription_schedules`\n" - ( - @spec create( - params :: %{ - optional(:customer) => binary, - optional(:default_settings) => default_settings, - optional(:end_behavior) => :cancel | :none | :release | :renew, - optional(:expand) => list(binary), - optional(:from_subscription) => binary, - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:phases) => list(phases), - optional(:start_date) => integer | :now - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.SubscriptionSchedule.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/subscription_schedules", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -311,6 +304,39 @@ defmodule Stripe.SubscriptionSchedule do ) ) + ( + nil + + @doc "

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscription_schedules`\n" + ( + @spec create( + params :: %{ + optional(:customer) => binary, + optional(:default_settings) => default_settings, + optional(:end_behavior) => :cancel | :none | :release | :renew, + optional(:expand) => list(binary), + optional(:from_subscription) => binary, + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:phases) => list(phases), + optional(:start_date) => integer | :now + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.SubscriptionSchedule.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/subscription_schedules", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -456,4 +482,4 @@ defmodule Stripe.SubscriptionSchedule do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/tax__calculation.ex b/lib/generated/tax__calculation.ex index 7a0bd225..c5be058e 100644 --- a/lib/generated/tax__calculation.ex +++ b/lib/generated/tax__calculation.ex @@ -13,6 +13,7 @@ defmodule Stripe.Tax.Calculation do :line_items, :livemode, :object, + :ship_from_details, :shipping_cost, :tax_amount_exclusive, :tax_amount_inclusive, @@ -20,7 +21,7 @@ defmodule Stripe.Tax.Calculation do :tax_date ] - @typedoc "The `tax.calculation` type.\n\n * `amount_total` Total after taxes.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.\n * `customer_details` \n * `expires_at` Timestamp of date at which the tax calculation will expire.\n * `id` Unique identifier for the calculation.\n * `line_items` The list of items the customer is purchasing.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `shipping_cost` The shipping cost details for the calculation.\n * `tax_amount_exclusive` The amount of tax to be collected on top of the line item prices.\n * `tax_amount_inclusive` The amount of tax already included in the line item prices.\n * `tax_breakdown` Breakdown of individual tax amounts that add up to the total.\n * `tax_date` Timestamp of date at which the tax rules and rates in effect applies for the calculation.\n" + @typedoc "The `tax.calculation` type.\n\n * `amount_total` Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.\n * `customer_details` \n * `expires_at` Timestamp of date at which the tax calculation will expire.\n * `id` Unique identifier for the calculation.\n * `line_items` The list of items the customer is purchasing.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `ship_from_details` The details of the ship from location, such as the address.\n * `shipping_cost` The shipping cost details for the calculation.\n * `tax_amount_exclusive` The amount of tax to be collected on top of the line item prices.\n * `tax_amount_inclusive` The amount of tax already included in the line item prices.\n * `tax_breakdown` Breakdown of individual tax amounts that add up to the total.\n * `tax_date` Timestamp of date at which the tax rules and rates in effect applies for the calculation.\n" @type t :: %__MODULE__{ amount_total: integer, currency: binary, @@ -31,6 +32,7 @@ defmodule Stripe.Tax.Calculation do line_items: term | nil, livemode: boolean, object: binary, + ship_from_details: term | nil, shipping_cost: term | nil, tax_amount_exclusive: integer, tax_amount_inclusive: integer, @@ -40,7 +42,7 @@ defmodule Stripe.Tax.Calculation do ) ( - @typedoc "The customer's postal address (for example, home or business location)." + @typedoc "The address from which the goods are being shipped from." @type address :: %{ optional(:city) => binary | binary, optional(:country) => binary, @@ -74,6 +76,11 @@ defmodule Stripe.Tax.Calculation do } ) + ( + @typedoc "Details about the address from which the goods are being shipped." + @type ship_from_details :: %{optional(:address) => address} + ) + ( @typedoc "Shipping cost details to be used for the calculation." @type shipping_cost :: %{ @@ -94,6 +101,7 @@ defmodule Stripe.Tax.Calculation do | :au_abn | :au_arn | :bg_uic + | :bh_vat | :bo_tin | :br_cnpj | :br_cpf @@ -103,11 +111,13 @@ defmodule Stripe.Tax.Calculation do | :ca_pst_mb | :ca_pst_sk | :ca_qst + | :ch_uid | :ch_vat | :cl_tin | :cn_tin | :co_nit | :cr_tin + | :de_stn | :do_rcn | :ec_ruc | :eg_tin @@ -117,6 +127,7 @@ defmodule Stripe.Tax.Calculation do | :gb_vat | :ge_vat | :hk_br + | :hr_oib | :hu_tin | :id_npwp | :il_vat @@ -127,13 +138,17 @@ defmodule Stripe.Tax.Calculation do | :jp_trn | :ke_pin | :kr_brn + | :kz_bin | :li_uid | :mx_rfc | :my_frp | :my_itn | :my_sst + | :ng_tin | :no_vat + | :no_voec | :nz_gst + | :om_vat | :pe_ruc | :ph_tin | :ro_tin @@ -161,30 +176,42 @@ defmodule Stripe.Tax.Calculation do ( nil - @doc "

Calculates tax based on input and returns a Tax Calculation object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/calculations`\n" + @doc "

Retrieves a Tax Calculation object, if the calculation hasn’t expired.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/tax/calculations/{calculation}`\n" ( - @spec create( - params :: %{ - optional(:currency) => binary, - optional(:customer) => binary, - optional(:customer_details) => customer_details, - optional(:expand) => list(binary), - optional(:line_items) => list(line_items), - optional(:shipping_cost) => shipping_cost, - optional(:tax_date) => integer - }, + @spec retrieve( + calculation :: binary(), + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Tax.Calculation.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/calculations", [], []) + def retrieve(calculation, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/tax/calculations/{calculation}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "calculation", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "calculation", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [calculation] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -193,7 +220,7 @@ defmodule Stripe.Tax.Calculation do ( nil - @doc "

Retrieves the line items of a persisted tax calculation as a collection.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/tax/calculations/{calculation}/line_items`\n" + @doc "

Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/tax/calculations/{calculation}/line_items`\n" ( @spec list_line_items( calculation :: binary(), @@ -238,4 +265,37 @@ defmodule Stripe.Tax.Calculation do end ) ) -end + + ( + nil + + @doc "

Calculates tax based on the input and returns a Tax Calculation object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/calculations`\n" + ( + @spec create( + params :: %{ + optional(:currency) => binary, + optional(:customer) => binary, + optional(:customer_details) => customer_details, + optional(:expand) => list(binary), + optional(:line_items) => list(line_items), + optional(:ship_from_details) => ship_from_details, + optional(:shipping_cost) => shipping_cost, + optional(:tax_date) => integer + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Tax.Calculation.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/calculations", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end \ No newline at end of file diff --git a/lib/generated/tax__calculation_line_item.ex b/lib/generated/tax__calculation_line_item.ex index 726360a5..4cb44f2c 100644 --- a/lib/generated/tax__calculation_line_item.ex +++ b/lib/generated/tax__calculation_line_item.ex @@ -16,7 +16,7 @@ defmodule Stripe.Tax.CalculationLineItem do :tax_code ] - @typedoc "The `tax.calculation_line_item` type.\n\n * `amount` The line item amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.\n * `amount_tax` The amount of tax calculated for this line item, in integer cents.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `product` The ID of an existing [Product](https://stripe.com/docs/api/products/object).\n * `quantity` The number of units of the item being purchased. For reversals, this is the quantity reversed.\n * `reference` A custom identifier for this line item.\n * `tax_behavior` Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.\n * `tax_breakdown` Detailed account of taxes relevant to this line item.\n * `tax_code` The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.\n" + @typedoc "The `tax.calculation_line_item` type.\n\n * `amount` The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.\n * `amount_tax` The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `product` The ID of an existing [Product](https://stripe.com/docs/api/products/object).\n * `quantity` The number of units of the item being purchased. For reversals, this is the quantity reversed.\n * `reference` A custom identifier for this line item.\n * `tax_behavior` Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.\n * `tax_breakdown` Detailed account of taxes relevant to this line item.\n * `tax_code` The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.\n" @type t :: %__MODULE__{ amount: integer, amount_tax: integer, @@ -31,4 +31,4 @@ defmodule Stripe.Tax.CalculationLineItem do tax_code: binary } ) -end +end \ No newline at end of file diff --git a/lib/generated/tax__registration.ex b/lib/generated/tax__registration.ex index ca9659c6..59461c64 100644 --- a/lib/generated/tax__registration.ex +++ b/lib/generated/tax__registration.ex @@ -63,6 +63,11 @@ defmodule Stripe.Tax.Registration do } ) + ( + @typedoc "Options for the registration in BH." + @type bh :: %{optional(:type) => :standard} + ) + ( @typedoc "Options for the registration in CA." @type ca :: %{ @@ -89,55 +94,62 @@ defmodule Stripe.Tax.Registration do ( @typedoc "Specific options for a registration in the specified `country`." @type country_options :: %{ - optional(:vn) => vn, - optional(:lv) => lv, - optional(:cl) => cl, - optional(:se) => se, - optional(:pl) => pl, - optional(:nz) => nz, - optional(:lt) => lt, - optional(:de) => de, - optional(:fr) => fr, + optional(:is) => is, + optional(:th) => th, optional(:fi) => fi, + optional(:om) => om, + optional(:ee) => ee, + optional(:gr) => gr, optional(:sa) => sa, - optional(:es) => es, - optional(:sg) => sg, - optional(:tr) => tr, + optional(:bh) => bh, + optional(:be) => be, + optional(:mt) => mt, + optional(:fr) => fr, + optional(:eg) => eg, + optional(:pl) => pl, + optional(:de) => de, + optional(:ge) => ge, + optional(:co) => co, + optional(:kz) => kz, + optional(:ch) => ch, + optional(:se) => se, optional(:sk) => sk, - optional(:ie) => ie, - optional(:th) => th, optional(:us) => us, - optional(:co) => co, - optional(:ee) => ee, - optional(:hu) => hu, - optional(:it) => it, - optional(:jp) => jp, + optional(:cy) => cy, + optional(:au) => au, optional(:si) => si, + optional(:it) => it, + optional(:vn) => vn, + optional(:hr) => hr, + optional(:ro) => ro, + optional(:mx) => mx, + optional(:ie) => ie, + optional(:id) => id, + optional(:es) => es, + optional(:sg) => sg, + optional(:cl) => cl, + optional(:hu) => hu, optional(:kr) => kr, - optional(:gb) => gb, + optional(:ae) => ae, + optional(:ke) => ke, + optional(:jp) => jp, + optional(:lv) => lv, + optional(:no) => no, + optional(:cz) => cz, optional(:ca) => ca, + optional(:nz) => nz, optional(:dk) => dk, - optional(:nl) => nl, optional(:my) => my, - optional(:ae) => ae, - optional(:gr) => gr, - optional(:ch) => ch, - optional(:be) => be, - optional(:cz) => cz, - optional(:no) => no, + optional(:nl) => nl, optional(:lu) => lu, - optional(:cy) => cy, - optional(:au) => au, - optional(:mt) => mt, - optional(:is) => is, - optional(:bg) => bg, optional(:za) => za, - optional(:hr) => hr, - optional(:id) => id, - optional(:ro) => ro, - optional(:mx) => mx, - optional(:pt) => pt, - optional(:at) => at + optional(:lt) => lt, + optional(:bg) => bg, + optional(:tr) => tr, + optional(:at) => at, + optional(:ng) => ng, + optional(:gb) => gb, + optional(:pt) => pt } ) @@ -181,6 +193,11 @@ defmodule Stripe.Tax.Registration do } ) + ( + @typedoc "Options for the registration in EG." + @type eg :: %{optional(:type) => :simplified} + ) + ( @typedoc "Options for the registration in ES." @type es :: %{ @@ -210,6 +227,11 @@ defmodule Stripe.Tax.Registration do @type gb :: %{optional(:type) => :standard} ) + ( + @typedoc "Options for the registration in GE." + @type ge :: %{optional(:type) => :simplified} + ) + ( @typedoc "Options for the registration in GR." @type gr :: %{ @@ -265,11 +287,21 @@ defmodule Stripe.Tax.Registration do @type jp :: %{optional(:type) => :standard} ) + ( + @typedoc "Options for the registration in KE." + @type ke :: %{optional(:type) => :simplified} + ) + ( @typedoc "Options for the registration in KR." @type kr :: %{optional(:type) => :simplified} ) + ( + @typedoc "Options for the registration in KZ." + @type kz :: %{optional(:type) => :simplified} + ) + ( @typedoc "Options for the local amusement tax registration." @type local_amusement_tax :: %{optional(:jurisdiction) => binary} @@ -322,6 +354,11 @@ defmodule Stripe.Tax.Registration do @type my :: %{optional(:type) => :simplified} ) + ( + @typedoc "Options for the registration in NG." + @type ng :: %{optional(:type) => :simplified} + ) + ( @typedoc "Options for the registration in NL." @type nl :: %{ @@ -340,6 +377,11 @@ defmodule Stripe.Tax.Registration do @type nz :: %{optional(:type) => :standard} ) + ( + @typedoc "Options for the registration in OM." + @type om :: %{optional(:type) => :standard} + ) + ( @typedoc "Options for the registration in PL." @type pl :: %{ @@ -472,36 +514,6 @@ defmodule Stripe.Tax.Registration do ) ) - ( - nil - - @doc "

Creates a new Tax Registration object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/registrations`\n" - ( - @spec create( - params :: %{ - optional(:active_from) => :now | integer, - optional(:country) => binary, - optional(:country_options) => country_options, - optional(:expand) => list(binary), - optional(:expires_at) => integer - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Tax.Registration.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/registrations", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -546,6 +558,36 @@ defmodule Stripe.Tax.Registration do ) ) + ( + nil + + @doc "

Creates a new Tax Registration object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/registrations`\n" + ( + @spec create( + params :: %{ + optional(:active_from) => :now | integer, + optional(:country) => binary, + optional(:country_options) => country_options, + optional(:expand) => list(binary), + optional(:expires_at) => integer + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Tax.Registration.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/registrations", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -593,4 +635,4 @@ defmodule Stripe.Tax.Registration do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/tax__settings.ex b/lib/generated/tax__settings.ex index 60c98341..a8c70c10 100644 --- a/lib/generated/tax__settings.ex +++ b/lib/generated/tax__settings.ex @@ -85,4 +85,4 @@ defmodule Stripe.Tax.Settings do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/tax__transaction.ex b/lib/generated/tax__transaction.ex index 0c51a22d..8e047384 100644 --- a/lib/generated/tax__transaction.ex +++ b/lib/generated/tax__transaction.ex @@ -13,14 +13,16 @@ defmodule Stripe.Tax.Transaction do :livemode, :metadata, :object, + :posted_at, :reference, :reversal, + :ship_from_details, :shipping_cost, :tax_date, :type ] - @typedoc "The `tax.transaction` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.\n * `customer_details` \n * `id` Unique identifier for the transaction.\n * `line_items` The tax collected or refunded, by line item.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `reference` A custom unique identifier, such as 'myOrder_123'.\n * `reversal` If `type=reversal`, contains information about what was reversed.\n * `shipping_cost` The shipping cost details for the transaction.\n * `tax_date` Timestamp of date at which the tax rules and rates in effect applies for the calculation.\n * `type` If `reversal`, this transaction reverses an earlier transaction.\n" + @typedoc "The `tax.transaction` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.\n * `customer_details` \n * `id` Unique identifier for the transaction.\n * `line_items` The tax collected or refunded, by line item.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `posted_at` The Unix timestamp representing when the tax liability is assumed or reduced.\n * `reference` A custom unique identifier, such as 'myOrder_123'.\n * `reversal` If `type=reversal`, contains information about what was reversed.\n * `ship_from_details` The details of the ship from location, such as the address.\n * `shipping_cost` The shipping cost details for the transaction.\n * `tax_date` Timestamp of date at which the tax rules and rates in effect applies for the calculation.\n * `type` If `reversal`, this transaction reverses an earlier transaction.\n" @type t :: %__MODULE__{ created: integer, currency: binary, @@ -31,8 +33,10 @@ defmodule Stripe.Tax.Transaction do livemode: boolean, metadata: term | nil, object: binary, + posted_at: integer, reference: binary, reversal: term | nil, + ship_from_details: term | nil, shipping_cost: term | nil, tax_date: integer, type: binary @@ -103,32 +107,47 @@ defmodule Stripe.Tax.Transaction do ( nil - @doc "

Partially or fully reverses a previously created Transaction.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/transactions/create_reversal`\n" + @doc "

Retrieves the line items of a committed standalone transaction as a collection.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/tax/transactions/{transaction}/line_items`\n" ( - @spec create_reversal( + @spec list_line_items( + transaction :: binary(), params :: %{ + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:flat_amount) => integer, - optional(:line_items) => list(line_items), - optional(:metadata) => %{optional(binary) => binary}, - optional(:mode) => :full | :partial, - optional(:original_transaction) => binary, - optional(:reference) => binary, - optional(:shipping_cost) => shipping_cost + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.Tax.Transaction.t()} + {:ok, Stripe.List.t(Stripe.Tax.TransactionLineItem.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create_reversal(params \\ %{}, opts \\ []) do + def list_line_items(transaction, params \\ %{}, opts \\ []) do path = - Stripe.OpenApi.Path.replace_path_params("/v1/tax/transactions/create_reversal", [], []) + Stripe.OpenApi.Path.replace_path_params( + "/v1/tax/transactions/{transaction}/line_items", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "transaction", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "transaction", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [transaction] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -137,13 +156,14 @@ defmodule Stripe.Tax.Transaction do ( nil - @doc "

Creates a Tax Transaction from a calculation.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/transactions/create_from_calculation`\n" + @doc "

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/transactions/create_from_calculation`\n" ( @spec create_from_calculation( params :: %{ optional(:calculation) => binary, optional(:expand) => list(binary), optional(:metadata) => %{optional(binary) => binary}, + optional(:posted_at) => integer, optional(:reference) => binary }, opts :: Keyword.t() @@ -171,49 +191,34 @@ defmodule Stripe.Tax.Transaction do ( nil - @doc "

Retrieves the line items of a committed standalone transaction as a collection.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/tax/transactions/{transaction}/line_items`\n" + @doc "

Partially or fully reverses a previously created Transaction.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/transactions/create_reversal`\n" ( - @spec list_line_items( - transaction :: binary(), + @spec create_reversal( params :: %{ - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary + optional(:flat_amount) => integer, + optional(:line_items) => list(line_items), + optional(:metadata) => %{optional(binary) => binary}, + optional(:mode) => :full | :partial, + optional(:original_transaction) => binary, + optional(:reference) => binary, + optional(:shipping_cost) => shipping_cost }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Tax.TransactionLineItem.t())} + {:ok, Stripe.Tax.Transaction.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list_line_items(transaction, params \\ %{}, opts \\ []) do + def create_reversal(params \\ %{}, opts \\ []) do path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/tax/transactions/{transaction}/line_items", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "transaction", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "transaction", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [transaction] - ) + Stripe.OpenApi.Path.replace_path_params("/v1/tax/transactions/create_reversal", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/tax__transaction_line_item.ex b/lib/generated/tax__transaction_line_item.ex index 98f4433e..a6724a8d 100644 --- a/lib/generated/tax__transaction_line_item.ex +++ b/lib/generated/tax__transaction_line_item.ex @@ -18,7 +18,7 @@ defmodule Stripe.Tax.TransactionLineItem do :type ] - @typedoc "The `tax.transaction_line_item` type.\n\n * `amount` The line item amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.\n * `amount_tax` The amount of tax calculated for this line item, in integer cents.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `product` The ID of an existing [Product](https://stripe.com/docs/api/products/object).\n * `quantity` The number of units of the item being purchased. For reversals, this is the quantity reversed.\n * `reference` A custom identifier for this line item in the transaction.\n * `reversal` If `type=reversal`, contains information about what was reversed.\n * `tax_behavior` Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.\n * `tax_code` The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.\n * `type` If `reversal`, this line item reverses an earlier transaction.\n" + @typedoc "The `tax.transaction_line_item` type.\n\n * `amount` The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.\n * `amount_tax` The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `product` The ID of an existing [Product](https://stripe.com/docs/api/products/object).\n * `quantity` The number of units of the item being purchased. For reversals, this is the quantity reversed.\n * `reference` A custom identifier for this line item in the transaction.\n * `reversal` If `type=reversal`, contains information about what was reversed.\n * `tax_behavior` Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.\n * `tax_code` The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.\n * `type` If `reversal`, this line item reverses an earlier transaction.\n" @type t :: %__MODULE__{ amount: integer, amount_tax: integer, @@ -35,4 +35,4 @@ defmodule Stripe.Tax.TransactionLineItem do type: binary } ) -end +end \ No newline at end of file diff --git a/lib/generated/tax_code.ex b/lib/generated/tax_code.ex index 78b52804..9de1c238 100644 --- a/lib/generated/tax_code.ex +++ b/lib/generated/tax_code.ex @@ -78,4 +78,4 @@ defmodule Stripe.TaxCode do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/tax_id.ex b/lib/generated/tax_id.ex index 0ca70daa..60120163 100644 --- a/lib/generated/tax_id.ex +++ b/lib/generated/tax_id.ex @@ -10,12 +10,13 @@ defmodule Stripe.TaxId do :id, :livemode, :object, + :owner, :type, :value, :verification ] - @typedoc "The `tax_id` type.\n\n * `country` Two-letter ISO code representing the country of the tax ID.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` ID of the customer.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `type` Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`\n * `value` Value of the tax ID.\n * `verification` Tax ID verification information.\n" + @typedoc "The `tax_id` type.\n\n * `country` Two-letter ISO code representing the country of the tax ID.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `customer` ID of the customer.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `owner` The account or customer the tax ID belongs to.\n * `type` Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`\n * `value` Value of the tax ID.\n * `verification` Tax ID verification information.\n" @type t :: %__MODULE__{ country: binary | nil, created: integer, @@ -23,6 +24,7 @@ defmodule Stripe.TaxId do id: binary, livemode: boolean, object: binary, + owner: term | nil, type: binary, value: binary, verification: term | nil @@ -32,126 +34,11 @@ defmodule Stripe.TaxId do ( nil - @doc "

Creates a new tax_id object for a customer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers/{customer}/tax_ids`\n" - ( - @spec create( - customer :: binary(), - params :: %{ - optional(:expand) => list(binary), - optional(:type) => - :ad_nrt - | :ae_trn - | :ar_cuit - | :au_abn - | :au_arn - | :bg_uic - | :bo_tin - | :br_cnpj - | :br_cpf - | :ca_bn - | :ca_gst_hst - | :ca_pst_bc - | :ca_pst_mb - | :ca_pst_sk - | :ca_qst - | :ch_vat - | :cl_tin - | :cn_tin - | :co_nit - | :cr_tin - | :do_rcn - | :ec_ruc - | :eg_tin - | :es_cif - | :eu_oss_vat - | :eu_vat - | :gb_vat - | :ge_vat - | :hk_br - | :hu_tin - | :id_npwp - | :il_vat - | :in_gst - | :is_vat - | :jp_cn - | :jp_rn - | :jp_trn - | :ke_pin - | :kr_brn - | :li_uid - | :mx_rfc - | :my_frp - | :my_itn - | :my_sst - | :no_vat - | :nz_gst - | :pe_ruc - | :ph_tin - | :ro_tin - | :rs_pib - | :ru_inn - | :ru_kpp - | :sa_vat - | :sg_gst - | :sg_uen - | :si_tin - | :sv_nit - | :th_vat - | :tr_tin - | :tw_vat - | :ua_vat - | :us_ein - | :uy_ruc - | :ve_rif - | :vn_tin - | :za_vat, - optional(:value) => binary - }, - opts :: Keyword.t() - ) :: {:ok, Stripe.TaxId.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(customer, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/customers/{customer}/tax_ids", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "customer", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "customer", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [customer] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Retrieves the tax_id object with the given identifier.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/tax_ids/{id}`\n" + @doc "

Deletes an existing tax_id object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}/tax_ids/{id}`\n" ( - @spec retrieve( - customer :: binary(), - id :: binary(), - params :: %{optional(:expand) => list(binary)}, - opts :: Keyword.t() - ) :: {:ok, Stripe.TaxId.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(customer, id, params \\ %{}, opts \\ []) do + @spec delete(customer :: binary(), id :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedTaxId.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def delete(customer, id, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/customers/{customer}/tax_ids/{id}", @@ -188,8 +75,7 @@ defmodule Stripe.TaxId do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -247,11 +133,15 @@ defmodule Stripe.TaxId do ( nil - @doc "

Deletes an existing tax_id object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/customers/{customer}/tax_ids/{id}`\n" + @doc "

Retrieves the tax_id object with the given identifier.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/customers/{customer}/tax_ids/{id}`\n" ( - @spec delete(customer :: binary(), id :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedTaxId.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(customer, id, opts \\ []) do + @spec retrieve( + customer :: binary(), + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: {:ok, Stripe.TaxId.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def retrieve(customer, id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/customers/{customer}/tax_ids/{id}", @@ -288,9 +178,129 @@ defmodule Stripe.TaxId do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a new tax_id object for a customer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/customers/{customer}/tax_ids`\n" + ( + @spec create( + customer :: binary(), + params :: %{ + optional(:expand) => list(binary), + optional(:type) => + :ad_nrt + | :ae_trn + | :ar_cuit + | :au_abn + | :au_arn + | :bg_uic + | :bh_vat + | :bo_tin + | :br_cnpj + | :br_cpf + | :ca_bn + | :ca_gst_hst + | :ca_pst_bc + | :ca_pst_mb + | :ca_pst_sk + | :ca_qst + | :ch_uid + | :ch_vat + | :cl_tin + | :cn_tin + | :co_nit + | :cr_tin + | :de_stn + | :do_rcn + | :ec_ruc + | :eg_tin + | :es_cif + | :eu_oss_vat + | :eu_vat + | :gb_vat + | :ge_vat + | :hk_br + | :hr_oib + | :hu_tin + | :id_npwp + | :il_vat + | :in_gst + | :is_vat + | :jp_cn + | :jp_rn + | :jp_trn + | :ke_pin + | :kr_brn + | :kz_bin + | :li_uid + | :mx_rfc + | :my_frp + | :my_itn + | :my_sst + | :ng_tin + | :no_vat + | :no_voec + | :nz_gst + | :om_vat + | :pe_ruc + | :ph_tin + | :ro_tin + | :rs_pib + | :ru_inn + | :ru_kpp + | :sa_vat + | :sg_gst + | :sg_uen + | :si_tin + | :sv_nit + | :th_vat + | :tr_tin + | :tw_vat + | :ua_vat + | :us_ein + | :uy_ruc + | :ve_rif + | :vn_tin + | :za_vat, + optional(:value) => binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.TaxId.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(customer, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/customers/{customer}/tax_ids", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "customer", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "customer", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [customer] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/tax_rate.ex b/lib/generated/tax_rate.ex index f2126015..c2b6b314 100644 --- a/lib/generated/tax_rate.ex +++ b/lib/generated/tax_rate.ex @@ -13,6 +13,7 @@ defmodule Stripe.TaxRate do :id, :inclusive, :jurisdiction, + :jurisdiction_level, :livemode, :metadata, :object, @@ -21,7 +22,7 @@ defmodule Stripe.TaxRate do :tax_type ] - @typedoc "The `tax_rate` type.\n\n * `active` Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.\n * `country` Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `description` An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.\n * `display_name` The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.\n * `effective_percentage` Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction.\n * `id` Unique identifier for the object.\n * `inclusive` This specifies if the tax rate is inclusive or exclusive.\n * `jurisdiction` The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `percentage` Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.\n * `state` [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.\n * `tax_type` The high-level tax type, such as `vat` or `sales_tax`.\n" + @typedoc "The `tax_rate` type.\n\n * `active` Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.\n * `country` Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `description` An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.\n * `display_name` The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.\n * `effective_percentage` Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction.\n * `id` Unique identifier for the object.\n * `inclusive` This specifies if the tax rate is inclusive or exclusive.\n * `jurisdiction` The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.\n * `jurisdiction_level` The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `percentage` Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.\n * `state` [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.\n * `tax_type` The high-level tax type, such as `vat` or `sales_tax`.\n" @type t :: %__MODULE__{ active: boolean, country: binary | nil, @@ -32,6 +33,7 @@ defmodule Stripe.TaxRate do id: binary, inclusive: boolean, jurisdiction: binary | nil, + jurisdiction_level: binary | nil, livemode: boolean, metadata: term | nil, object: binary, @@ -153,7 +155,6 @@ defmodule Stripe.TaxRate do | :qst | :rst | :sales_tax - | :service_tax | :vat }, opts :: Keyword.t() @@ -198,7 +199,6 @@ defmodule Stripe.TaxRate do | :qst | :rst | :sales_tax - | :service_tax | :vat }, opts :: Keyword.t() @@ -233,4 +233,4 @@ defmodule Stripe.TaxRate do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/terminal__configuration.ex b/lib/generated/terminal__configuration.ex index 21e2719b..5ee382ab 100644 --- a/lib/generated/terminal__configuration.ex +++ b/lib/generated/terminal__configuration.ex @@ -8,20 +8,26 @@ defmodule Stripe.Terminal.Configuration do :id, :is_account_default, :livemode, + :name, :object, :offline, + :reboot_window, + :stripe_s700, :tipping, :verifone_p400 ] - @typedoc "The `terminal.configuration` type.\n\n * `bbpos_wisepos_e` \n * `id` Unique identifier for the object.\n * `is_account_default` Whether this Configuration is the default for your account\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `offline` \n * `tipping` \n * `verifone_p400` \n" + @typedoc "The `terminal.configuration` type.\n\n * `bbpos_wisepos_e` \n * `id` Unique identifier for the object.\n * `is_account_default` Whether this Configuration is the default for your account\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `name` String indicating the name of the Configuration object, set by the user\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `offline` \n * `reboot_window` \n * `stripe_s700` \n * `tipping` \n * `verifone_p400` \n" @type t :: %__MODULE__{ bbpos_wisepos_e: term, id: binary, is_account_default: boolean | nil, livemode: boolean, + name: binary | nil, object: binary, offline: term, + reboot_window: term, + stripe_s700: term, tipping: term, verifone_p400: term } @@ -136,6 +142,11 @@ defmodule Stripe.Terminal.Configuration do @type offline :: %{optional(:enabled) => boolean} ) + ( + @typedoc "Reboot time settings for readers that support customized reboot time configuration." + @type reboot_window :: %{optional(:end_hour) => integer, optional(:start_hour) => integer} + ) + ( @typedoc "Tipping configuration for SEK" @type sek :: %{ @@ -154,6 +165,11 @@ defmodule Stripe.Terminal.Configuration do } ) + ( + @typedoc "An object containing device type specific settings for Stripe S700 readers" + @type stripe_s700 :: %{optional(:splashscreen) => binary | binary} + ) + ( @typedoc nil @type tipping :: %{ @@ -191,28 +207,37 @@ defmodule Stripe.Terminal.Configuration do ( nil - @doc "

Creates a new Configuration object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/configurations`\n" + @doc "

Deletes a Configuration object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/terminal/configurations/{configuration}`\n" ( - @spec create( - params :: %{ - optional(:bbpos_wisepos_e) => bbpos_wisepos_e, - optional(:expand) => list(binary), - optional(:offline) => offline | binary, - optional(:tipping) => tipping | binary, - optional(:verifone_p400) => verifone_p400 - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Terminal.Configuration.t()} + @spec delete(configuration :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedTerminal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/terminal/configurations", [], []) + def delete(configuration, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/terminal/configurations/{configuration}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "configuration", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "configuration", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [configuration] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -295,43 +320,26 @@ defmodule Stripe.Terminal.Configuration do ( nil - @doc "

Updates a new Configuration object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/configurations/{configuration}`\n" + @doc "

Creates a new Configuration object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/configurations`\n" ( - @spec update( - configuration :: binary(), + @spec create( params :: %{ - optional(:bbpos_wisepos_e) => bbpos_wisepos_e | binary, + optional(:bbpos_wisepos_e) => bbpos_wisepos_e, optional(:expand) => list(binary), + optional(:name) => binary, optional(:offline) => offline | binary, + optional(:reboot_window) => reboot_window, + optional(:stripe_s700) => stripe_s700, optional(:tipping) => tipping | binary, - optional(:verifone_p400) => verifone_p400 | binary + optional(:verifone_p400) => verifone_p400 }, opts :: Keyword.t() ) :: - {:ok, Stripe.Terminal.Configuration.t() | Stripe.DeletedTerminal.Configuration.t()} + {:ok, Stripe.Terminal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(configuration, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/terminal/configurations/{configuration}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "configuration", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "configuration", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [configuration] - ) + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/terminal/configurations", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) @@ -345,13 +353,26 @@ defmodule Stripe.Terminal.Configuration do ( nil - @doc "

Deletes a Configuration object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/terminal/configurations/{configuration}`\n" + @doc "

Updates a new Configuration object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/configurations/{configuration}`\n" ( - @spec delete(configuration :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedTerminal.Configuration.t()} + @spec update( + configuration :: binary(), + params :: %{ + optional(:bbpos_wisepos_e) => bbpos_wisepos_e | binary, + optional(:expand) => list(binary), + optional(:name) => binary, + optional(:offline) => offline | binary, + optional(:reboot_window) => reboot_window | binary, + optional(:stripe_s700) => stripe_s700 | binary, + optional(:tipping) => tipping | binary, + optional(:verifone_p400) => verifone_p400 | binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Terminal.Configuration.t() | Stripe.DeletedTerminal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(configuration, opts \\ []) do + def update(configuration, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/terminal/configurations/{configuration}", @@ -375,9 +396,10 @@ defmodule Stripe.Terminal.Configuration do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/terminal__connection_token.ex b/lib/generated/terminal__connection_token.ex index a534a877..f62b8529 100644 --- a/lib/generated/terminal__connection_token.ex +++ b/lib/generated/terminal__connection_token.ex @@ -5,7 +5,7 @@ defmodule Stripe.Terminal.ConnectionToken do ( defstruct [:location, :object, :secret] - @typedoc "The `terminal.connection_token` type.\n\n * `location` The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens).\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `secret` Your application should pass this token to the Stripe Terminal SDK.\n" + @typedoc "The `terminal.connection_token` type.\n\n * `location` The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `secret` Your application should pass this token to the Stripe Terminal SDK.\n" @type t :: %__MODULE__{location: binary, object: binary, secret: binary} ) @@ -32,4 +32,4 @@ defmodule Stripe.Terminal.ConnectionToken do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/terminal__location.ex b/lib/generated/terminal__location.ex index 291c9dd1..643645b5 100644 --- a/lib/generated/terminal__location.ex +++ b/lib/generated/terminal__location.ex @@ -40,17 +40,13 @@ defmodule Stripe.Terminal.Location do ( nil - @doc "

Retrieves a Location object.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/terminal/locations/{location}`\n" + @doc "

Deletes a Location object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/terminal/locations/{location}`\n" ( - @spec retrieve( - location :: binary(), - params :: %{optional(:expand) => list(binary)}, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Terminal.Location.t() | Stripe.DeletedTerminal.Location.t()} + @spec delete(location :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedTerminal.Location.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(location, params \\ %{}, opts \\ []) do + def delete(location, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/terminal/locations/{location}", @@ -74,8 +70,7 @@ defmodule Stripe.Terminal.Location do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -84,28 +79,27 @@ defmodule Stripe.Terminal.Location do ( nil - @doc "

Creates a new Location object.\nFor further details, including which address fields are required in each country, see the Manage locations guide.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/locations`\n" + @doc "

Returns a list of Location objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/terminal/locations`\n" ( - @spec create( + @spec list( params :: %{ - optional(:address) => address, - optional(:configuration_overrides) => binary, - optional(:display_name) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.Terminal.Location.t()} + {:ok, Stripe.List.t(Stripe.Terminal.Location.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/terminal/locations", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -114,23 +108,17 @@ defmodule Stripe.Terminal.Location do ( nil - @doc "

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/locations/{location}`\n" + @doc "

Retrieves a Location object.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/terminal/locations/{location}`\n" ( - @spec update( + @spec retrieve( location :: binary(), - params :: %{ - optional(:address) => address, - optional(:configuration_overrides) => binary | binary, - optional(:display_name) => binary, - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Terminal.Location.t() | Stripe.DeletedTerminal.Location.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(location, params \\ %{}, opts \\ []) do + def retrieve(location, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/terminal/locations/{location}", @@ -155,7 +143,7 @@ defmodule Stripe.Terminal.Location do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -164,27 +152,28 @@ defmodule Stripe.Terminal.Location do ( nil - @doc "

Returns a list of Location objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/terminal/locations`\n" + @doc "

Creates a new Location object.\nFor further details, including which address fields are required in each country, see the Manage locations guide.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/locations`\n" ( - @spec list( + @spec create( params :: %{ - optional(:ending_before) => binary, + optional(:address) => address, + optional(:configuration_overrides) => binary, + optional(:display_name) => binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary + optional(:metadata) => %{optional(binary) => binary} | binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Terminal.Location.t())} + {:ok, Stripe.Terminal.Location.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/terminal/locations", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -193,13 +182,23 @@ defmodule Stripe.Terminal.Location do ( nil - @doc "

Deletes a Location object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/terminal/locations/{location}`\n" + @doc "

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/locations/{location}`\n" ( - @spec delete(location :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedTerminal.Location.t()} + @spec update( + location :: binary(), + params :: %{ + optional(:address) => address, + optional(:configuration_overrides) => binary | binary, + optional(:display_name) => binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Terminal.Location.t() | Stripe.DeletedTerminal.Location.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(location, opts \\ []) do + def update(location, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/terminal/locations/{location}", @@ -223,9 +222,10 @@ defmodule Stripe.Terminal.Location do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/terminal__reader.ex b/lib/generated/terminal__reader.ex index bc6e451f..ca5ab70b 100644 --- a/lib/generated/terminal__reader.ex +++ b/lib/generated/terminal__reader.ex @@ -18,7 +18,7 @@ defmodule Stripe.Terminal.Reader do :status ] - @typedoc "The `terminal.reader` type.\n\n * `action` The most recent action performed by the reader.\n * `device_sw_version` The current software version of the reader.\n * `device_type` Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`.\n * `id` Unique identifier for the object.\n * `ip_address` The local IP address of the reader.\n * `label` Custom label given to the reader for easier identification.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `location` The location identifier of the reader.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `serial_number` Serial number of the reader.\n * `status` The networking status of the reader.\n" + @typedoc "The `terminal.reader` type.\n\n * `action` The most recent action performed by the reader.\n * `device_sw_version` The current software version of the reader.\n * `device_type` Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.\n * `id` Unique identifier for the object.\n * `ip_address` The local IP address of the reader.\n * `label` Custom label given to the reader for easier identification.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `location` The location identifier of the reader.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `serial_number` Serial number of the reader.\n * `status` The networking status of the reader. We do not recommend using this field in flows that may block taking payments.\n" @type t :: %__MODULE__{ action: term | nil, device_sw_version: binary | nil, @@ -66,7 +66,16 @@ defmodule Stripe.Terminal.Reader do ( @typedoc "Configuration overrides" - @type process_config :: %{optional(:skip_tipping) => boolean, optional(:tipping) => tipping} + @type process_config :: %{ + optional(:enable_customer_cancellation) => boolean, + optional(:skip_tipping) => boolean, + optional(:tipping) => tipping + } + ) + + ( + @typedoc "Configuration overrides" + @type refund_payment_config :: %{optional(:enable_customer_cancellation) => boolean} ) ( @@ -77,21 +86,13 @@ defmodule Stripe.Terminal.Reader do ( nil - @doc "

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}`\n" + @doc "

Deletes a Reader object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/terminal/readers/{reader}`\n" ( - @spec update( - reader :: binary(), - params :: %{ - optional(:expand) => list(binary), - optional(:label) => binary | binary, - optional(:metadata) => %{optional(binary) => binary} | binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Terminal.Reader.t() | Stripe.DeletedTerminal.Reader.t()} + @spec delete(reader :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedTerminal.Reader.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(reader, params \\ %{}, opts \\ []) do + def delete(reader, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/terminal/readers/{reader}", @@ -113,10 +114,50 @@ defmodule Stripe.Terminal.Reader do [reader] ) + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Returns a list of Reader objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/terminal/readers`\n" + ( + @spec list( + params :: %{ + optional(:device_type) => + :bbpos_chipper2x + | :bbpos_wisepad3 + | :bbpos_wisepos_e + | :mobile_phone_reader + | :simulated_wisepos_e + | :stripe_m2 + | :stripe_s700 + | :verifone_P400, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:location) => binary, + optional(:serial_number) => binary, + optional(:starting_after) => binary, + optional(:status) => :offline | :online + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Terminal.Reader.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/terminal/readers", [], []) + Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -199,52 +240,21 @@ defmodule Stripe.Terminal.Reader do ( nil - @doc "

Returns a list of Reader objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/terminal/readers`\n" + @doc "

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}`\n" ( - @spec list( + @spec update( + reader :: binary(), params :: %{ - optional(:device_type) => - :bbpos_chipper2x - | :bbpos_wisepad3 - | :bbpos_wisepos_e - | :simulated_wisepos_e - | :stripe_m2 - | :verifone_P400, - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:location) => binary, - optional(:serial_number) => binary, - optional(:starting_after) => binary, - optional(:status) => :offline | :online + optional(:label) => binary | binary, + optional(:metadata) => %{optional(binary) => binary} | binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Terminal.Reader.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/terminal/readers", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Deletes a Reader object.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/terminal/readers/{reader}`\n" - ( - @spec delete(reader :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedTerminal.Reader.t()} + {:ok, Stripe.Terminal.Reader.t() | Stripe.DeletedTerminal.Reader.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(reader, opts \\ []) do + def update(reader, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/terminal/readers/{reader}", @@ -268,7 +278,8 @@ defmodule Stripe.Terminal.Reader do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -277,24 +288,20 @@ defmodule Stripe.Terminal.Reader do ( nil - @doc "

Initiates a payment flow on a Reader.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/process_payment_intent`\n" + @doc "

Cancels the current reader action.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/cancel_action`\n" ( - @spec process_payment_intent( + @spec cancel_action( reader :: binary(), - params :: %{ - optional(:expand) => list(binary), - optional(:payment_intent) => binary, - optional(:process_config) => process_config - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Terminal.Reader.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def process_payment_intent(reader, params \\ %{}, opts \\ []) do + def cancel_action(reader, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/terminal/readers/{reader}/process_payment_intent", + "/v1/terminal/readers/{reader}/cancel_action", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -325,25 +332,24 @@ defmodule Stripe.Terminal.Reader do ( nil - @doc "

Initiates a setup intent flow on a Reader.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/process_setup_intent`\n" + @doc "

Initiates a payment flow on a Reader.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/process_payment_intent`\n" ( - @spec process_setup_intent( + @spec process_payment_intent( reader :: binary(), params :: %{ - optional(:customer_consent_collected) => boolean, optional(:expand) => list(binary), - optional(:process_config) => map(), - optional(:setup_intent) => binary + optional(:payment_intent) => binary, + optional(:process_config) => process_config }, opts :: Keyword.t() ) :: {:ok, Stripe.Terminal.Reader.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def process_setup_intent(reader, params \\ %{}, opts \\ []) do + def process_payment_intent(reader, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/terminal/readers/{reader}/process_setup_intent", + "/v1/terminal/readers/{reader}/process_payment_intent", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -374,20 +380,25 @@ defmodule Stripe.Terminal.Reader do ( nil - @doc "

Cancels the current reader action.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/cancel_action`\n" + @doc "

Initiates a setup intent flow on a Reader.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/process_setup_intent`\n" ( - @spec cancel_action( + @spec process_setup_intent( reader :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:customer_consent_collected) => boolean, + optional(:expand) => list(binary), + optional(:process_config) => process_config, + optional(:setup_intent) => binary + }, opts :: Keyword.t() ) :: {:ok, Stripe.Terminal.Reader.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def cancel_action(reader, params \\ %{}, opts \\ []) do + def process_setup_intent(reader, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/terminal/readers/{reader}/cancel_action", + "/v1/terminal/readers/{reader}/process_setup_intent", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -418,24 +429,29 @@ defmodule Stripe.Terminal.Reader do ( nil - @doc "

Sets reader display to show cart details.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/set_reader_display`\n" + @doc "

Initiates a refund on a Reader

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/refund_payment`\n" ( - @spec set_reader_display( + @spec refund_payment( reader :: binary(), params :: %{ - optional(:cart) => cart, + optional(:amount) => integer, + optional(:charge) => binary, optional(:expand) => list(binary), - optional(:type) => :cart + optional(:metadata) => %{optional(binary) => binary}, + optional(:payment_intent) => binary, + optional(:refund_application_fee) => boolean, + optional(:refund_payment_config) => refund_payment_config, + optional(:reverse_transfer) => boolean }, opts :: Keyword.t() ) :: {:ok, Stripe.Terminal.Reader.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def set_reader_display(reader, params \\ %{}, opts \\ []) do + def refund_payment(reader, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/terminal/readers/{reader}/set_reader_display", + "/v1/terminal/readers/{reader}/refund_payment", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -466,28 +482,24 @@ defmodule Stripe.Terminal.Reader do ( nil - @doc "

Initiates a refund on a Reader

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/refund_payment`\n" + @doc "

Sets reader display to show cart details.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/readers/{reader}/set_reader_display`\n" ( - @spec refund_payment( + @spec set_reader_display( reader :: binary(), params :: %{ - optional(:amount) => integer, - optional(:charge) => binary, + optional(:cart) => cart, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:payment_intent) => binary, - optional(:refund_application_fee) => boolean, - optional(:reverse_transfer) => boolean + optional(:type) => :cart }, opts :: Keyword.t() ) :: {:ok, Stripe.Terminal.Reader.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def refund_payment(reader, params \\ %{}, opts \\ []) do + def set_reader_display(reader, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/terminal/readers/{reader}/refund_payment", + "/v1/terminal/readers/{reader}/set_reader_display", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -564,4 +576,4 @@ defmodule Stripe.Terminal.Reader do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/test_helpers__test_clock.ex b/lib/generated/test_helpers__test_clock.ex index ecbb944a..992ef674 100644 --- a/lib/generated/test_helpers__test_clock.ex +++ b/lib/generated/test_helpers__test_clock.ex @@ -3,9 +3,19 @@ defmodule Stripe.TestHelpers.TestClock do @moduledoc "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time." ( - defstruct [:created, :deletes_after, :frozen_time, :id, :livemode, :name, :object, :status] - - @typedoc "The `test_helpers.test_clock` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `deletes_after` Time at which this clock is scheduled to auto delete.\n * `frozen_time` Time at which all objects belonging to this clock are frozen.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `name` The custom name supplied at creation.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The status of the Test Clock.\n" + defstruct [ + :created, + :deletes_after, + :frozen_time, + :id, + :livemode, + :name, + :object, + :status, + :status_details + ] + + @typedoc "The `test_helpers.test_clock` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `deletes_after` Time at which this clock is scheduled to auto delete.\n * `frozen_time` Time at which all objects belonging to this clock are frozen.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `name` The custom name supplied at creation.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The status of the Test Clock.\n * `status_details` \n" @type t :: %__MODULE__{ created: integer, deletes_after: integer, @@ -14,24 +24,21 @@ defmodule Stripe.TestHelpers.TestClock do livemode: boolean, name: binary | nil, object: binary, - status: binary + status: binary, + status_details: term } ) ( nil - @doc "

Retrieves a test clock.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/test_helpers/test_clocks/{test_clock}`\n" + @doc "

Deletes a test clock.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/test_helpers/test_clocks/{test_clock}`\n" ( - @spec retrieve( - test_clock :: binary(), - params :: %{optional(:expand) => list(binary)}, - opts :: Keyword.t() - ) :: - {:ok, Stripe.TestHelpers.TestClock.t()} + @spec delete(test_clock :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedTestHelpers.TestClock.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(test_clock, params \\ %{}, opts \\ []) do + def delete(test_clock, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/test_helpers/test_clocks/{test_clock}", @@ -55,8 +62,7 @@ defmodule Stripe.TestHelpers.TestClock do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:delete) |> Stripe.Request.make_request() end ) @@ -65,26 +71,27 @@ defmodule Stripe.TestHelpers.TestClock do ( nil - @doc "

Creates a new test clock that can be attached to new customers and quotes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/test_clocks`\n" + @doc "

Returns a list of your test clocks.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/test_helpers/test_clocks`\n" ( - @spec create( + @spec list( params :: %{ + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:frozen_time) => integer, - optional(:name) => binary + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.TestHelpers.TestClock.t()} + {:ok, Stripe.List.t(Stripe.TestHelpers.TestClock.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/test_helpers/test_clocks", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -93,13 +100,17 @@ defmodule Stripe.TestHelpers.TestClock do ( nil - @doc "

Deletes a test clock.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/test_helpers/test_clocks/{test_clock}`\n" + @doc "

Retrieves a test clock.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/test_helpers/test_clocks/{test_clock}`\n" ( - @spec delete(test_clock :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedTestHelpers.TestClock.t()} + @spec retrieve( + test_clock :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.TestHelpers.TestClock.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def delete(test_clock, opts \\ []) do + def retrieve(test_clock, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/test_helpers/test_clocks/{test_clock}", @@ -123,7 +134,36 @@ defmodule Stripe.TestHelpers.TestClock do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a new test clock that can be attached to new customers and quotes.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/test_clocks`\n" + ( + @spec create( + params :: %{ + optional(:expand) => list(binary), + optional(:frozen_time) => integer, + optional(:name) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.TestHelpers.TestClock.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/test_helpers/test_clocks", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -172,33 +212,4 @@ defmodule Stripe.TestHelpers.TestClock do end ) ) - - ( - nil - - @doc "

Returns a list of your test clocks.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/test_helpers/test_clocks`\n" - ( - @spec list( - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.TestHelpers.TestClock.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/test_helpers/test_clocks", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/token.ex b/lib/generated/token.ex index 835b58e6..c898578c 100644 --- a/lib/generated/token.ex +++ b/lib/generated/token.ex @@ -1,7 +1,7 @@ defmodule Stripe.Token do use Stripe.Entity - @moduledoc "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [Custom accounts](https://stripe.com/docs/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization." + @moduledoc "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization." ( defstruct [:bank_account, :card, :client_ip, :created, :id, :livemode, :object, :type, :used] @@ -20,11 +20,12 @@ defmodule Stripe.Token do ) ( - @typedoc "Details on the legal guardian's acceptance of the main Stripe service agreement." + @typedoc "Information for the account this token represents." @type account :: %{ - optional(:date) => integer, - optional(:ip) => binary, - optional(:user_agent) => binary | binary + optional(:business_type) => :company | :government_entity | :individual | :non_profit, + optional(:company) => company, + optional(:individual) => individual, + optional(:tos_shown_and_accepted) => boolean } ) @@ -34,7 +35,7 @@ defmodule Stripe.Token do ) ( - @typedoc "Details on the legal guardian's acceptance of the required Stripe agreements." + @typedoc "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements." @type additional_tos_acceptances :: %{optional(:account) => account} ) @@ -51,7 +52,7 @@ defmodule Stripe.Token do ) ( - @typedoc "The Kana variation of the the individual's primary address (Japan only)." + @typedoc "The Kana variation of the individual's primary address (Japan only)." @type address_kana :: %{ optional(:city) => binary, optional(:country) => binary, @@ -64,7 +65,7 @@ defmodule Stripe.Token do ) ( - @typedoc "The Kanji variation of the person's address (Japan only)." + @typedoc "The Kanji variation of the individual's primary address (Japan only)." @type address_kanji :: %{ optional(:city) => binary, optional(:country) => binary, @@ -85,6 +86,7 @@ defmodule Stripe.Token do optional(:account_type) => :checking | :futsu | :savings | :toza, optional(:country) => binary, optional(:currency) => binary, + optional(:payment_method) => binary, optional(:routing_number) => binary } ) @@ -103,6 +105,7 @@ defmodule Stripe.Token do optional(:exp_month) => binary, optional(:exp_year) => binary, optional(:name) => binary, + optional(:networks) => networks, optional(:number) => binary } ) @@ -141,6 +144,7 @@ defmodule Stripe.Token do | :public_company | :public_corporation | :public_partnership + | :registered_charity | :single_member_llc | :sole_establishment | :sole_proprietorship @@ -175,7 +179,7 @@ defmodule Stripe.Token do ) ( - @typedoc "A document verifying the business." + @typedoc "An identifying document, either a passport or local ID card." @type document :: %{optional(:back) => binary, optional(:front) => binary} ) @@ -211,11 +215,17 @@ defmodule Stripe.Token do optional(:phone) => binary, optional(:political_exposure) => :existing | :none, optional(:registered_address) => registered_address, + optional(:relationship) => relationship, optional(:ssn_last_4) => binary, optional(:verification) => verification } ) + ( + @typedoc "Contains information about card networks used to process the payment." + @type networks :: %{optional(:preferred) => :cartes_bancaires | :mastercard | :visa} + ) + ( @typedoc "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct." @type ownership_declaration :: %{ @@ -268,7 +278,7 @@ defmodule Stripe.Token do ) ( - @typedoc "The individual's registered address." + @typedoc "The person's registered address." @type registered_address :: %{ optional(:city) => binary, optional(:country) => binary, @@ -280,14 +290,12 @@ defmodule Stripe.Token do ) ( - @typedoc "The relationship that this person has with the account's legal entity." + @typedoc "Describes the person’s relationship to the account." @type relationship :: %{ optional(:director) => boolean, optional(:executive) => boolean, - optional(:legal_guardian) => boolean, optional(:owner) => boolean, optional(:percent_ownership) => number | binary, - optional(:representative) => boolean, optional(:title) => binary } ) @@ -346,7 +354,7 @@ defmodule Stripe.Token do ( nil - @doc "

Creates a single-use token that represents a bank account’s details.\nYou can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tokens`\n" + @doc "

Creates a single-use token that represents a bank account’s details.\nYou can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tokens`\n" ( @spec create( params :: %{ @@ -372,4 +380,4 @@ defmodule Stripe.Token do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/topup.ex b/lib/generated/topup.ex index 88e54bfc..feb82e41 100644 --- a/lib/generated/topup.ex +++ b/lib/generated/topup.ex @@ -63,36 +63,6 @@ defmodule Stripe.Topup do } ) - ( - nil - - @doc "

Top up the balance of an account

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/topups`\n" - ( - @spec create( - params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, - optional(:description) => binary, - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:source) => binary, - optional(:statement_descriptor) => binary, - optional(:transfer_group) => binary - }, - opts :: Keyword.t() - ) :: {:ok, Stripe.Topup.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/topups", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -166,6 +136,36 @@ defmodule Stripe.Topup do ) ) + ( + nil + + @doc "

Top up the balance of an account

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/topups`\n" + ( + @spec create( + params :: %{ + optional(:amount) => integer, + optional(:currency) => binary, + optional(:description) => binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:source) => binary, + optional(:statement_descriptor) => binary, + optional(:transfer_group) => binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Topup.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/topups", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -251,4 +251,4 @@ defmodule Stripe.Topup do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/transfer.ex b/lib/generated/transfer.ex index 86c6faf5..ee32ec87 100644 --- a/lib/generated/transfer.ex +++ b/lib/generated/transfer.ex @@ -23,7 +23,7 @@ defmodule Stripe.Transfer do :transfer_group ] - @typedoc "The `transfer` type.\n\n * `amount` Amount in cents (or local equivalent) to be transferred.\n * `amount_reversed` Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).\n * `balance_transaction` Balance transaction that describes the impact of this transfer on your account balance.\n * `created` Time that this record of the transfer was first created.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination` ID of the Stripe account the transfer was sent to.\n * `destination_payment` If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `reversals` A list of reversals that have been applied to the transfer.\n * `reversed` Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.\n * `source_transaction` ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.\n * `source_type` The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.\n * `transfer_group` A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.\n" + @typedoc "The `transfer` type.\n\n * `amount` Amount in cents (or local equivalent) to be transferred.\n * `amount_reversed` Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).\n * `balance_transaction` Balance transaction that describes the impact of this transfer on your account balance.\n * `created` Time that this record of the transfer was first created.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination` ID of the Stripe account the transfer was sent to.\n * `destination_payment` If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `reversals` A list of reversals that have been applied to the transfer.\n * `reversed` Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.\n * `source_transaction` ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.\n * `source_type` The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.\n * `transfer_group` A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.\n" @type t :: %__MODULE__{ amount: integer, amount_reversed: integer, @@ -55,37 +55,6 @@ defmodule Stripe.Transfer do } ) - ( - nil - - @doc "

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/transfers`\n" - ( - @spec create( - params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, - optional(:description) => binary, - optional(:destination) => binary, - optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:source_transaction) => binary, - optional(:source_type) => :bank_account | :card | :fpx, - optional(:transfer_group) => binary - }, - opts :: Keyword.t() - ) :: {:ok, Stripe.Transfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/transfers", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - ( nil @@ -159,6 +128,37 @@ defmodule Stripe.Transfer do ) ) + ( + nil + + @doc "

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/transfers`\n" + ( + @spec create( + params :: %{ + optional(:amount) => integer, + optional(:currency) => binary, + optional(:description) => binary, + optional(:destination) => binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary}, + optional(:source_transaction) => binary, + optional(:source_type) => :bank_account | :card | :fpx, + optional(:transfer_group) => binary + }, + opts :: Keyword.t() + ) :: {:ok, Stripe.Transfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/transfers", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -203,4 +203,4 @@ defmodule Stripe.Transfer do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/transfer_reversal.ex b/lib/generated/transfer_reversal.ex index 19928443..72858c64 100644 --- a/lib/generated/transfer_reversal.ex +++ b/lib/generated/transfer_reversal.ex @@ -1,7 +1,7 @@ defmodule Stripe.TransferReversal do use Stripe.Entity - @moduledoc "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers)" + @moduledoc "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)" ( defstruct [ :amount, @@ -34,23 +34,22 @@ defmodule Stripe.TransferReversal do ( nil - @doc "

When you create a new reversal, you must specify a transfer to create it on.

\n\n

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

\n\n

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/transfers/{id}/reversals`\n" + @doc "

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/transfers/{id}/reversals`\n" ( - @spec create( + @spec list( id :: binary(), params :: %{ - optional(:amount) => integer, - optional(:description) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary} | binary, - optional(:refund_application_fee) => boolean + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.TransferReversal.t()} + {:ok, Stripe.List.t(Stripe.TransferReversal.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(id, params \\ %{}, opts \\ []) do + def list(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/transfers/{id}/reversals", @@ -75,7 +74,7 @@ defmodule Stripe.TransferReversal do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -84,25 +83,21 @@ defmodule Stripe.TransferReversal do ( nil - @doc "

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/transfers/{id}/reversals`\n" + @doc "

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/transfers/{transfer}/reversals/{id}`\n" ( - @spec list( + @spec retrieve( id :: binary(), - params :: %{ - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary - }, + transfer :: binary(), + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.TransferReversal.t())} + {:ok, Stripe.TransferReversal.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(id, params \\ %{}, opts \\ []) do + def retrieve(id, transfer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/transfers/{id}/reversals", + "/v1/transfers/{transfer}/reversals/{id}", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -116,9 +111,22 @@ defmodule Stripe.TransferReversal do properties: [], any_of: [] } + }, + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "transfer", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "transfer", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } } ], - [id] + [id, transfer] ) Stripe.Request.new_request(opts) @@ -133,21 +141,26 @@ defmodule Stripe.TransferReversal do ( nil - @doc "

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/transfers/{transfer}/reversals/{id}`\n" + @doc "

When you create a new reversal, you must specify a transfer to create it on.

\n\n

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

\n\n

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/transfers/{id}/reversals`\n" ( - @spec retrieve( + @spec create( id :: binary(), - transfer :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:amount) => integer, + optional(:description) => binary, + optional(:expand) => list(binary), + optional(:metadata) => %{optional(binary) => binary} | binary, + optional(:refund_application_fee) => boolean + }, opts :: Keyword.t() ) :: {:ok, Stripe.TransferReversal.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(id, transfer, params \\ %{}, opts \\ []) do + def create(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/transfers/{transfer}/reversals/{id}", + "/v1/transfers/{id}/reversals", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -161,28 +174,15 @@ defmodule Stripe.TransferReversal do properties: [], any_of: [] } - }, - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "transfer", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "transfer", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } } ], - [id, transfer] + [id] ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -248,4 +248,4 @@ defmodule Stripe.TransferReversal do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__credit_reversal.ex b/lib/generated/treasury__credit_reversal.ex index 304bd8fb..1a8ce33f 100644 --- a/lib/generated/treasury__credit_reversal.ex +++ b/lib/generated/treasury__credit_reversal.ex @@ -142,4 +142,4 @@ defmodule Stripe.Treasury.CreditReversal do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__debit_reversal.ex b/lib/generated/treasury__debit_reversal.ex index 85a27447..d9e10a33 100644 --- a/lib/generated/treasury__debit_reversal.ex +++ b/lib/generated/treasury__debit_reversal.ex @@ -44,26 +44,31 @@ defmodule Stripe.Treasury.DebitReversal do ( nil - @doc "

Reverses a ReceivedDebit and creates a DebitReversal object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/debit_reversals`\n" + @doc "

Returns a list of DebitReversals.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/debit_reversals`\n" ( - @spec create( + @spec list( params :: %{ + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:metadata) => %{optional(binary) => binary}, - optional(:received_debit) => binary + optional(:financial_account) => binary, + optional(:limit) => integer, + optional(:received_debit) => binary, + optional(:resolution) => :lost | :won, + optional(:starting_after) => binary, + optional(:status) => :canceled | :completed | :processing }, opts :: Keyword.t() ) :: - {:ok, Stripe.Treasury.DebitReversal.t()} + {:ok, Stripe.List.t(Stripe.Treasury.DebitReversal.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/debit_reversals", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -116,33 +121,28 @@ defmodule Stripe.Treasury.DebitReversal do ( nil - @doc "

Returns a list of DebitReversals.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/debit_reversals`\n" + @doc "

Reverses a ReceivedDebit and creates a DebitReversal object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/debit_reversals`\n" ( - @spec list( + @spec create( params :: %{ - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:financial_account) => binary, - optional(:limit) => integer, - optional(:received_debit) => binary, - optional(:resolution) => :lost | :won, - optional(:starting_after) => binary, - optional(:status) => :canceled | :completed | :processing + optional(:metadata) => %{optional(binary) => binary}, + optional(:received_debit) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Treasury.DebitReversal.t())} + {:ok, Stripe.Treasury.DebitReversal.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/debit_reversals", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__financial_account.ex b/lib/generated/treasury__financial_account.ex index 85eb6c8d..8b32f5a0 100644 --- a/lib/generated/treasury__financial_account.ex +++ b/lib/generated/treasury__financial_account.ex @@ -133,28 +133,28 @@ defmodule Stripe.Treasury.FinancialAccount do ( nil - @doc "

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/financial_accounts`\n" + @doc "

Returns a list of FinancialAccounts.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/financial_accounts`\n" ( - @spec create( + @spec list( params :: %{ + optional(:created) => created | integer, + optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:features) => features, - optional(:metadata) => %{optional(binary) => binary}, - optional(:platform_restrictions) => platform_restrictions, - optional(:supported_currencies) => list(binary) + optional(:limit) => integer, + optional(:starting_after) => binary }, opts :: Keyword.t() ) :: - {:ok, Stripe.Treasury.FinancialAccount.t()} + {:ok, Stripe.List.t(Stripe.Treasury.FinancialAccount.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/financial_accounts", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -163,22 +163,17 @@ defmodule Stripe.Treasury.FinancialAccount do ( nil - @doc "

Updates the details of a FinancialAccount.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/financial_accounts/{financial_account}`\n" + @doc "

Retrieves the details of a FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/financial_accounts/{financial_account}`\n" ( - @spec update( + @spec retrieve( financial_account :: binary(), - params :: %{ - optional(:expand) => list(binary), - optional(:features) => features, - optional(:metadata) => %{optional(binary) => binary}, - optional(:platform_restrictions) => platform_restrictions - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.FinancialAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update(financial_account, params \\ %{}, opts \\ []) do + def retrieve(financial_account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/treasury/financial_accounts/{financial_account}", @@ -203,7 +198,7 @@ defmodule Stripe.Treasury.FinancialAccount do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -212,26 +207,17 @@ defmodule Stripe.Treasury.FinancialAccount do ( nil - @doc "

Updates the Features associated with a FinancialAccount.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/financial_accounts/{financial_account}/features`\n" + @doc "

Retrieves Features information associated with the FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/financial_accounts/{financial_account}/features`\n" ( - @spec update_features( + @spec retrieve_features( financial_account :: binary(), - params :: %{ - optional(:card_issuing) => card_issuing, - optional(:deposit_insurance) => deposit_insurance, - optional(:expand) => list(binary), - optional(:financial_addresses) => financial_addresses, - optional(:inbound_transfers) => inbound_transfers, - optional(:intra_stripe_flows) => intra_stripe_flows, - optional(:outbound_payments) => outbound_payments, - optional(:outbound_transfers) => outbound_transfers - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.FinancialAccountFeatures.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def update_features(financial_account, params \\ %{}, opts \\ []) do + def retrieve_features(financial_account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/treasury/financial_accounts/{financial_account}/features", @@ -256,7 +242,7 @@ defmodule Stripe.Treasury.FinancialAccount do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -265,28 +251,28 @@ defmodule Stripe.Treasury.FinancialAccount do ( nil - @doc "

Returns a list of FinancialAccounts.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/financial_accounts`\n" + @doc "

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/financial_accounts`\n" ( - @spec list( + @spec create( params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:limit) => integer, - optional(:starting_after) => binary + optional(:features) => features, + optional(:metadata) => %{optional(binary) => binary}, + optional(:platform_restrictions) => platform_restrictions, + optional(:supported_currencies) => list(binary) }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Treasury.FinancialAccount.t())} + {:ok, Stripe.Treasury.FinancialAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/financial_accounts", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -295,17 +281,22 @@ defmodule Stripe.Treasury.FinancialAccount do ( nil - @doc "

Retrieves the details of a FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/financial_accounts/{financial_account}`\n" + @doc "

Updates the details of a FinancialAccount.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/financial_accounts/{financial_account}`\n" ( - @spec retrieve( + @spec update( financial_account :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:features) => features, + optional(:metadata) => %{optional(binary) => binary}, + optional(:platform_restrictions) => platform_restrictions + }, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.FinancialAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve(financial_account, params \\ %{}, opts \\ []) do + def update(financial_account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/treasury/financial_accounts/{financial_account}", @@ -330,7 +321,7 @@ defmodule Stripe.Treasury.FinancialAccount do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -339,17 +330,26 @@ defmodule Stripe.Treasury.FinancialAccount do ( nil - @doc "

Retrieves Features information associated with the FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/financial_accounts/{financial_account}/features`\n" + @doc "

Updates the Features associated with a FinancialAccount.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/financial_accounts/{financial_account}/features`\n" ( - @spec retrieve_features( + @spec update_features( financial_account :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:card_issuing) => card_issuing, + optional(:deposit_insurance) => deposit_insurance, + optional(:expand) => list(binary), + optional(:financial_addresses) => financial_addresses, + optional(:inbound_transfers) => inbound_transfers, + optional(:intra_stripe_flows) => intra_stripe_flows, + optional(:outbound_payments) => outbound_payments, + optional(:outbound_transfers) => outbound_transfers + }, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.FinancialAccountFeatures.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def retrieve_features(financial_account, params \\ %{}, opts \\ []) do + def update_features(financial_account, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( "/v1/treasury/financial_accounts/{financial_account}/features", @@ -374,9 +374,9 @@ defmodule Stripe.Treasury.FinancialAccount do Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__financial_account_features.ex b/lib/generated/treasury__financial_account_features.ex index e1122586..826b2143 100644 --- a/lib/generated/treasury__financial_account_features.ex +++ b/lib/generated/treasury__financial_account_features.ex @@ -26,4 +26,4 @@ defmodule Stripe.Treasury.FinancialAccountFeatures do outbound_transfers: term } ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__inbound_transfer.ex b/lib/generated/treasury__inbound_transfer.ex index 12fbc2e9..7e5880dc 100644 --- a/lib/generated/treasury__inbound_transfer.ex +++ b/lib/generated/treasury__inbound_transfer.ex @@ -1,7 +1,7 @@ defmodule Stripe.Treasury.InboundTransfer do use Stripe.Entity - @moduledoc "Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit." + @moduledoc "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)" ( defstruct [ :amount, @@ -74,75 +74,29 @@ defmodule Stripe.Treasury.InboundTransfer do ( nil - @doc "

Cancels an InboundTransfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/inbound_transfers/{inbound_transfer}/cancel`\n" - ( - @spec cancel( - inbound_transfer :: binary(), - params :: %{optional(:expand) => list(binary)}, - opts :: Keyword.t() - ) :: - {:ok, Stripe.Treasury.InboundTransfer.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def cancel(inbound_transfer, params \\ %{}, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "inbound_transfer", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "inbound_transfer", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [inbound_transfer] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) - |> Stripe.Request.make_request() - end - ) - ) - - ( - nil - - @doc "

Creates an InboundTransfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/inbound_transfers`\n" + @doc "

Returns a list of InboundTransfers sent from the specified FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/inbound_transfers`\n" ( - @spec create( + @spec list( params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, - optional(:description) => binary, + optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:financial_account) => binary, - optional(:metadata) => %{optional(binary) => binary}, - optional(:origin_payment_method) => binary, - optional(:statement_descriptor) => binary + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :canceled | :failed | :processing | :succeeded }, opts :: Keyword.t() ) :: - {:ok, Stripe.Treasury.InboundTransfer.t()} + {:ok, Stripe.List.t(Stripe.Treasury.InboundTransfer.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/inbound_transfers", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -195,29 +149,45 @@ defmodule Stripe.Treasury.InboundTransfer do ( nil - @doc "

Returns a list of InboundTransfers sent from the specified FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/inbound_transfers`\n" + @doc "

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/inbound_transfers/{id}/fail`\n" ( - @spec list( + @spec fail( + id :: binary(), params :: %{ - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:financial_account) => binary, - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:status) => :canceled | :failed | :processing | :succeeded + optional(:failure_details) => failure_details }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Treasury.InboundTransfer.t())} + {:ok, Stripe.Treasury.InboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/inbound_transfers", [], []) + def fail(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/test_helpers/treasury/inbound_transfers/{id}/fail", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -226,9 +196,9 @@ defmodule Stripe.Treasury.InboundTransfer do ( nil - @doc "

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/inbound_transfers/{id}/succeed`\n" + @doc "

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/inbound_transfers/{id}/return`\n" ( - @spec succeed( + @spec return_inbound_transfer( id :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() @@ -236,10 +206,10 @@ defmodule Stripe.Treasury.InboundTransfer do {:ok, Stripe.Treasury.InboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def succeed(id, params \\ %{}, opts \\ []) do + def return_inbound_transfer(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed", + "/v1/test_helpers/treasury/inbound_transfers/{id}/return", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -270,23 +240,20 @@ defmodule Stripe.Treasury.InboundTransfer do ( nil - @doc "

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/inbound_transfers/{id}/fail`\n" + @doc "

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/inbound_transfers/{id}/succeed`\n" ( - @spec fail( + @spec succeed( id :: binary(), - params :: %{ - optional(:expand) => list(binary), - optional(:failure_details) => failure_details - }, + params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.InboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def fail(id, params \\ %{}, opts \\ []) do + def succeed(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/inbound_transfers/{id}/fail", + "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -317,27 +284,60 @@ defmodule Stripe.Treasury.InboundTransfer do ( nil - @doc "

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/inbound_transfers/{id}/return`\n" + @doc "

Creates an InboundTransfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/inbound_transfers`\n" ( - @spec return_inbound_transfer( - id :: binary(), + @spec create( + params :: %{ + optional(:amount) => integer, + optional(:currency) => binary, + optional(:description) => binary, + optional(:expand) => list(binary), + optional(:financial_account) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:origin_payment_method) => binary, + optional(:statement_descriptor) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Treasury.InboundTransfer.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/inbound_transfers", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Cancels an InboundTransfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/inbound_transfers/{inbound_transfer}/cancel`\n" + ( + @spec cancel( + inbound_transfer :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.InboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def return_inbound_transfer(id, params \\ %{}, opts \\ []) do + def cancel(inbound_transfer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/inbound_transfers/{id}/return", + "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel", [ %OpenApiGen.Blueprint.Parameter{ in: "path", - name: "id", + name: "inbound_transfer", required: true, schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "id", + name: "inbound_transfer", title: nil, type: "string", items: [], @@ -346,7 +346,7 @@ defmodule Stripe.Treasury.InboundTransfer do } } ], - [id] + [inbound_transfer] ) Stripe.Request.new_request(opts) @@ -357,4 +357,4 @@ defmodule Stripe.Treasury.InboundTransfer do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__outbound_payment.ex b/lib/generated/treasury__outbound_payment.ex index d214c407..7146057a 100644 --- a/lib/generated/treasury__outbound_payment.ex +++ b/lib/generated/treasury__outbound_payment.ex @@ -1,7 +1,7 @@ defmodule Stripe.Treasury.OutboundPayment do use Stripe.Entity - @moduledoc "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects." + @moduledoc "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)" ( defstruct [ :amount, @@ -24,10 +24,11 @@ defmodule Stripe.Treasury.OutboundPayment do :statement_descriptor, :status, :status_transitions, + :tracking_details, :transaction ] - @typedoc "The `treasury.outbound_payment` type.\n\n * `amount` Amount (in cents) transferred.\n * `cancelable` Returns `true` if the object can be canceled, and `false` otherwise.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination_payment_method` The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.\n * `destination_payment_method_details` Details about the PaymentMethod for an OutboundPayment.\n * `end_user_details` Details about the end user.\n * `expected_arrival_date` The date when funds are expected to arrive in the destination account.\n * `financial_account` The FinancialAccount that funds were pulled from.\n * `hosted_regulatory_receipt_url` A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `returned_details` Details about a returned OutboundPayment. Only set when the status is `returned`.\n * `statement_descriptor` The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).\n * `status` Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.\n * `status_transitions` \n * `transaction` The Transaction associated with this object.\n" + @typedoc "The `treasury.outbound_payment` type.\n\n * `amount` Amount (in cents) transferred.\n * `cancelable` Returns `true` if the object can be canceled, and `false` otherwise.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `customer` ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination_payment_method` The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.\n * `destination_payment_method_details` Details about the PaymentMethod for an OutboundPayment.\n * `end_user_details` Details about the end user.\n * `expected_arrival_date` The date when funds are expected to arrive in the destination account.\n * `financial_account` The FinancialAccount that funds were pulled from.\n * `hosted_regulatory_receipt_url` A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `returned_details` Details about a returned OutboundPayment. Only set when the status is `returned`.\n * `statement_descriptor` The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).\n * `status` Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.\n * `status_transitions` \n * `tracking_details` Details about network-specific tracking information if available.\n * `transaction` The Transaction associated with this object.\n" @type t :: %__MODULE__{ amount: integer, cancelable: boolean, @@ -49,10 +50,16 @@ defmodule Stripe.Treasury.OutboundPayment do statement_descriptor: binary, status: binary, status_transitions: term, + tracking_details: term | nil, transaction: binary | Stripe.Treasury.Transaction.t() } ) + ( + @typedoc "ACH network tracking details." + @type ach :: %{optional(:trace_id) => binary} + ) + ( @typedoc nil @type address :: %{ @@ -75,6 +82,16 @@ defmodule Stripe.Treasury.OutboundPayment do } ) + ( + @typedoc nil + @type created :: %{ + optional(:gt) => integer, + optional(:gte) => integer, + optional(:lt) => integer, + optional(:lte) => integer + } + ) + ( @typedoc "Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`." @type destination_payment_method_data :: %{ @@ -99,7 +116,7 @@ defmodule Stripe.Treasury.OutboundPayment do ) ( - @typedoc "Optional hash to set the the return code." + @typedoc "Optional hash to set the return code." @type returned_details :: %{ optional(:code) => :account_closed @@ -115,44 +132,57 @@ defmodule Stripe.Treasury.OutboundPayment do } ) + ( + @typedoc "Details about network-specific tracking information." + @type tracking_details :: %{ + optional(:ach) => ach, + optional(:type) => :ach | :us_domestic_wire, + optional(:us_domestic_wire) => us_domestic_wire + } + ) + ( @typedoc nil @type us_bank_account :: %{optional(:network) => :ach | :us_domestic_wire} ) + ( + @typedoc "US domestic wire network tracking details." + @type us_domestic_wire :: %{ + optional(:chips) => binary, + optional(:imad) => binary, + optional(:omad) => binary + } + ) + ( nil - @doc "

Creates an OutboundPayment.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_payments`\n" + @doc "

Returns a list of OutboundPayments sent from the specified FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/outbound_payments`\n" ( - @spec create( + @spec list( params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, + optional(:created) => created | integer, optional(:customer) => binary, - optional(:description) => binary, - optional(:destination_payment_method) => binary, - optional(:destination_payment_method_data) => destination_payment_method_data, - optional(:destination_payment_method_options) => - destination_payment_method_options, - optional(:end_user_details) => end_user_details, + optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:financial_account) => binary, - optional(:metadata) => %{optional(binary) => binary}, - optional(:statement_descriptor) => binary + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :canceled | :failed | :posted | :processing | :returned }, opts :: Keyword.t() ) :: - {:ok, Stripe.Treasury.OutboundPayment.t()} + {:ok, Stripe.List.t(Stripe.Treasury.OutboundPayment.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/outbound_payments", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -205,30 +235,45 @@ defmodule Stripe.Treasury.OutboundPayment do ( nil - @doc "

Returns a list of OutboundPayments sent from the specified FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/outbound_payments`\n" + @doc "

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_payments/{id}`\n" ( - @spec list( + @spec update( + id :: binary(), params :: %{ - optional(:customer) => binary, - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:financial_account) => binary, - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:status) => :canceled | :failed | :posted | :processing | :returned + optional(:tracking_details) => tracking_details }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Treasury.OutboundPayment.t())} + {:ok, Stripe.Treasury.OutboundPayment.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/outbound_payments", [], []) + def update(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/test_helpers/treasury/outbound_payments/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -237,9 +282,9 @@ defmodule Stripe.Treasury.OutboundPayment do ( nil - @doc "

Cancel an OutboundPayment.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_payments/{id}/cancel`\n" + @doc "

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_payments/{id}/fail`\n" ( - @spec cancel( + @spec fail( id :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() @@ -247,10 +292,10 @@ defmodule Stripe.Treasury.OutboundPayment do {:ok, Stripe.Treasury.OutboundPayment.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def cancel(id, params \\ %{}, opts \\ []) do + def fail(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/treasury/outbound_payments/{id}/cancel", + "/v1/test_helpers/treasury/outbound_payments/{id}/fail", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -281,9 +326,9 @@ defmodule Stripe.Treasury.OutboundPayment do ( nil - @doc "

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_payments/{id}/fail`\n" + @doc "

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_payments/{id}/post`\n" ( - @spec fail( + @spec post( id :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() @@ -291,10 +336,10 @@ defmodule Stripe.Treasury.OutboundPayment do {:ok, Stripe.Treasury.OutboundPayment.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def fail(id, params \\ %{}, opts \\ []) do + def post(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/outbound_payments/{id}/fail", + "/v1/test_helpers/treasury/outbound_payments/{id}/post", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -325,20 +370,23 @@ defmodule Stripe.Treasury.OutboundPayment do ( nil - @doc "

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_payments/{id}/post`\n" + @doc "

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_payments/{id}/return`\n" ( - @spec post( + @spec return_outbound_payment( id :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:returned_details) => returned_details + }, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.OutboundPayment.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def post(id, params \\ %{}, opts \\ []) do + def return_outbound_payment(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/outbound_payments/{id}/post", + "/v1/test_helpers/treasury/outbound_payments/{id}/return", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -369,23 +417,58 @@ defmodule Stripe.Treasury.OutboundPayment do ( nil - @doc "

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_payments/{id}/return`\n" + @doc "

Creates an OutboundPayment.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_payments`\n" ( - @spec return_outbound_payment( - id :: binary(), + @spec create( params :: %{ + optional(:amount) => integer, + optional(:currency) => binary, + optional(:customer) => binary, + optional(:description) => binary, + optional(:destination_payment_method) => binary, + optional(:destination_payment_method_data) => destination_payment_method_data, + optional(:destination_payment_method_options) => + destination_payment_method_options, + optional(:end_user_details) => end_user_details, optional(:expand) => list(binary), - optional(:returned_details) => returned_details + optional(:financial_account) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:statement_descriptor) => binary }, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.OutboundPayment.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def return_outbound_payment(id, params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/outbound_payments", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Cancel an OutboundPayment.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_payments/{id}/cancel`\n" + ( + @spec cancel( + id :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Treasury.OutboundPayment.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def cancel(id, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/outbound_payments/{id}/return", + "/v1/treasury/outbound_payments/{id}/cancel", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -412,4 +495,4 @@ defmodule Stripe.Treasury.OutboundPayment do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__outbound_transfer.ex b/lib/generated/treasury__outbound_transfer.ex index 7ae78380..43717647 100644 --- a/lib/generated/treasury__outbound_transfer.ex +++ b/lib/generated/treasury__outbound_transfer.ex @@ -1,7 +1,7 @@ defmodule Stripe.Treasury.OutboundTransfer do use Stripe.Entity - @moduledoc "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects." + @moduledoc "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)" ( defstruct [ :amount, @@ -22,10 +22,11 @@ defmodule Stripe.Treasury.OutboundTransfer do :statement_descriptor, :status, :status_transitions, + :tracking_details, :transaction ] - @typedoc "The `treasury.outbound_transfer` type.\n\n * `amount` Amount (in cents) transferred.\n * `cancelable` Returns `true` if the object can be canceled, and `false` otherwise.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination_payment_method` The PaymentMethod used as the payment instrument for an OutboundTransfer.\n * `destination_payment_method_details` \n * `expected_arrival_date` The date when funds are expected to arrive in the destination account.\n * `financial_account` The FinancialAccount that funds were pulled from.\n * `hosted_regulatory_receipt_url` A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `returned_details` Details about a returned OutboundTransfer. Only set when the status is `returned`.\n * `statement_descriptor` Information about the OutboundTransfer to be sent to the recipient account.\n * `status` Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.\n * `status_transitions` \n * `transaction` The Transaction associated with this object.\n" + @typedoc "The `treasury.outbound_transfer` type.\n\n * `amount` Amount (in cents) transferred.\n * `cancelable` Returns `true` if the object can be canceled, and `false` otherwise.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).\n * `description` An arbitrary string attached to the object. Often useful for displaying to users.\n * `destination_payment_method` The PaymentMethod used as the payment instrument for an OutboundTransfer.\n * `destination_payment_method_details` \n * `expected_arrival_date` The date when funds are expected to arrive in the destination account.\n * `financial_account` The FinancialAccount that funds were pulled from.\n * `hosted_regulatory_receipt_url` A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `returned_details` Details about a returned OutboundTransfer. Only set when the status is `returned`.\n * `statement_descriptor` Information about the OutboundTransfer to be sent to the recipient account.\n * `status` Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.\n * `status_transitions` \n * `tracking_details` Details about network-specific tracking information if available.\n * `transaction` The Transaction associated with this object.\n" @type t :: %__MODULE__{ amount: integer, cancelable: boolean, @@ -45,10 +46,16 @@ defmodule Stripe.Treasury.OutboundTransfer do statement_descriptor: binary, status: binary, status_transitions: term, + tracking_details: term | nil, transaction: binary | Stripe.Treasury.Transaction.t() } ) + ( + @typedoc "ACH network tracking details." + @type ach :: %{optional(:trace_id) => binary} + ) + ( @typedoc "Hash describing payment method configuration details." @type destination_payment_method_options :: %{ @@ -73,41 +80,55 @@ defmodule Stripe.Treasury.OutboundTransfer do } ) + ( + @typedoc "Details about network-specific tracking information." + @type tracking_details :: %{ + optional(:ach) => ach, + optional(:type) => :ach | :us_domestic_wire, + optional(:us_domestic_wire) => us_domestic_wire + } + ) + ( @typedoc nil @type us_bank_account :: %{optional(:network) => :ach | :us_domestic_wire} ) + ( + @typedoc "US domestic wire network tracking details." + @type us_domestic_wire :: %{ + optional(:chips) => binary, + optional(:imad) => binary, + optional(:omad) => binary + } + ) + ( nil - @doc "

Creates an OutboundTransfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_transfers`\n" + @doc "

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/outbound_transfers`\n" ( - @spec create( + @spec list( params :: %{ - optional(:amount) => integer, - optional(:currency) => binary, - optional(:description) => binary, - optional(:destination_payment_method) => binary, - optional(:destination_payment_method_options) => - destination_payment_method_options, + optional(:ending_before) => binary, optional(:expand) => list(binary), optional(:financial_account) => binary, - optional(:metadata) => %{optional(binary) => binary}, - optional(:statement_descriptor) => binary + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :canceled | :failed | :posted | :processing | :returned }, opts :: Keyword.t() ) :: - {:ok, Stripe.Treasury.OutboundTransfer.t()} + {:ok, Stripe.List.t(Stripe.Treasury.OutboundTransfer.t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def create(params \\ %{}, opts \\ []) do + def list(params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/outbound_transfers", [], []) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:post) + |> Stripe.Request.put_method(:get) |> Stripe.Request.make_request() end ) @@ -160,29 +181,45 @@ defmodule Stripe.Treasury.OutboundTransfer do ( nil - @doc "

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/outbound_transfers`\n" + @doc "

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}`\n" ( - @spec list( + @spec update( + outbound_transfer :: binary(), params :: %{ - optional(:ending_before) => binary, optional(:expand) => list(binary), - optional(:financial_account) => binary, - optional(:limit) => integer, - optional(:starting_after) => binary, - optional(:status) => :canceled | :failed | :posted | :processing | :returned + optional(:tracking_details) => tracking_details }, opts :: Keyword.t() ) :: - {:ok, Stripe.List.t(Stripe.Treasury.OutboundTransfer.t())} + {:ok, Stripe.Treasury.OutboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/outbound_transfers", [], []) + def update(outbound_transfer, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "outbound_transfer", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "outbound_transfer", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [outbound_transfer] + ) Stripe.Request.new_request(opts) |> Stripe.Request.put_endpoint(path) |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) + |> Stripe.Request.put_method(:post) |> Stripe.Request.make_request() end ) @@ -191,9 +228,9 @@ defmodule Stripe.Treasury.OutboundTransfer do ( nil - @doc "

An OutboundTransfer can be canceled if the funds have not yet been paid out.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_transfers/{outbound_transfer}/cancel`\n" + @doc "

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail`\n" ( - @spec cancel( + @spec fail( outbound_transfer :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() @@ -201,10 +238,10 @@ defmodule Stripe.Treasury.OutboundTransfer do {:ok, Stripe.Treasury.OutboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def cancel(outbound_transfer, params \\ %{}, opts \\ []) do + def fail(outbound_transfer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel", + "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -235,9 +272,9 @@ defmodule Stripe.Treasury.OutboundTransfer do ( nil - @doc "

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail`\n" + @doc "

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post`\n" ( - @spec fail( + @spec post( outbound_transfer :: binary(), params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t() @@ -245,10 +282,10 @@ defmodule Stripe.Treasury.OutboundTransfer do {:ok, Stripe.Treasury.OutboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def fail(outbound_transfer, params \\ %{}, opts \\ []) do + def post(outbound_transfer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail", + "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -279,20 +316,23 @@ defmodule Stripe.Treasury.OutboundTransfer do ( nil - @doc "

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post`\n" + @doc "

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return`\n" ( - @spec post( + @spec return_outbound_transfer( outbound_transfer :: binary(), - params :: %{optional(:expand) => list(binary)}, + params :: %{ + optional(:expand) => list(binary), + optional(:returned_details) => returned_details + }, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.OutboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def post(outbound_transfer, params \\ %{}, opts \\ []) do + def return_outbound_transfer(outbound_transfer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post", + "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -323,23 +363,55 @@ defmodule Stripe.Treasury.OutboundTransfer do ( nil - @doc "

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return`\n" + @doc "

Creates an OutboundTransfer.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_transfers`\n" ( - @spec return_outbound_transfer( - outbound_transfer :: binary(), + @spec create( params :: %{ + optional(:amount) => integer, + optional(:currency) => binary, + optional(:description) => binary, + optional(:destination_payment_method) => binary, + optional(:destination_payment_method_options) => + destination_payment_method_options, optional(:expand) => list(binary), - optional(:returned_details) => returned_details + optional(:financial_account) => binary, + optional(:metadata) => %{optional(binary) => binary}, + optional(:statement_descriptor) => binary }, opts :: Keyword.t() ) :: {:ok, Stripe.Treasury.OutboundTransfer.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()} - def return_outbound_transfer(outbound_transfer, params \\ %{}, opts \\ []) do + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/outbound_transfers", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

An OutboundTransfer can be canceled if the funds have not yet been paid out.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/treasury/outbound_transfers/{outbound_transfer}/cancel`\n" + ( + @spec cancel( + outbound_transfer :: binary(), + params :: %{optional(:expand) => list(binary)}, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Treasury.OutboundTransfer.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def cancel(outbound_transfer, params \\ %{}, opts \\ []) do path = Stripe.OpenApi.Path.replace_path_params( - "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return", + "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel", [ %OpenApiGen.Blueprint.Parameter{ in: "path", @@ -366,4 +438,4 @@ defmodule Stripe.Treasury.OutboundTransfer do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__received_credit.ex b/lib/generated/treasury__received_credit.ex index ead10f6a..c0183fba 100644 --- a/lib/generated/treasury__received_credit.ex +++ b/lib/generated/treasury__received_credit.ex @@ -179,4 +179,4 @@ defmodule Stripe.Treasury.ReceivedCredit do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__received_debit.ex b/lib/generated/treasury__received_debit.ex index 3bc3137a..71ed5d0d 100644 --- a/lib/generated/treasury__received_debit.ex +++ b/lib/generated/treasury__received_debit.ex @@ -171,4 +171,4 @@ defmodule Stripe.Treasury.ReceivedDebit do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__transaction.ex b/lib/generated/treasury__transaction.ex index f3955517..56dd5a3e 100644 --- a/lib/generated/treasury__transaction.ex +++ b/lib/generated/treasury__transaction.ex @@ -66,6 +66,40 @@ defmodule Stripe.Treasury.Transaction do @type status_transitions :: %{optional(:posted_at) => posted_at | integer} ) + ( + nil + + @doc "

Retrieves a list of Transaction objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/transactions`\n" + ( + @spec list( + params :: %{ + optional(:created) => created | integer, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:financial_account) => binary, + optional(:limit) => integer, + optional(:order_by) => :created | :posted_at, + optional(:starting_after) => binary, + optional(:status) => :open | :posted | :void, + optional(:status_transitions) => status_transitions + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Treasury.Transaction.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/transactions", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -109,38 +143,4 @@ defmodule Stripe.Treasury.Transaction do end ) ) - - ( - nil - - @doc "

Retrieves a list of Transaction objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/transactions`\n" - ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:financial_account) => binary, - optional(:limit) => integer, - optional(:order_by) => :created | :posted_at, - optional(:starting_after) => binary, - optional(:status) => :open | :posted | :void, - optional(:status_transitions) => status_transitions - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Treasury.Transaction.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/transactions", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/treasury__transaction_entry.ex b/lib/generated/treasury__transaction_entry.ex index ceaefbf2..4500b3f9 100644 --- a/lib/generated/treasury__transaction_entry.ex +++ b/lib/generated/treasury__transaction_entry.ex @@ -57,6 +57,40 @@ defmodule Stripe.Treasury.TransactionEntry do } ) + ( + nil + + @doc "

Retrieves a list of TransactionEntry objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/transaction_entries`\n" + ( + @spec list( + params :: %{ + optional(:created) => created | integer, + optional(:effective_at) => effective_at | integer, + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:financial_account) => binary, + optional(:limit) => integer, + optional(:order_by) => :created | :effective_at, + optional(:starting_after) => binary, + optional(:transaction) => binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Treasury.TransactionEntry.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/transaction_entries", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -100,38 +134,4 @@ defmodule Stripe.Treasury.TransactionEntry do end ) ) - - ( - nil - - @doc "

Retrieves a list of TransactionEntry objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/treasury/transaction_entries`\n" - ( - @spec list( - params :: %{ - optional(:created) => created | integer, - optional(:effective_at) => effective_at | integer, - optional(:ending_before) => binary, - optional(:expand) => list(binary), - optional(:financial_account) => binary, - optional(:limit) => integer, - optional(:order_by) => :created | :effective_at, - optional(:starting_after) => binary, - optional(:transaction) => binary - }, - opts :: Keyword.t() - ) :: - {:ok, Stripe.List.t(Stripe.Treasury.TransactionEntry.t())} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def list(params \\ %{}, opts \\ []) do - path = Stripe.OpenApi.Path.replace_path_params("/v1/treasury/transaction_entries", [], []) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_params(params) - |> Stripe.Request.put_method(:get) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/generated/usage_record.ex b/lib/generated/usage_record.ex index 15e088e0..74556819 100644 --- a/lib/generated/usage_record.ex +++ b/lib/generated/usage_record.ex @@ -1,7 +1,7 @@ defmodule Stripe.UsageRecord do use Stripe.Entity - @moduledoc "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)" + @moduledoc "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)\n\nThis is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based)." ( defstruct [:id, :livemode, :object, :quantity, :subscription_item, :timestamp] @@ -61,4 +61,4 @@ defmodule Stripe.UsageRecord do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/usage_record_summary.ex b/lib/generated/usage_record_summary.ex index 10b585d5..4f05a957 100644 --- a/lib/generated/usage_record_summary.ex +++ b/lib/generated/usage_record_summary.ex @@ -64,4 +64,4 @@ defmodule Stripe.UsageRecordSummary do end ) ) -end +end \ No newline at end of file diff --git a/lib/generated/webhook_endpoint.ex b/lib/generated/webhook_endpoint.ex index 928c36e1..0ecc1e15 100644 --- a/lib/generated/webhook_endpoint.ex +++ b/lib/generated/webhook_endpoint.ex @@ -1,7 +1,7 @@ defmodule Stripe.WebhookEndpoint do use Stripe.Entity - @moduledoc "You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure)" + @moduledoc "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)" ( defstruct [ :api_version, @@ -18,7 +18,7 @@ defmodule Stripe.WebhookEndpoint do :url ] - @typedoc "The `webhook_endpoint` type.\n\n * `api_version` The API version events are rendered as for this webhook endpoint.\n * `application` The ID of the associated Connect application.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `description` An optional description of what the webhook is used for.\n * `enabled_events` The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `secret` The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation.\n * `status` The status of the webhook. It can be `enabled` or `disabled`.\n * `url` The URL of the webhook endpoint.\n" + @typedoc "The `webhook_endpoint` type.\n\n * `api_version` The API version events are rendered as for this webhook endpoint.\n * `application` The ID of the associated Connect application.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `description` An optional description of what the webhook is used for.\n * `enabled_events` The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `secret` The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.\n * `status` The status of the webhook. It can be `enabled` or `disabled`.\n * `url` The URL of the webhook endpoint.\n" @type t :: %__MODULE__{ api_version: binary | nil, application: binary | nil, @@ -35,6 +35,45 @@ defmodule Stripe.WebhookEndpoint do } ) + ( + nil + + @doc "

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/webhook_endpoints/{webhook_endpoint}`\n" + ( + @spec delete(webhook_endpoint :: binary(), opts :: Keyword.t()) :: + {:ok, Stripe.DeletedWebhookEndpoint.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def delete(webhook_endpoint, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/webhook_endpoints/{webhook_endpoint}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "webhook_endpoint", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "webhook_endpoint", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [webhook_endpoint] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_method(:delete) + |> Stripe.Request.make_request() + end + ) + ) + ( nil @@ -215,7 +254,9 @@ defmodule Stripe.WebhookEndpoint do | :"2022-08-01" | :"2022-11-15" | :"2023-08-16" - | :"2023-10-16", + | :"2023-10-16" + | :"2024-04-10" + | :"2024-06-20", optional(:connect) => boolean, optional(:description) => binary | binary, optional(:enabled_events) => @@ -231,6 +272,7 @@ defmodule Stripe.WebhookEndpoint do | :"application_fee.refund.updated" | :"application_fee.refunded" | :"balance.available" + | :"billing.alert.triggered" | :"billing_portal.configuration.created" | :"billing_portal.configuration.updated" | :"billing_portal.session.created" @@ -288,12 +330,14 @@ defmodule Stripe.WebhookEndpoint do | :"customer.tax_id.updated" | :"customer.updated" | :"customer_cash_balance_transaction.created" + | :"entitlements.active_entitlement_summary.updated" | :"file.created" | :"financial_connections.account.created" | :"financial_connections.account.deactivated" | :"financial_connections.account.disconnected" | :"financial_connections.account.reactivated" | :"financial_connections.account.refreshed_balance" + | :"financial_connections.account.refreshed_ownership" | :"financial_connections.account.refreshed_transactions" | :"identity.verification_session.canceled" | :"identity.verification_session.created" @@ -306,6 +350,7 @@ defmodule Stripe.WebhookEndpoint do | :"invoice.finalization_failed" | :"invoice.finalized" | :"invoice.marked_uncollectible" + | :"invoice.overdue" | :"invoice.paid" | :"invoice.payment_action_required" | :"invoice.payment_failed" @@ -314,6 +359,7 @@ defmodule Stripe.WebhookEndpoint do | :"invoice.upcoming" | :"invoice.updated" | :"invoice.voided" + | :"invoice.will_be_due" | :"invoiceitem.created" | :"invoiceitem.deleted" | :"issuing_authorization.created" @@ -326,8 +372,13 @@ defmodule Stripe.WebhookEndpoint do | :"issuing_dispute.closed" | :"issuing_dispute.created" | :"issuing_dispute.funds_reinstated" + | :"issuing_dispute.funds_rescinded" | :"issuing_dispute.submitted" | :"issuing_dispute.updated" + | :"issuing_personalization_design.activated" + | :"issuing_personalization_design.deactivated" + | :"issuing_personalization_design.rejected" + | :"issuing_personalization_design.updated" | :"issuing_token.created" | :"issuing_token.updated" | :"issuing_transaction.created" @@ -436,12 +487,14 @@ defmodule Stripe.WebhookEndpoint do | :"treasury.outbound_payment.failed" | :"treasury.outbound_payment.posted" | :"treasury.outbound_payment.returned" + | :"treasury.outbound_payment.tracking_details_updated" | :"treasury.outbound_transfer.canceled" | :"treasury.outbound_transfer.created" | :"treasury.outbound_transfer.expected_arrival_date_updated" | :"treasury.outbound_transfer.failed" | :"treasury.outbound_transfer.posted" | :"treasury.outbound_transfer.returned" + | :"treasury.outbound_transfer.tracking_details_updated" | :"treasury.received_credit.created" | :"treasury.received_credit.failed" | :"treasury.received_credit.succeeded" @@ -491,6 +544,7 @@ defmodule Stripe.WebhookEndpoint do | :"application_fee.refund.updated" | :"application_fee.refunded" | :"balance.available" + | :"billing.alert.triggered" | :"billing_portal.configuration.created" | :"billing_portal.configuration.updated" | :"billing_portal.session.created" @@ -548,12 +602,14 @@ defmodule Stripe.WebhookEndpoint do | :"customer.tax_id.updated" | :"customer.updated" | :"customer_cash_balance_transaction.created" + | :"entitlements.active_entitlement_summary.updated" | :"file.created" | :"financial_connections.account.created" | :"financial_connections.account.deactivated" | :"financial_connections.account.disconnected" | :"financial_connections.account.reactivated" | :"financial_connections.account.refreshed_balance" + | :"financial_connections.account.refreshed_ownership" | :"financial_connections.account.refreshed_transactions" | :"identity.verification_session.canceled" | :"identity.verification_session.created" @@ -566,6 +622,7 @@ defmodule Stripe.WebhookEndpoint do | :"invoice.finalization_failed" | :"invoice.finalized" | :"invoice.marked_uncollectible" + | :"invoice.overdue" | :"invoice.paid" | :"invoice.payment_action_required" | :"invoice.payment_failed" @@ -574,6 +631,7 @@ defmodule Stripe.WebhookEndpoint do | :"invoice.upcoming" | :"invoice.updated" | :"invoice.voided" + | :"invoice.will_be_due" | :"invoiceitem.created" | :"invoiceitem.deleted" | :"issuing_authorization.created" @@ -586,8 +644,13 @@ defmodule Stripe.WebhookEndpoint do | :"issuing_dispute.closed" | :"issuing_dispute.created" | :"issuing_dispute.funds_reinstated" + | :"issuing_dispute.funds_rescinded" | :"issuing_dispute.submitted" | :"issuing_dispute.updated" + | :"issuing_personalization_design.activated" + | :"issuing_personalization_design.deactivated" + | :"issuing_personalization_design.rejected" + | :"issuing_personalization_design.updated" | :"issuing_token.created" | :"issuing_token.updated" | :"issuing_transaction.created" @@ -696,12 +759,14 @@ defmodule Stripe.WebhookEndpoint do | :"treasury.outbound_payment.failed" | :"treasury.outbound_payment.posted" | :"treasury.outbound_payment.returned" + | :"treasury.outbound_payment.tracking_details_updated" | :"treasury.outbound_transfer.canceled" | :"treasury.outbound_transfer.created" | :"treasury.outbound_transfer.expected_arrival_date_updated" | :"treasury.outbound_transfer.failed" | :"treasury.outbound_transfer.posted" | :"treasury.outbound_transfer.returned" + | :"treasury.outbound_transfer.tracking_details_updated" | :"treasury.received_credit.created" | :"treasury.received_credit.failed" | :"treasury.received_credit.succeeded" @@ -746,43 +811,4 @@ defmodule Stripe.WebhookEndpoint do end ) ) - - ( - nil - - @doc "

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

\n\n#### Details\n\n * Method: `delete`\n * Path: `/v1/webhook_endpoints/{webhook_endpoint}`\n" - ( - @spec delete(webhook_endpoint :: binary(), opts :: Keyword.t()) :: - {:ok, Stripe.DeletedWebhookEndpoint.t()} - | {:error, Stripe.ApiErrors.t()} - | {:error, term()} - def delete(webhook_endpoint, opts \\ []) do - path = - Stripe.OpenApi.Path.replace_path_params( - "/v1/webhook_endpoints/{webhook_endpoint}", - [ - %OpenApiGen.Blueprint.Parameter{ - in: "path", - name: "webhook_endpoint", - required: true, - schema: %OpenApiGen.Blueprint.Parameter.Schema{ - name: "webhook_endpoint", - title: nil, - type: "string", - items: [], - properties: [], - any_of: [] - } - } - ], - [webhook_endpoint] - ) - - Stripe.Request.new_request(opts) - |> Stripe.Request.put_endpoint(path) - |> Stripe.Request.put_method(:delete) - |> Stripe.Request.make_request() - end - ) - ) -end +end \ No newline at end of file diff --git a/lib/openapi/phases/compile.ex b/lib/openapi/phases/compile.ex index 29e2a939..0591dda6 100644 --- a/lib/openapi/phases/compile.ex +++ b/lib/openapi/phases/compile.ex @@ -1173,7 +1173,92 @@ defmodule Stripe.OpenApi.Phases.Compile do {"PostPlans", "/v1/plans", "create"} => "create", {"GetPlansPlan", "/v1/plans/{plan}", "retrieve"} => "retrieve", {"PostPlansPlan", "/v1/plans/{plan}", "update"} => "update", - {"DeletePlansPlan", "/v1/plans/{plan}", "delete"} => "delete" + {"DeletePlansPlan", "/v1/plans/{plan}", "delete"} => "delete", + {"GetConfirmationTokensConfirmationToken", "/v1/confirmation_tokens/{confirmation_token}", + "retrieve"} => "retrieve", + {"PostTestHelpersConfirmationTokens", "/v1/test_helpers/confirmation_tokens", "create"} => + "create", + {"PostCheckoutSessionsSession", "/v1/checkout/sessions/{session}", "update"} => "update", + {"PostTestHelpersTreasuryOutboundPaymentsId", + "/v1/test_helpers/treasury/outbound_payments/{id}", "update"} => "update", + {"GetBillingMetersIdEventSummaries", "/v1/billing/meters/{id}/event_summaries", "list"} => + "list", + {"GetEntitlementsFeatures", "/v1/entitlements/features", "list"} => "list", + {"GetEntitlementsFeaturesId", "/v1/entitlements/features/{id}", "retrieve"} => "retrieve", + {"PostEntitlementsFeatures", "/v1/entitlements/features", "create"} => "create", + {"PostEntitlementsFeaturesId", "/v1/entitlements/features/{id}", "update"} => "update", + {"PostBillingMeterEventAdjustments", "/v1/billing/meter_event_adjustments", "create"} => + "create", + {"PostBillingMeterEvents", "/v1/billing/meter_events", "create"} => "create", + {"GetIssuingPersonalizationDesigns", "/v1/issuing/personalization_designs", "list"} => "list", + {"GetIssuingPersonalizationDesignsPersonalizationDesign", + "/v1/issuing/personalization_designs/{personalization_design}", "retrieve"} => "retrieve", + {"PostIssuingPersonalizationDesigns", "/v1/issuing/personalization_designs", "create"} => + "create", + {"PostIssuingPersonalizationDesignsPersonalizationDesign", + "/v1/issuing/personalization_designs/{personalization_design}", "update"} => "update", + {"PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate", + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate", + "activate"} => "activate", + {"PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate", + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate", + "deactivate"} => "deactivate", + {"PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject", + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject", + "reject"} => "reject", + {"PostInvoicesInvoiceAddLines", "/v1/invoices/{invoice}/add_lines", "add_lines"} => + "add_lines", + {"PostInvoicesInvoiceRemoveLines", "/v1/invoices/{invoice}/remove_lines", "remove_lines"} => + "remove_lines", + {"PostInvoicesInvoiceUpdateLines", "/v1/invoices/{invoice}/update_lines", "update_lines"} => + "update_lines", + {"PostInvoicesCreatePreview", "/v1/invoices/create_preview", "create_preview"} => + "create_preview", + {"GetEntitlementsActiveEntitlements", "/v1/entitlements/active_entitlements", "list"} => + "list", + {"GetEntitlementsActiveEntitlementsId", "/v1/entitlements/active_entitlements/{id}", + "retrieve"} => "retrieve", + {"GetIssuingPhysicalBundles", "/v1/issuing/physical_bundles", "list"} => "list", + {"GetIssuingPhysicalBundlesPhysicalBundle", "/v1/issuing/physical_bundles/{physical_bundle}", + "retrieve"} => "retrieve", + {"PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", + "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount", + "finalize_amount"} => "finalize_amount", + {"PostTestHelpersTreasuryOutboundTransfersOutboundTransfer", + "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}", "update"} => "update", + {"GetTaxCalculationsCalculation", "/v1/tax/calculations/{calculation}", "retrieve"} => + "retrieve", + {"GetBillingMeters", "/v1/billing/meters", "list"} => "list", + {"GetBillingMetersId", "/v1/billing/meters/{id}", "retrieve"} => "retrieve", + {"PostBillingMeters", "/v1/billing/meters", "create"} => "create", + {"PostBillingMetersId", "/v1/billing/meters/{id}", "update"} => "update", + {"PostBillingMetersIdDeactivate", "/v1/billing/meters/{id}/deactivate", "deactivate"} => + "deactivate", + {"PostBillingMetersIdReactivate", "/v1/billing/meters/{id}/reactivate", "reactivate"} => + "reactivate", + {"GetForwardingRequests", "/v1/forwarding/requests", "list"} => "list", + {"GetForwardingRequestsId", "/v1/forwarding/requests/{id}", "retrieve"} => "retrieve", + {"PostForwardingRequests", "/v1/forwarding/requests", "create"} => "create", + {"GetBillingAlerts", "/v1/billing/alerts", "list"} => "list", + {"GetBillingAlertsId", "/v1/billing/alerts/{id}", "retrieve"} => "retrieve", + {"PostBillingAlerts", "/v1/billing/alerts", "create"} => "create", + {"PostBillingAlertsIdActivate", "/v1/billing/alerts/{id}/activate", "activate"} => "activate", + {"PostBillingAlertsIdArchive", "/v1/billing/alerts/{id}/archive", "archive"} => "archive", + {"PostBillingAlertsIdDeactivate", "/v1/billing/alerts/{id}/deactivate", "deactivate"} => + "deactivate", + {"DeleteProductsProductFeaturesId", "/v1/products/{product}/features/{id}", "delete"} => + "delete", + {"GetProductsProductFeatures", "/v1/products/{product}/features", "list"} => "list", + {"GetProductsProductFeaturesId", "/v1/products/{product}/features/{id}", "retrieve"} => + "retrieve", + {"PostProductsProductFeatures", "/v1/products/{product}/features", "create"} => "create", + {"GetInvoiceRenderingTemplates", "/v1/invoice_rendering_templates", "list"} => "list", + {"GetInvoiceRenderingTemplatesTemplate", "/v1/invoice_rendering_templates/{template}", + "retrieve"} => "retrieve", + {"PostInvoiceRenderingTemplatesTemplateArchive", + "/v1/invoice_rendering_templates/{template}/archive", "archive"} => "archive", + {"PostInvoiceRenderingTemplatesTemplateUnarchive", + "/v1/invoice_rendering_templates/{template}/unarchive", "unarchive"} => "unarchive" } defp to_func_name(operation, stripe_extension) do diff --git a/priv/openapi/spec3.sdk.json b/priv/openapi/spec3.sdk.json index d2074d19..d992a77a 100644 --- a/priv/openapi/spec3.sdk.json +++ b/priv/openapi/spec3.sdk.json @@ -100,6 +100,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "future_requirements": { @@ -177,6 +183,19 @@ "tos_acceptance" ], "x-resourceId": "account", + "x-stripeMostCommon": [ + "business_type", + "capabilities", + "company", + "country", + "email", + "id", + "individual", + "metadata", + "requirements", + "tos_acceptance", + "type" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -405,7 +424,12 @@ ], "title": "AccountAnnualRevenue", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "currency", + "fiscal_year_end" + ] }, "account_bacs_debit_payments_settings": { "description": "", @@ -429,7 +453,11 @@ ], "title": "AccountBacsDebitPaymentsSettings", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "display_name", + "service_user_number" + ] }, "account_branding_settings": { "description": "", @@ -498,6 +526,12 @@ "x-expandableFields": [ "icon", "logo" + ], + "x-stripeMostCommon": [ + "icon", + "logo", + "primary_color", + "secondary_color" ] }, "account_business_profile": { @@ -589,6 +623,19 @@ "annual_revenue", "monthly_estimated_revenue", "support_address" + ], + "x-stripeMostCommon": [ + "annual_revenue", + "estimated_worker_count", + "mcc", + "monthly_estimated_revenue", + "name", + "product_description", + "support_address", + "support_email", + "support_phone", + "support_url", + "url" ] }, "account_capabilities": { @@ -1020,7 +1067,56 @@ }, "title": "AccountCapabilities", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "acss_debit_payments", + "affirm_payments", + "afterpay_clearpay_payments", + "amazon_pay_payments", + "au_becs_debit_payments", + "bacs_debit_payments", + "bancontact_payments", + "bank_transfer_payments", + "blik_payments", + "boleto_payments", + "card_issuing", + "card_payments", + "cartes_bancaires_payments", + "cashapp_payments", + "eps_payments", + "fpx_payments", + "gb_bank_transfer_payments", + "giropay_payments", + "grabpay_payments", + "ideal_payments", + "india_international_payments", + "jcb_payments", + "jp_bank_transfer_payments", + "klarna_payments", + "konbini_payments", + "legacy_payments", + "link_payments", + "mobilepay_payments", + "multibanco_payments", + "mx_bank_transfer_payments", + "oxxo_payments", + "p24_payments", + "paynow_payments", + "promptpay_payments", + "revolut_pay_payments", + "sepa_bank_transfer_payments", + "sepa_debit_payments", + "sofort_payments", + "swish_payments", + "tax_reporting_us_1099_k", + "tax_reporting_us_1099_misc", + "transfers", + "treasury", + "twint_payments", + "us_bank_account_ach_payments", + "us_bank_transfer_payments", + "zip_payments" + ] }, "account_capability_future_requirements": { "description": "", @@ -1111,6 +1207,16 @@ "x-expandableFields": [ "alternatives", "errors" + ], + "x-stripeMostCommon": [ + "alternatives", + "current_deadline", + "currently_due", + "disabled_reason", + "errors", + "eventually_due", + "past_due", + "pending_verification" ] }, "account_capability_requirements": { @@ -1202,6 +1308,16 @@ "x-expandableFields": [ "alternatives", "errors" + ], + "x-stripeMostCommon": [ + "alternatives", + "current_deadline", + "currently_due", + "disabled_reason", + "errors", + "eventually_due", + "past_due", + "pending_verification" ] }, "account_card_issuing_settings": { @@ -1215,6 +1331,9 @@ "type": "object", "x-expandableFields": [ "tos_acceptance" + ], + "x-stripeMostCommon": [ + "tos_acceptance" ] }, "account_card_payments_settings": { @@ -1251,6 +1370,12 @@ "type": "object", "x-expandableFields": [ "decline_on" + ], + "x-stripeMostCommon": [ + "decline_on", + "statement_descriptor_prefix", + "statement_descriptor_prefix_kana", + "statement_descriptor_prefix_kanji" ] }, "account_dashboard_settings": { @@ -1275,7 +1400,11 @@ ], "title": "AccountDashboardSettings", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "display_name", + "timezone" + ] }, "account_decline_charge_on": { "description": "", @@ -1295,7 +1424,11 @@ ], "title": "AccountDeclineChargeOn", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "avs_failure", + "cvc_failure" + ] }, "account_future_requirements": { "description": "", @@ -1380,6 +1513,16 @@ "x-expandableFields": [ "alternatives", "errors" + ], + "x-stripeMostCommon": [ + "alternatives", + "current_deadline", + "currently_due", + "disabled_reason", + "errors", + "eventually_due", + "past_due", + "pending_verification" ] }, "account_invoices_settings": { @@ -1416,6 +1559,9 @@ "type": "object", "x-expandableFields": [ "default_account_tax_ids" + ], + "x-stripeMostCommon": [ + "default_account_tax_ids" ] }, "account_link": { @@ -1454,6 +1600,10 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "account_link", + "x-stripeMostCommon": [ + "expires_at", + "url" + ], "x-stripeOperations": [ { "method_name": "create", @@ -1486,7 +1636,11 @@ ], "title": "AccountMonthlyEstimatedRevenue", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "currency" + ] }, "account_payments_settings": { "description": "", @@ -1531,7 +1685,14 @@ ], "title": "AccountPaymentsSettings", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "statement_descriptor", + "statement_descriptor_kana", + "statement_descriptor_kanji", + "statement_descriptor_prefix_kana", + "statement_descriptor_prefix_kanji" + ] }, "account_payout_settings": { "description": "", @@ -1559,6 +1720,11 @@ "type": "object", "x-expandableFields": [ "schedule" + ], + "x-stripeMostCommon": [ + "debit_negative_balances", + "schedule", + "statement_descriptor" ] }, "account_requirements": { @@ -1644,6 +1810,16 @@ "x-expandableFields": [ "alternatives", "errors" + ], + "x-stripeMostCommon": [ + "alternatives", + "current_deadline", + "currently_due", + "disabled_reason", + "errors", + "eventually_due", + "past_due", + "pending_verification" ] }, "account_requirements_alternative": { @@ -1672,7 +1848,11 @@ ], "title": "AccountRequirementsAlternative", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "alternative_fields_due", + "original_fields_due" + ] }, "account_requirements_error": { "description": "", @@ -1791,7 +1971,12 @@ ], "title": "AccountRequirementsError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "reason", + "requirement" + ] }, "account_sepa_debit_payments_settings": { "description": "", @@ -1804,7 +1989,10 @@ }, "title": "AccountSepaDebitPaymentsSettings", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "creditor_id" + ] }, "account_session": { "description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)", @@ -1853,6 +2041,12 @@ "components" ], "x-resourceId": "account_session", + "x-stripeMostCommon": [ + "account", + "client_secret", + "components", + "expires_at" + ], "x-stripeOperations": [ { "method_name": "create", @@ -1920,6 +2114,18 @@ "payouts", "sepa_debit_payments", "treasury" + ], + "x-stripeMostCommon": [ + "bacs_debit_payments", + "branding", + "card_issuing", + "card_payments", + "dashboard", + "invoices", + "payments", + "payouts", + "sepa_debit_payments", + "treasury" ] }, "account_terms_of_service": { @@ -1948,7 +2154,12 @@ ], "title": "AccountTermsOfService", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "account_tos_acceptance": { "description": "", @@ -1979,7 +2190,13 @@ }, "title": "AccountTOSAcceptance", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "date", + "ip", + "service_agreement", + "user_agent" + ] }, "account_treasury_settings": { "description": "", @@ -1992,6 +2209,9 @@ "type": "object", "x-expandableFields": [ "tos_acceptance" + ], + "x-stripeMostCommon": [ + "tos_acceptance" ] }, "account_unification_account_controller": { @@ -2036,6 +2256,14 @@ "fees", "losses", "stripe_dashboard" + ], + "x-stripeMostCommon": [ + "fees", + "is_controller", + "losses", + "requirement_collection", + "stripe_dashboard", + "type" ] }, "account_unification_account_controller_fees": { @@ -2058,7 +2286,10 @@ ], "title": "AccountUnificationAccountControllerFees", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "payer" + ] }, "account_unification_account_controller_losses": { "description": "", @@ -2077,7 +2308,10 @@ ], "title": "AccountUnificationAccountControllerLosses", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "payments" + ] }, "account_unification_account_controller_stripe_dashboard": { "description": "", @@ -2097,7 +2331,10 @@ ], "title": "AccountUnificationAccountControllerStripeDashboard", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type" + ] }, "address": { "description": "", @@ -2150,6 +2387,14 @@ "title": "Address", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ], "x-stripeResource": { "class_name": "Address", "in_package": "" @@ -2405,6 +2650,14 @@ "setup_intent", "source" ], + "x-stripeMostCommon": [ + "code", + "decline_code", + "message", + "param", + "payment_intent", + "type" + ], "x-stripeResource": { "class_name": "StripeError", "in_package": "" @@ -2450,6 +2703,13 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "apple_pay_domain", + "x-stripeMostCommon": [ + "created", + "domain_name", + "id", + "livemode", + "object" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -2516,6 +2776,11 @@ "title": "Application", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "name", + "object" + ], "x-stripeResource": { "class_name": "Application", "in_package": "" @@ -2704,6 +2969,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } }, @@ -2736,6 +3007,23 @@ "refunds" ], "x-resourceId": "application_fee", + "x-stripeMostCommon": [ + "account", + "amount", + "amount_refunded", + "application", + "balance_transaction", + "charge", + "created", + "currency", + "fee_source", + "id", + "livemode", + "object", + "originating_transaction", + "refunded", + "refunds" + ], "x-stripeOperations": [ { "method_name": "list", @@ -2873,6 +3161,17 @@ "scope" ], "x-resourceId": "apps.secret", + "x-stripeMostCommon": [ + "created", + "deleted", + "expires_at", + "id", + "livemode", + "name", + "object", + "payload", + "scope" + ], "x-stripeOperations": [ { "method_name": "list", @@ -2945,6 +3244,11 @@ "type": "object", "x-expandableFields": [ "liability" + ], + "x-stripeMostCommon": [ + "enabled", + "liability", + "status" ] }, "balance": { @@ -3009,6 +3313,10 @@ "pending" ], "x-resourceId": "balance", + "x-stripeMostCommon": [ + "available", + "pending" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -3062,6 +3370,11 @@ "type": "object", "x-expandableFields": [ "source_types" + ], + "x-stripeMostCommon": [ + "amount", + "currency", + "source_types" ] }, "balance_amount_by_source_type": { @@ -3082,7 +3395,12 @@ }, "title": "BalanceAmountBySourceType", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_account", + "card", + "fpx" + ] }, "balance_amount_net": { "description": "", @@ -3115,6 +3433,12 @@ "x-expandableFields": [ "net_available", "source_types" + ], + "x-stripeMostCommon": [ + "amount", + "currency", + "net_available", + "source_types" ] }, "balance_detail": { @@ -3135,6 +3459,9 @@ "type": "object", "x-expandableFields": [ "available" + ], + "x-stripeMostCommon": [ + "available" ] }, "balance_net_available": { @@ -3161,6 +3488,11 @@ "type": "object", "x-expandableFields": [ "source_types" + ], + "x-stripeMostCommon": [ + "amount", + "destination", + "source_types" ] }, "balance_transaction": { @@ -3323,6 +3655,18 @@ "source" ], "x-resourceId": "balance_transaction", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "fee", + "fee_details", + "id", + "net", + "source", + "status", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -3586,6 +3930,19 @@ "requirements" ], "x-resourceId": "bank_account", + "x-stripeMostCommon": [ + "account_holder_name", + "account_holder_type", + "bank_name", + "country", + "currency", + "customer", + "fingerprint", + "id", + "last4", + "metadata", + "routing_number" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -3692,6 +4049,11 @@ "x-expandableFields": [ "account", "customer" + ], + "x-stripeMostCommon": [ + "account", + "customer", + "type" ] }, "bank_connections_resource_balance": { @@ -3734,6 +4096,13 @@ "x-expandableFields": [ "cash", "credit" + ], + "x-stripeMostCommon": [ + "as_of", + "cash", + "credit", + "current", + "type" ] }, "bank_connections_resource_balance_api_resource_cash_balance": { @@ -3753,7 +4122,10 @@ ], "title": "BankConnectionsResourceBalanceAPIResourceCashBalance", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "available" + ] }, "bank_connections_resource_balance_api_resource_credit_balance": { "description": "", @@ -3772,7 +4144,10 @@ ], "title": "BankConnectionsResourceBalanceAPIResourceCreditBalance", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "used" + ] }, "bank_connections_resource_balance_refresh": { "description": "", @@ -3805,7 +4180,12 @@ ], "title": "BankConnectionsResourceBalanceRefresh", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "last_attempted_at", + "next_refresh_available_at", + "status" + ] }, "bank_connections_resource_link_account_session_filters": { "description": "", @@ -3841,7 +4221,11 @@ ], "title": "BankConnectionsResourceLinkAccountSessionFilters", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_subcategories", + "countries" + ] }, "bank_connections_resource_ownership_refresh": { "description": "", @@ -3874,7 +4258,12 @@ ], "title": "BankConnectionsResourceOwnershipRefresh", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "last_attempted_at", + "next_refresh_available_at", + "status" + ] }, "bank_connections_resource_transaction_refresh": { "description": "", @@ -3913,7 +4302,13 @@ ], "title": "BankConnectionsResourceTransactionRefresh", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "last_attempted_at", + "next_refresh_available_at", + "status" + ] }, "bank_connections_resource_transaction_resource_status_transitions": { "description": "", @@ -3937,7 +4332,11 @@ ], "title": "BankConnectionsResourceTransactionResourceStatusTransitions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "posted_at", + "void_at" + ] }, "billing.alert": { "description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.", @@ -3947,7 +4346,8 @@ "enum": [ "usage_threshold" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "filter": { "anyOf": [ @@ -4016,6 +4416,16 @@ "usage_threshold_config" ], "x-resourceId": "billing.alert", + "x-stripeMostCommon": [ + "alert_type", + "filter", + "id", + "livemode", + "object", + "status", + "title", + "usage_threshold_config" + ], "x-stripeOperations": [ { "method_name": "list", @@ -4127,6 +4537,14 @@ "x-expandableFields": [ "alert" ], + "x-stripeMostCommon": [ + "alert", + "created", + "customer", + "livemode", + "object", + "value" + ], "x-stripeResource": { "class_name": "AlertTriggered", "in_package": "Billing" @@ -4225,6 +4643,21 @@ "value_settings" ], "x-resourceId": "billing.meter", + "x-stripeMostCommon": [ + "created", + "customer_mapping", + "default_aggregation", + "display_name", + "event_name", + "event_time_window", + "id", + "livemode", + "object", + "status", + "status_transitions", + "updated", + "value_settings" + ], "x-stripeOperations": [ { "method_name": "list", @@ -4331,6 +4764,15 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "billing.meter_event", + "x-stripeMostCommon": [ + "created", + "event_name", + "identifier", + "livemode", + "object", + "payload", + "timestamp" + ], "x-stripeOperations": [ { "method_name": "create", @@ -4403,6 +4845,14 @@ "cancel" ], "x-resourceId": "billing.meter_event_adjustment", + "x-stripeMostCommon": [ + "cancel", + "event_name", + "livemode", + "object", + "status", + "type" + ], "x-stripeOperations": [ { "method_name": "create", @@ -4469,6 +4919,15 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "billing.meter_event_summary", + "x-stripeMostCommon": [ + "aggregated_value", + "end_time", + "id", + "livemode", + "meter", + "object", + "start_time" + ], "x-stripeOperations": [ { "method_name": "list", @@ -4484,6 +4943,41 @@ "in_package": "Billing" } }, + "billing_clocks_resource_status_details_advancing_status_details": { + "description": "", + "properties": { + "target_frozen_time": { + "description": "The `frozen_time` that the Test Clock is advancing towards.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "target_frozen_time" + ], + "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails", + "type": "object", + "x-expandableFields": [], + "x-stripeMostCommon": [ + "target_frozen_time" + ] + }, + "billing_clocks_resource_status_details_status_details": { + "description": "", + "properties": { + "advancing": { + "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details" + } + }, + "title": "BillingClocksResourceStatusDetailsStatusDetails", + "type": "object", + "x-expandableFields": [ + "advancing" + ], + "x-stripeMostCommon": [ + "advancing" + ] + }, "billing_details": { "description": "", "properties": { @@ -4525,6 +5019,12 @@ "type": "object", "x-expandableFields": [ "address" + ], + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" ] }, "billing_meter_resource_aggregation_settings": { @@ -4544,7 +5044,10 @@ ], "title": "BillingMeterResourceAggregationSettings", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "formula" + ] }, "billing_meter_resource_billing_meter_event_adjustment_cancel": { "description": "", @@ -4561,7 +5064,10 @@ ], "title": "BillingMeterResourceBillingMeterEventAdjustmentCancel", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "identifier" + ] }, "billing_meter_resource_billing_meter_status_transitions": { "description": "", @@ -4578,7 +5084,10 @@ ], "title": "BillingMeterResourceBillingMeterStatusTransitions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "deactivated_at" + ] }, "billing_meter_resource_billing_meter_value": { "description": "", @@ -4594,7 +5103,10 @@ ], "title": "BillingMeterResourceBillingMeterValue", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "event_payload_key" + ] }, "billing_meter_resource_customer_mapping_settings": { "description": "", @@ -4618,7 +5130,11 @@ ], "title": "BillingMeterResourceCustomerMappingSettings", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "event_payload_key", + "type" + ] }, "billing_portal.configuration": { "description": "A portal configuration describes the functionality and behavior of a portal session.", @@ -4732,6 +5248,21 @@ "login_page" ], "x-resourceId": "billing_portal.configuration", + "x-stripeMostCommon": [ + "active", + "application", + "business_profile", + "created", + "default_return_url", + "features", + "id", + "is_default", + "livemode", + "login_page", + "metadata", + "object", + "updated" + ], "x-stripeOperations": [ { "method_name": "list", @@ -4949,6 +5480,19 @@ "flow" ], "x-resourceId": "billing_portal.session", + "x-stripeMostCommon": [ + "configuration", + "created", + "customer", + "flow", + "id", + "livemode", + "locale", + "object", + "on_behalf_of", + "return_url", + "url" + ], "x-stripeOperations": [ { "method_name": "create", @@ -5021,7 +5565,12 @@ ], "title": "CancellationDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "comment", + "feedback", + "reason" + ] }, "capability": { "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)", @@ -5101,6 +5650,13 @@ "requirements" ], "x-resourceId": "capability", + "x-stripeMostCommon": [ + "account", + "id", + "requested", + "requirements", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -5415,6 +5971,27 @@ "networks" ], "x-resourceId": "card", + "x-stripeMostCommon": [ + "address_city", + "address_country", + "address_line1", + "address_line2", + "address_state", + "address_zip", + "address_zip_check", + "brand", + "country", + "customer", + "cvc_check", + "exp_month", + "exp_year", + "fingerprint", + "funding", + "id", + "last4", + "metadata", + "name" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -5475,6 +6052,10 @@ "type": "object", "x-expandableFields": [ "card_present" + ], + "x-stripeMostCommon": [ + "card_present", + "type" ] }, "card_issuing_account_terms_of_service": { @@ -5503,7 +6084,12 @@ ], "title": "CardIssuingAccountTermsOfService", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "card_mandate_payment_method_details": { "description": "", @@ -5556,6 +6142,13 @@ "settings" ], "x-resourceId": "cash_balance", + "x-stripeMostCommon": [ + "available", + "customer", + "livemode", + "object", + "settings" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -5955,6 +6548,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "review": { @@ -6142,6 +6741,26 @@ "transfer_data" ], "x-resourceId": "charge", + "x-stripeMostCommon": [ + "amount", + "balance_transaction", + "billing_details", + "currency", + "customer", + "description", + "disputed", + "id", + "invoice", + "metadata", + "payment_intent", + "payment_method_details", + "receipt_email", + "refunded", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -6420,7 +7039,11 @@ }, "title": "ChargeFraudDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "stripe_report", + "user_report" + ] }, "charge_outcome": { "description": "", @@ -6487,6 +7110,15 @@ "type": "object", "x-expandableFields": [ "rule" + ], + "x-stripeMostCommon": [ + "network_status", + "reason", + "risk_level", + "risk_score", + "rule", + "seller_message", + "type" ] }, "charge_transfer_data": { @@ -6525,6 +7157,10 @@ "type": "object", "x-expandableFields": [ "destination" + ], + "x-stripeMostCommon": [ + "amount", + "destination" ] }, "checkout.session": { @@ -6757,6 +7393,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -6931,7 +7573,7 @@ "type": "string" }, "redirect_on_completion": { - "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -7166,6 +7808,22 @@ "total_details" ], "x-resourceId": "checkout.session", + "x-stripeMostCommon": [ + "client_reference_id", + "currency", + "customer", + "customer_email", + "id", + "line_items", + "metadata", + "mode", + "payment_intent", + "payment_status", + "return_url", + "status", + "success_url", + "url" + ], "x-stripeOperations": [ { "method_name": "list", @@ -7332,7 +7990,14 @@ ], "title": "CheckoutAcssDebitMandateOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "checkout_acss_debit_payment_method_options": { "description": "", @@ -7372,6 +8037,12 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "setup_future_usage", + "verification_method" ] }, "checkout_affirm_payment_method_options": { @@ -7387,7 +8058,10 @@ }, "title": "CheckoutAffirmPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_afterpay_clearpay_payment_method_options": { "description": "", @@ -7403,6 +8077,9 @@ "title": "CheckoutAfterpayClearpayPaymentMethodOptions", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ], "x-stripeResource": { "class_name": "AfterpayClearpay", "in_package": "" @@ -7421,7 +8098,10 @@ }, "title": "CheckoutAlipayPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_amazon_pay_payment_method_options": { "description": "", @@ -7437,7 +8117,10 @@ }, "title": "CheckoutAmazonPayPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_au_becs_debit_payment_method_options": { "description": "", @@ -7452,7 +8135,10 @@ }, "title": "CheckoutAuBecsDebitPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_bacs_debit_payment_method_options": { "description": "", @@ -7469,7 +8155,10 @@ }, "title": "CheckoutBacsDebitPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_bancontact_payment_method_options": { "description": "", @@ -7484,7 +8173,10 @@ }, "title": "CheckoutBancontactPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_boleto_payment_method_options": { "description": "", @@ -7508,7 +8200,11 @@ ], "title": "CheckoutBoletoPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "checkout_card_installments_options": { "description": "", @@ -7520,7 +8216,10 @@ }, "title": "CheckoutCardInstallmentsOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "checkout_card_payment_method_options": { "description": "", @@ -7565,6 +8264,13 @@ "type": "object", "x-expandableFields": [ "installments" + ], + "x-stripeMostCommon": [ + "installments", + "request_three_d_secure", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji" ] }, "checkout_cashapp_payment_method_options": { @@ -7580,7 +8286,10 @@ }, "title": "CheckoutCashappPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_customer_balance_bank_transfer_payment_method_options": { "description": "", @@ -7626,6 +8335,11 @@ "type": "object", "x-expandableFields": [ "eu_bank_transfer" + ], + "x-stripeMostCommon": [ + "eu_bank_transfer", + "requested_address_types", + "type" ] }, "checkout_customer_balance_payment_method_options": { @@ -7657,6 +8371,11 @@ "type": "object", "x-expandableFields": [ "bank_transfer" + ], + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" ] }, "checkout_eps_payment_method_options": { @@ -7672,7 +8391,10 @@ }, "title": "CheckoutEpsPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_fpx_payment_method_options": { "description": "", @@ -7687,7 +8409,10 @@ }, "title": "CheckoutFpxPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_giropay_payment_method_options": { "description": "", @@ -7702,7 +8427,10 @@ }, "title": "CheckoutGiropayPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_grab_pay_payment_method_options": { "description": "", @@ -7717,7 +8445,10 @@ }, "title": "CheckoutGrabPayPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_ideal_payment_method_options": { "description": "", @@ -7732,7 +8463,10 @@ }, "title": "CheckoutIdealPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_klarna_payment_method_options": { "description": "", @@ -7749,7 +8483,10 @@ }, "title": "CheckoutKlarnaPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_konbini_payment_method_options": { "description": "", @@ -7772,7 +8509,11 @@ ], "title": "CheckoutKonbiniPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "checkout_link_payment_method_options": { "description": "", @@ -7788,7 +8529,10 @@ }, "title": "CheckoutLinkPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_mobilepay_payment_method_options": { "description": "", @@ -7803,7 +8547,10 @@ }, "title": "CheckoutMobilepayPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_multibanco_payment_method_options": { "description": "", @@ -7818,7 +8565,10 @@ }, "title": "CheckoutMultibancoPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_oxxo_payment_method_options": { "description": "", @@ -7840,7 +8590,11 @@ ], "title": "CheckoutOxxoPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "checkout_p24_payment_method_options": { "description": "", @@ -7855,7 +8609,10 @@ }, "title": "CheckoutP24PaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_paynow_payment_method_options": { "description": "", @@ -7870,7 +8627,10 @@ }, "title": "CheckoutPaynowPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_paypal_payment_method_options": { "description": "", @@ -7909,7 +8669,13 @@ ], "title": "CheckoutPaypalPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "reference", + "setup_future_usage" + ] }, "checkout_pix_payment_method_options": { "description": "", @@ -7925,7 +8691,10 @@ ], "title": "CheckoutPixPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after_seconds" + ] }, "checkout_revolut_pay_payment_method_options": { "description": "", @@ -7941,7 +8710,10 @@ }, "title": "CheckoutRevolutPayPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_sepa_debit_payment_method_options": { "description": "", @@ -7958,7 +8730,10 @@ }, "title": "CheckoutSepaDebitPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_session_payment_method_options": { "description": "", @@ -8095,6 +8870,40 @@ "sofort", "swish", "us_bank_account" + ], + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "us_bank_account" ] }, "checkout_sofort_payment_method_options": { @@ -8110,7 +8919,10 @@ }, "title": "CheckoutSofortPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "checkout_swish_payment_method_options": { "description": "", @@ -8127,7 +8939,10 @@ ], "title": "CheckoutSwishPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference" + ] }, "checkout_us_bank_account_payment_method_options": { "description": "", @@ -8158,6 +8973,11 @@ "type": "object", "x-expandableFields": [ "financial_connections" + ], + "x-stripeMostCommon": [ + "financial_connections", + "setup_future_usage", + "verification_method" ] }, "climate.order": { @@ -8337,6 +9157,30 @@ "product" ], "x-resourceId": "climate.order", + "x-stripeMostCommon": [ + "amount_fees", + "amount_subtotal", + "amount_total", + "beneficiary", + "canceled_at", + "cancellation_reason", + "certificate", + "confirmed_at", + "created", + "currency", + "delayed_at", + "delivered_at", + "delivery_details", + "expected_delivery_year", + "id", + "livemode", + "metadata", + "metric_tons", + "object", + "product", + "product_substituted_at", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -8532,6 +9376,17 @@ "suppliers" ], "x-resourceId": "climate.product", + "x-stripeMostCommon": [ + "created", + "current_prices_per_metric_ton", + "delivery_year", + "id", + "livemode", + "metric_tons_available", + "name", + "object", + "suppliers" + ], "x-stripeOperations": [ { "method_name": "list", @@ -8647,6 +9502,15 @@ "locations" ], "x-resourceId": "climate.supplier", + "x-stripeMostCommon": [ + "id", + "info_url", + "livemode", + "locations", + "name", + "object", + "removal_pathway" + ], "x-stripeOperations": [ { "method_name": "list", @@ -8683,7 +9547,10 @@ ], "title": "ClimateRemovalsBeneficiary", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "public_name" + ] }, "climate_removals_location": { "description": "", @@ -8725,7 +9592,14 @@ ], "title": "ClimateRemovalsLocation", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "city", + "country", + "latitude", + "longitude", + "region" + ] }, "climate_removals_order_deliveries": { "description": "The delivery of a specified quantity of carbon for an order.", @@ -8771,6 +9645,13 @@ "x-expandableFields": [ "location", "supplier" + ], + "x-stripeMostCommon": [ + "delivered_at", + "location", + "metric_tons", + "registry_url", + "supplier" ] }, "climate_removals_products_price": { @@ -8796,7 +9677,12 @@ ], "title": "ClimateRemovalsProductsPrice", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount_fees", + "amount_subtotal", + "amount_total" + ] }, "confirmation_token": { "description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).", @@ -8920,6 +9806,22 @@ "shipping" ], "x-resourceId": "confirmation_token", + "x-stripeMostCommon": [ + "created", + "expires_at", + "id", + "livemode", + "mandate_data", + "object", + "payment_intent", + "payment_method_options", + "payment_method_preview", + "return_url", + "setup_future_usage", + "setup_intent", + "shipping", + "use_stripe_sdk" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -8955,6 +9857,9 @@ "type": "object", "x-expandableFields": [ "customer_acceptance" + ], + "x-stripeMostCommon": [ + "customer_acceptance" ] }, "confirmation_tokens_resource_mandate_data_resource_customer_acceptance": { @@ -8983,6 +9888,10 @@ "type": "object", "x-expandableFields": [ "online" + ], + "x-stripeMostCommon": [ + "online", + "type" ] }, "confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online": { @@ -9007,7 +9916,11 @@ ], "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "confirmation_tokens_resource_payment_method_options": { "description": "Payment-method-specific configuration", @@ -9029,6 +9942,9 @@ "type": "object", "x-expandableFields": [ "card" + ], + "x-stripeMostCommon": [ + "card" ] }, "confirmation_tokens_resource_payment_method_options_resource_card": { @@ -9046,7 +9962,10 @@ ], "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "cvc_token" + ] }, "confirmation_tokens_resource_payment_method_preview": { "description": "Details of the PaymentMethod collected by Payment Element", @@ -9296,6 +10215,11 @@ "us_bank_account", "wechat_pay", "zip" + ], + "x-stripeMostCommon": [ + "billing_details", + "customer", + "type" ] }, "confirmation_tokens_resource_shipping": { @@ -9325,6 +10249,11 @@ "type": "object", "x-expandableFields": [ "address" + ], + "x-stripeMostCommon": [ + "address", + "name", + "phone" ] }, "connect_account_reference": { @@ -9365,6 +10294,10 @@ "type": "object", "x-expandableFields": [ "account" + ], + "x-stripeMostCommon": [ + "account", + "type" ] }, "connect_collection_transfer": { @@ -9427,6 +10360,14 @@ "x-expandableFields": [ "destination" ], + "x-stripeMostCommon": [ + "amount", + "currency", + "destination", + "id", + "livemode", + "object" + ], "x-stripeResource": { "class_name": "ConnectCollectionTransfer", "in_package": "", @@ -9455,6 +10396,10 @@ "x-expandableFields": [ "features" ], + "x-stripeMostCommon": [ + "enabled", + "features" + ], "x-stripeResource": { "class_name": "AccountConfig", "in_package": "" @@ -9474,6 +10419,9 @@ "title": "ConnectEmbeddedAccountFeaturesClaim", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "external_account_collection" + ], "x-stripeResource": { "class_name": "AccountFeatures", "in_package": "" @@ -9544,6 +10492,19 @@ "tax_registrations", "tax_settings" ], + "x-stripeMostCommon": [ + "account_management", + "account_onboarding", + "balances", + "documents", + "notification_banner", + "payment_details", + "payments", + "payouts", + "payouts_list", + "tax_registrations", + "tax_settings" + ], "x-stripeResource": { "class_name": "Components", "in_package": "" @@ -9569,6 +10530,10 @@ "x-expandableFields": [ "features" ], + "x-stripeMostCommon": [ + "enabled", + "features" + ], "x-stripeResource": { "class_name": "BaseConfig", "in_package": "" @@ -9605,6 +10570,10 @@ "x-expandableFields": [ "features" ], + "x-stripeMostCommon": [ + "enabled", + "features" + ], "x-stripeResource": { "class_name": "PaymentsConfig", "in_package": "" @@ -9639,6 +10608,12 @@ "title": "ConnectEmbeddedPaymentsFeatures", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_payments", + "destination_on_behalf_of_charge_management", + "dispute_management", + "refund_management" + ], "x-stripeResource": { "class_name": "PaymentsFeatures", "in_package": "" @@ -9664,6 +10639,10 @@ "x-expandableFields": [ "features" ], + "x-stripeMostCommon": [ + "enabled", + "features" + ], "x-stripeResource": { "class_name": "PayoutsConfig", "in_package": "" @@ -9698,6 +10677,12 @@ "title": "ConnectEmbeddedPayoutsFeatures", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "edit_payout_schedule", + "external_account_collection", + "instant_payouts", + "standard_payouts" + ], "x-stripeResource": { "class_name": "PayoutsFeatures", "in_package": "" @@ -9778,6 +10763,14 @@ "verification_fields" ], "x-resourceId": "country_spec", + "x-stripeMostCommon": [ + "default_currency", + "id", + "supported_bank_account_currencies", + "supported_payment_currencies", + "supported_payment_methods", + "supported_transfer_countries" + ], "x-stripeOperations": [ { "method_name": "list", @@ -9826,7 +10819,11 @@ ], "title": "CountrySpecVerificationFieldDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "additional", + "minimum" + ] }, "country_spec_verification_fields": { "description": "", @@ -9847,6 +10844,10 @@ "x-expandableFields": [ "company", "individual" + ], + "x-stripeMostCommon": [ + "company", + "individual" ] }, "coupon": { @@ -9972,6 +10973,16 @@ "currency_options" ], "x-resourceId": "coupon", + "x-stripeMostCommon": [ + "amount_off", + "currency", + "duration", + "duration_in_months", + "id", + "metadata", + "name", + "percent_off" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -10080,7 +11091,10 @@ ], "title": "CouponAppliesTo", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "products" + ] }, "coupon_currency_option": { "description": "", @@ -10095,7 +11109,10 @@ ], "title": "CouponCurrencyOption", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount_off" + ] }, "credit_note": { "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)", @@ -10240,6 +11257,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -10417,6 +11440,18 @@ "tax_amounts" ], "x-resourceId": "credit_note", + "x-stripeMostCommon": [ + "currency", + "id", + "invoice", + "lines", + "memo", + "metadata", + "reason", + "status", + "subtotal", + "total" + ], "x-stripeOperations": [ { "method_name": "list", @@ -10642,6 +11677,24 @@ "tax_rates" ], "x-resourceId": "credit_note_line_item", + "x-stripeMostCommon": [ + "amount", + "amount_excluding_tax", + "description", + "discount_amount", + "discount_amounts", + "id", + "invoice_line_item", + "livemode", + "object", + "quantity", + "tax_amounts", + "tax_rates", + "type", + "unit_amount", + "unit_amount_decimal", + "unit_amount_excluding_tax" + ], "x-stripeOperations": [ { "method_name": "list", @@ -10734,6 +11787,13 @@ "type": "object", "x-expandableFields": [ "tax_rate" + ], + "x-stripeMostCommon": [ + "amount", + "inclusive", + "tax_rate", + "taxability_reason", + "taxable_amount" ] }, "currency_option": { @@ -10788,6 +11848,9 @@ "x-expandableFields": [ "custom_unit_amount", "tiers" + ], + "x-stripeMostCommon": [ + "unit_amount" ] }, "custom_unit_amount": { @@ -10816,7 +11879,12 @@ ], "title": "CustomUnitAmount", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "maximum", + "minimum", + "preset" + ] }, "customer": { "description": "This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)", @@ -11011,6 +12079,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "subscriptions": { @@ -11050,6 +12124,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "tax": { @@ -11102,6 +12182,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "test_clock": { @@ -11151,6 +12237,16 @@ "test_clock" ], "x-resourceId": "customer", + "x-stripeMostCommon": [ + "address", + "description", + "email", + "id", + "metadata", + "name", + "phone", + "shipping" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -11650,6 +12746,12 @@ "x-expandableFields": [ "offline", "online" + ], + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" ] }, "customer_balance_customer_balance_settings": { @@ -11674,7 +12776,11 @@ ], "title": "CustomerBalanceCustomerBalanceSettings", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reconciliation_mode", + "using_merchant_default" + ] }, "customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft": { "description": "", @@ -11728,6 +12834,10 @@ "balance_transaction", "linked_transaction" ], + "x-stripeMostCommon": [ + "balance_transaction", + "linked_transaction" + ], "x-stripeResource": { "class_name": "AdjustedForOverdraft", "in_package": "" @@ -11763,6 +12873,9 @@ "type": "object", "x-expandableFields": [ "payment_intent" + ], + "x-stripeMostCommon": [ + "payment_intent" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction": { @@ -11779,6 +12892,9 @@ "type": "object", "x-expandableFields": [ "bank_transfer" + ], + "x-stripeMostCommon": [ + "bank_transfer" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer": { @@ -11826,6 +12942,14 @@ "gb_bank_transfer", "jp_bank_transfer", "us_bank_transfer" + ], + "x-stripeMostCommon": [ + "eu_bank_transfer", + "gb_bank_transfer", + "jp_bank_transfer", + "reference", + "type", + "us_bank_transfer" ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer": { @@ -11857,7 +12981,12 @@ ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bic", + "iban_last4", + "sender_name" + ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer": { "description": "", @@ -11888,7 +13017,12 @@ ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_number_last4", + "sender_name", + "sort_code" + ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer": { "description": "", @@ -11919,7 +13053,12 @@ ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "sender_bank", + "sender_branch", + "sender_name" + ] }, "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": { "description": "", @@ -11945,7 +13084,11 @@ ], "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "network", + "sender_name" + ] }, "customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": { "description": "", @@ -11978,6 +13121,9 @@ "x-expandableFields": [ "refund" ], + "x-stripeMostCommon": [ + "refund" + ], "x-stripeResource": { "class_name": "RefundedFromPayment", "in_package": "" @@ -12014,6 +13160,9 @@ "x-expandableFields": [ "balance_transaction" ], + "x-stripeMostCommon": [ + "balance_transaction" + ], "x-stripeResource": { "class_name": "TransferredToBalance", "in_package": "" @@ -12050,6 +13199,9 @@ "x-expandableFields": [ "payment_intent" ], + "x-stripeMostCommon": [ + "payment_intent" + ], "x-stripeResource": { "class_name": "UnappliedFromPayment", "in_package": "" @@ -12206,6 +13358,16 @@ "invoice" ], "x-resourceId": "customer_balance_transaction", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "ending_balance", + "id", + "metadata", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -12376,6 +13538,23 @@ "unapplied_from_payment" ], "x-resourceId": "customer_cash_balance_transaction", + "x-stripeMostCommon": [ + "adjusted_for_overdraft", + "applied_to_payment", + "created", + "currency", + "customer", + "ending_balance", + "funded", + "id", + "livemode", + "net_amount", + "object", + "refunded_from_payment", + "transferred_to_balance", + "type", + "unapplied_from_payment" + ], "x-stripeOperations": [ { "method_name": "list", @@ -12499,6 +13678,12 @@ "customer" ], "x-resourceId": "customer_session", + "x-stripeMostCommon": [ + "client_secret", + "components", + "customer", + "expires_at" + ], "x-stripeOperations": [ { "method_name": "create", @@ -12537,6 +13722,11 @@ "buy_button", "payment_element", "pricing_table" + ], + "x-stripeMostCommon": [ + "buy_button", + "payment_element", + "pricing_table" ] }, "customer_session_resource_components_resource_buy_button": { @@ -12552,7 +13742,10 @@ ], "title": "CustomerSessionResourceComponentsResourceBuyButton", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "customer_session_resource_components_resource_payment_element": { "description": "This hash contains whether the Payment Element is enabled and the features it supports.", @@ -12579,6 +13772,10 @@ "type": "object", "x-expandableFields": [ "features" + ], + "x-stripeMostCommon": [ + "enabled", + "features" ] }, "customer_session_resource_components_resource_payment_element_resource_features": { @@ -12648,7 +13845,15 @@ ], "title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "payment_method_allow_redisplay_filters", + "payment_method_redisplay", + "payment_method_redisplay_limit", + "payment_method_remove", + "payment_method_save", + "payment_method_save_usage" + ] }, "customer_session_resource_components_resource_pricing_table": { "description": "This hash contains whether the pricing table is enabled.", @@ -12663,7 +13868,10 @@ ], "title": "CustomerSessionResourceComponentsResourcePricingTable", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "customer_tax": { "description": "", @@ -12703,6 +13911,11 @@ "type": "object", "x-expandableFields": [ "location" + ], + "x-stripeMostCommon": [ + "automatic_tax", + "ip_address", + "location" ] }, "customer_tax_location": { @@ -12737,7 +13950,12 @@ ], "title": "CustomerTaxLocation", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "country", + "source", + "state" + ] }, "deleted_account": { "description": "", @@ -12771,6 +13989,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_account", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedAccount", "in_package": "" @@ -12808,6 +14031,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_apple_pay_domain", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedApplePayDomain", "in_package": "" @@ -12851,6 +14079,12 @@ "title": "DeletedApplication", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "deleted", + "id", + "name", + "object" + ], "x-stripeResource": { "class_name": "DeletedApplication", "in_package": "" @@ -12893,6 +14127,12 @@ "title": "DeletedBankAccount", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "currency", + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedBankAccount", "in_package": "" @@ -12935,6 +14175,12 @@ "title": "DeletedCard", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "currency", + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedCard", "in_package": "" @@ -12972,6 +14218,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_coupon", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedCoupon", "in_package": "" @@ -13009,6 +14260,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_customer", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedCustomer", "in_package": "" @@ -13143,6 +14399,14 @@ "promotion_code" ], "x-resourceId": "deleted_discount", + "x-stripeMostCommon": [ + "coupon", + "customer", + "deleted", + "id", + "start", + "subscription" + ], "x-stripeResource": { "class_name": "DeletedDiscount", "in_package": "" @@ -13196,6 +14460,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_invoice", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedInvoice", "in_package": "" @@ -13233,6 +14502,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_invoiceitem", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedInvoiceItem", "in_package": "" @@ -13286,6 +14560,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_person", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedPerson", "in_package": "" @@ -13323,6 +14602,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_plan", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedPlan", "in_package": "" @@ -13359,6 +14643,11 @@ "title": "DeletedPrice", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedPrice", "in_package": "" @@ -13396,6 +14685,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_product", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedProduct", "in_package": "" @@ -13433,6 +14727,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_product_feature", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedProductFeature", "in_package": "" @@ -13470,6 +14769,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_radar.value_list", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedValueList", "in_package": "Radar" @@ -13507,6 +14811,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_radar.value_list_item", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedValueListItem", "in_package": "Radar" @@ -13544,6 +14853,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_subscription_item", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedSubscriptionItem", "in_package": "" @@ -13581,6 +14895,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_tax_id", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedTaxId", "in_package": "" @@ -13618,6 +14937,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.configuration", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedConfiguration", "in_package": "Terminal" @@ -13655,6 +14979,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.location", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedLocation", "in_package": "Terminal" @@ -13692,6 +15021,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_terminal.reader", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedReader", "in_package": "Terminal" @@ -13729,6 +15063,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_test_helpers.test_clock", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedTestClock", "in_package": "TestHelpers" @@ -13766,6 +15105,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "deleted_webhook_endpoint", + "x-stripeMostCommon": [ + "deleted", + "id", + "object" + ], "x-stripeResource": { "class_name": "DeletedWebhookEndpoint", "in_package": "" @@ -13905,6 +15249,14 @@ "customer", "promotion_code" ], + "x-stripeMostCommon": [ + "coupon", + "customer", + "end", + "id", + "start", + "subscription" + ], "x-stripeResource": { "class_name": "Discount", "in_package": "" @@ -13951,6 +15303,10 @@ "type": "object", "x-expandableFields": [ "discount" + ], + "x-stripeMostCommon": [ + "amount", + "discount" ] }, "discounts_resource_stackable_discount": { @@ -14028,6 +15384,11 @@ "coupon", "discount", "promotion_code" + ], + "x-stripeMostCommon": [ + "coupon", + "discount", + "promotion_code" ] }, "dispute": { @@ -14182,6 +15543,17 @@ "payment_method_details" ], "x-resourceId": "dispute", + "x-stripeMostCommon": [ + "amount", + "charge", + "currency", + "evidence", + "id", + "metadata", + "payment_intent", + "reason", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -14554,6 +15926,35 @@ "service_documentation", "shipping_documentation", "uncategorized_file" + ], + "x-stripeMostCommon": [ + "access_activity_log", + "billing_address", + "cancellation_policy", + "cancellation_policy_disclosure", + "cancellation_rebuttal", + "customer_communication", + "customer_email_address", + "customer_name", + "customer_purchase_ip", + "customer_signature", + "duplicate_charge_documentation", + "duplicate_charge_explanation", + "duplicate_charge_id", + "product_description", + "receipt", + "refund_policy", + "refund_policy_disclosure", + "refund_refusal_explanation", + "service_date", + "service_documentation", + "shipping_address", + "shipping_carrier", + "shipping_date", + "shipping_documentation", + "shipping_tracking_number", + "uncategorized_file", + "uncategorized_text" ] }, "dispute_evidence_details": { @@ -14586,7 +15987,13 @@ ], "title": "DisputeEvidenceDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "due_by", + "has_evidence", + "past_due", + "submission_count" + ] }, "dispute_payment_method_details": { "description": "", @@ -14619,6 +16026,12 @@ "card", "klarna", "paypal" + ], + "x-stripeMostCommon": [ + "card", + "klarna", + "paypal", + "type" ] }, "dispute_payment_method_details_card": { @@ -14652,7 +16065,12 @@ ], "title": "DisputePaymentMethodDetailsCard", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "brand", + "case_type", + "network_reason_code" + ] }, "dispute_payment_method_details_klarna": { "description": "", @@ -14669,7 +16087,10 @@ ], "title": "DisputePaymentMethodDetailsKlarna", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reason_code" + ] }, "dispute_payment_method_details_paypal": { "description": "", @@ -14693,7 +16114,11 @@ ], "title": "DisputePaymentMethodDetailsPaypal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "case_id", + "reason_code" + ] }, "email_sent": { "description": "", @@ -14715,7 +16140,11 @@ ], "title": "EmailSent", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "email_sent_at", + "email_sent_to" + ] }, "entitlements.active_entitlement": { "description": "An active entitlement describes access to a feature for a customer.", @@ -14774,6 +16203,11 @@ "feature" ], "x-resourceId": "entitlements.active_entitlement", + "x-stripeMostCommon": [ + "feature", + "id", + "lookup_key" + ], "x-stripeOperations": [ { "method_name": "list", @@ -14840,6 +16274,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -14865,6 +16305,10 @@ "x-expandableFields": [ "entitlements" ], + "x-stripeMostCommon": [ + "customer", + "entitlements" + ], "x-stripeResource": { "class_name": "ActiveEntitlementSummary", "in_package": "Entitlements" @@ -14941,6 +16385,12 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "entitlements.feature", + "x-stripeMostCommon": [ + "id", + "lookup_key", + "metadata", + "name" + ], "x-stripeOperations": [ { "method_name": "list", @@ -15023,6 +16473,13 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "ephemeral_key", + "x-stripeMostCommon": [ + "created", + "expires", + "id", + "livemode", + "object" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -15374,6 +16831,13 @@ "request" ], "x-resourceId": "event", + "x-stripeMostCommon": [ + "api_version", + "data", + "id", + "request", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -15428,6 +16892,10 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "exchange_rate", + "x-stripeMostCommon": [ + "id", + "rates" + ], "x-stripeOperations": [ { "method_name": "list", @@ -15574,6 +17042,12 @@ "type": "object", "x-expandableFields": [ "errors" + ], + "x-stripeMostCommon": [ + "currently_due", + "errors", + "past_due", + "pending_verification" ] }, "fee": { @@ -15614,7 +17088,14 @@ ], "title": "Fee", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "application", + "currency", + "description", + "type" + ] }, "fee_refund": { "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)", @@ -15710,6 +17191,13 @@ "fee" ], "x-resourceId": "fee_refund", + "x-stripeMostCommon": [ + "amount", + "currency", + "fee", + "id", + "metadata" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -15834,6 +17322,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "object": { @@ -15856,6 +17350,7 @@ "finance_report_run", "identity_document", "identity_document_downloadable", + "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", @@ -15906,6 +17401,11 @@ "links" ], "x-resourceId": "file", + "x-stripeMostCommon": [ + "id", + "purpose", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -16036,6 +17536,13 @@ "file" ], "x-resourceId": "file_link", + "x-stripeMostCommon": [ + "expires_at", + "file", + "id", + "metadata", + "url" + ], "x-stripeOperations": [ { "method_name": "list", @@ -16279,6 +17786,27 @@ "transaction_refresh" ], "x-resourceId": "financial_connections.account", + "x-stripeMostCommon": [ + "account_holder", + "balance", + "balance_refresh", + "category", + "created", + "display_name", + "id", + "institution_name", + "last4", + "livemode", + "object", + "ownership", + "ownership_refresh", + "permissions", + "status", + "subcategory", + "subscriptions", + "supported_payment_method_types", + "transaction_refresh" + ], "x-stripeOperations": [ { "method_name": "list", @@ -16512,6 +18040,16 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "financial_connections.account_owner", + "x-stripeMostCommon": [ + "email", + "id", + "name", + "object", + "ownership", + "phone", + "raw_address", + "refreshed_at" + ], "x-stripeResource": { "class_name": "AccountOwner", "has_collection_class": true, @@ -16575,6 +18113,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } }, @@ -16589,6 +18133,12 @@ "x-expandableFields": [ "owners" ], + "x-stripeMostCommon": [ + "created", + "id", + "object", + "owners" + ], "x-stripeResource": { "class_name": "AccountOwnership", "in_package": "FinancialConnections" @@ -16644,6 +18194,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "client_secret": { @@ -16722,6 +18278,18 @@ "filters" ], "x-resourceId": "financial_connections.session", + "x-stripeMostCommon": [ + "account_holder", + "accounts", + "client_secret", + "filters", + "id", + "livemode", + "object", + "permissions", + "prefetch", + "return_url" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -16829,6 +18397,20 @@ "status_transitions" ], "x-resourceId": "financial_connections.transaction", + "x-stripeMostCommon": [ + "account", + "amount", + "currency", + "description", + "id", + "livemode", + "object", + "status", + "status_transitions", + "transacted_at", + "transaction_refresh", + "updated" + ], "x-stripeOperations": [ { "method_name": "list", @@ -16899,7 +18481,17 @@ }, "title": "FinancialReportingFinanceReportRunRunParameters", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "columns", + "connected_account", + "currency", + "interval_end", + "interval_start", + "payout", + "reporting_category", + "timezone" + ] }, "forwarded_request_context": { "description": "Metadata about the forwarded request.", @@ -16920,7 +18512,11 @@ ], "title": "ForwardedRequestContext", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "destination_duration", + "destination_ip_address" + ] }, "forwarded_request_details": { "description": "Details about the request forwarded to the destination endpoint.", @@ -16954,6 +18550,11 @@ "type": "object", "x-expandableFields": [ "headers" + ], + "x-stripeMostCommon": [ + "body", + "headers", + "http_method" ] }, "forwarded_request_header": { @@ -16976,7 +18577,11 @@ ], "title": "ForwardedRequestHeader", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "name", + "value" + ] }, "forwarded_response_details": { "description": "Details about the response from the destination endpoint.", @@ -17007,6 +18612,11 @@ "type": "object", "x-expandableFields": [ "headers" + ], + "x-stripeMostCommon": [ + "body", + "headers", + "status" ] }, "forwarding.request": { @@ -17105,6 +18715,18 @@ "response_details" ], "x-resourceId": "forwarding.request", + "x-stripeMostCommon": [ + "created", + "id", + "livemode", + "object", + "payment_method", + "replacements", + "request_context", + "request_details", + "response_details", + "url" + ], "x-stripeOperations": [ { "method_name": "list", @@ -17177,6 +18799,11 @@ "bank_transfer" ], "x-resourceId": "funding_instructions", + "x-stripeMostCommon": [ + "bank_transfer", + "currency", + "funding_type" + ], "x-stripeResource": { "class_name": "FundingInstructions", "in_package": "" @@ -17217,6 +18844,11 @@ "x-expandableFields": [ "financial_addresses" ], + "x-stripeMostCommon": [ + "country", + "financial_addresses", + "type" + ], "x-stripeResource": { "class_name": "BankTransfer", "in_package": "" @@ -17249,6 +18881,11 @@ "title": "FundingInstructionsBankTransferABARecord", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_number", + "bank_name", + "routing_number" + ], "x-stripeResource": { "class_name": "Aba", "in_package": "" @@ -17319,6 +18956,16 @@ "spei", "swift", "zengin" + ], + "x-stripeMostCommon": [ + "aba", + "iban", + "sort_code", + "spei", + "supported_networks", + "swift", + "type", + "zengin" ] }, "funding_instructions_bank_transfer_iban_record": { @@ -17353,7 +19000,13 @@ ], "title": "FundingInstructionsBankTransferIbanRecord", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_holder_name", + "bic", + "country", + "iban" + ] }, "funding_instructions_bank_transfer_sort_code_record": { "description": "Sort Code Records contain U.K. bank account details per the sort code format.", @@ -17382,6 +19035,11 @@ "title": "FundingInstructionsBankTransferSortCodeRecord", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_holder_name", + "account_number", + "sort_code" + ], "x-stripeResource": { "class_name": "SortCodeRecords", "in_package": "" @@ -17413,7 +19071,12 @@ ], "title": "FundingInstructionsBankTransferSpeiRecord", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_code", + "bank_name", + "clabe" + ] }, "funding_instructions_bank_transfer_swift_record": { "description": "SWIFT Records contain U.S. bank account details per the SWIFT format.", @@ -17441,7 +19104,12 @@ ], "title": "FundingInstructionsBankTransferSwiftRecord", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_number", + "bank_name", + "swift_code" + ] }, "funding_instructions_bank_transfer_zengin_record": { "description": "Zengin Records contain Japan bank account details per the Zengin format.", @@ -17500,7 +19168,16 @@ ], "title": "FundingInstructionsBankTransferZenginRecord", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_holder_name", + "account_number", + "account_type", + "bank_code", + "bank_name", + "branch_code", + "branch_name" + ] }, "gelato_data_document_report_date_of_birth": { "description": "Point in Time", @@ -17528,7 +19205,12 @@ ], "title": "GelatoDataDocumentReportDateOfBirth", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "gelato_data_document_report_expiration_date": { "description": "Point in Time", @@ -17556,7 +19238,12 @@ ], "title": "GelatoDataDocumentReportExpirationDate", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "gelato_data_document_report_issued_date": { "description": "Point in Time", @@ -17584,7 +19271,12 @@ ], "title": "GelatoDataDocumentReportIssuedDate", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "gelato_data_id_number_report_date": { "description": "Point in Time", @@ -17612,7 +19304,12 @@ ], "title": "GelatoDataIdNumberReportDate", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "gelato_data_verified_outputs_date": { "description": "Point in Time", @@ -17640,7 +19337,12 @@ ], "title": "GelatoDataVerifiedOutputsDate", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "gelato_document_report": { "description": "Result from a document check", @@ -17762,6 +19464,20 @@ "error", "expiration_date", "issued_date" + ], + "x-stripeMostCommon": [ + "address", + "dob", + "error", + "expiration_date", + "files", + "first_name", + "issued_date", + "issuing_country", + "last_name", + "number", + "status", + "type" ] }, "gelato_document_report_error": { @@ -17791,7 +19507,11 @@ ], "title": "GelatoDocumentReportError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "reason" + ] }, "gelato_email_report": { "description": "Result from a email check", @@ -17830,6 +19550,11 @@ "type": "object", "x-expandableFields": [ "error" + ], + "x-stripeMostCommon": [ + "email", + "error", + "status" ] }, "gelato_email_report_error": { @@ -17857,7 +19582,11 @@ ], "title": "GelatoEmailReportError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "reason" + ] }, "gelato_id_number_report": { "description": "Result from an id_number check", @@ -17930,6 +19659,15 @@ "x-expandableFields": [ "dob", "error" + ], + "x-stripeMostCommon": [ + "dob", + "error", + "first_name", + "id_number", + "id_number_type", + "last_name", + "status" ] }, "gelato_id_number_report_error": { @@ -17958,7 +19696,11 @@ ], "title": "GelatoIdNumberReportError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "reason" + ] }, "gelato_phone_report": { "description": "Result from a phone check", @@ -17997,6 +19739,11 @@ "type": "object", "x-expandableFields": [ "error" + ], + "x-stripeMostCommon": [ + "error", + "phone", + "status" ] }, "gelato_phone_report_error": { @@ -18024,7 +19771,11 @@ ], "title": "GelatoPhoneReportError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "reason" + ] }, "gelato_provided_details": { "description": "", @@ -18042,7 +19793,11 @@ }, "title": "GelatoProvidedDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "email", + "phone" + ] }, "gelato_report_document_options": { "description": "", @@ -18074,7 +19829,13 @@ }, "title": "GelatoReportDocumentOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allowed_types", + "require_id_number", + "require_live_capture", + "require_matching_selfie" + ] }, "gelato_report_id_number_options": { "description": "", @@ -18127,6 +19888,12 @@ "type": "object", "x-expandableFields": [ "error" + ], + "x-stripeMostCommon": [ + "document", + "error", + "selfie", + "status" ] }, "gelato_selfie_report_error": { @@ -18156,7 +19923,11 @@ ], "title": "GelatoSelfieReportError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "reason" + ] }, "gelato_session_document_options": { "description": "", @@ -18188,7 +19959,13 @@ }, "title": "GelatoSessionDocumentOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allowed_types", + "require_id_number", + "require_live_capture", + "require_matching_selfie" + ] }, "gelato_session_email_options": { "description": "", @@ -18200,7 +19977,10 @@ }, "title": "GelatoSessionEmailOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "require_verification" + ] }, "gelato_session_id_number_options": { "description": "", @@ -18252,7 +20032,11 @@ ], "title": "GelatoSessionLastError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "reason" + ] }, "gelato_session_phone_options": { "description": "", @@ -18264,7 +20048,10 @@ }, "title": "GelatoSessionPhoneOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "require_verification" + ] }, "gelato_verification_report_options": { "description": "", @@ -18281,6 +20068,10 @@ "x-expandableFields": [ "document", "id_number" + ], + "x-stripeMostCommon": [ + "document", + "id_number" ] }, "gelato_verification_session_options": { @@ -18306,6 +20097,12 @@ "email", "id_number", "phone" + ], + "x-stripeMostCommon": [ + "document", + "email", + "id_number", + "phone" ] }, "gelato_verified_outputs": { @@ -18383,6 +20180,16 @@ "x-expandableFields": [ "address", "dob" + ], + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "first_name", + "id_number", + "id_number_type", + "last_name", + "phone" ] }, "identity.verification_report": { @@ -18475,6 +20282,22 @@ "selfie" ], "x-resourceId": "identity.verification_report", + "x-stripeMostCommon": [ + "client_reference_id", + "created", + "document", + "email", + "id", + "id_number", + "livemode", + "object", + "options", + "phone", + "selfie", + "type", + "verification_flow", + "verification_session" + ], "x-stripeOperations": [ { "method_name": "list", @@ -18672,6 +20495,26 @@ "verified_outputs" ], "x-resourceId": "identity.verification_session", + "x-stripeMostCommon": [ + "client_reference_id", + "client_secret", + "created", + "id", + "last_error", + "last_verification_report", + "livemode", + "metadata", + "object", + "options", + "provided_details", + "redaction", + "related_customer", + "status", + "type", + "url", + "verification_flow", + "verified_outputs" + ], "x-stripeOperations": [ { "method_name": "list", @@ -18845,6 +20688,11 @@ "x-expandableFields": [ "billing_details", "us_bank_account" + ], + "x-stripeMostCommon": [ + "billing_details", + "type", + "us_bank_account" ] }, "inbound_transfers_payment_method_details_us_bank_account": { @@ -18933,6 +20781,16 @@ "x-expandableFields": [ "mandate" ], + "x-stripeMostCommon": [ + "account_holder_type", + "account_type", + "bank_name", + "fingerprint", + "last4", + "mandate", + "network", + "routing_number" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" @@ -18979,7 +20837,14 @@ ], "title": "internal_card", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "brand", + "country", + "exp_month", + "exp_year", + "last4" + ] }, "invoice": { "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)", @@ -19436,6 +21301,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -19844,6 +21715,24 @@ "transfer_data" ], "x-resourceId": "invoice", + "x-stripeMostCommon": [ + "auto_advance", + "charge", + "collection_method", + "currency", + "customer", + "description", + "hosted_invoice_url", + "id", + "lines", + "metadata", + "payment_intent", + "period_end", + "period_start", + "status", + "subscription", + "total" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -20226,7 +22115,10 @@ ], "title": "invoice_installments_card", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "invoice_item_threshold_reason": { "description": "", @@ -20250,7 +22142,11 @@ ], "title": "InvoiceItemThresholdReason", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "line_item_ids", + "usage_gte" + ] }, "invoice_line_item_period": { "description": "", @@ -20272,7 +22168,11 @@ ], "title": "InvoiceLineItemPeriod", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "end", + "start" + ] }, "invoice_mandate_options_card": { "description": "", @@ -20305,7 +22205,12 @@ ], "title": "invoice_mandate_options_card", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description" + ] }, "invoice_payment_method_options_acss_debit": { "description": "", @@ -20328,6 +22233,10 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" ] }, "invoice_payment_method_options_acss_debit_mandate_options": { @@ -20348,7 +22257,10 @@ ], "title": "invoice_payment_method_options_acss_debit_mandate_options", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "transaction_type" + ] }, "invoice_payment_method_options_bancontact": { "description": "", @@ -20369,7 +22281,10 @@ ], "title": "invoice_payment_method_options_bancontact", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "preferred_language" + ] }, "invoice_payment_method_options_card": { "description": "", @@ -20395,6 +22310,10 @@ "type": "object", "x-expandableFields": [ "installments" + ], + "x-stripeMostCommon": [ + "installments", + "request_three_d_secure" ] }, "invoice_payment_method_options_customer_balance": { @@ -20419,6 +22338,10 @@ "type": "object", "x-expandableFields": [ "bank_transfer" + ], + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" ] }, "invoice_payment_method_options_customer_balance_bank_transfer": { @@ -20440,6 +22363,10 @@ "type": "object", "x-expandableFields": [ "eu_bank_transfer" + ], + "x-stripeMostCommon": [ + "eu_bank_transfer", + "type" ] }, "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer": { @@ -20463,7 +22390,10 @@ ], "title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "country" + ] }, "invoice_payment_method_options_konbini": { "description": "", @@ -20500,6 +22430,10 @@ "type": "object", "x-expandableFields": [ "financial_connections" + ], + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" ] }, "invoice_payment_method_options_us_bank_account_linked_account_options": { @@ -20543,6 +22477,11 @@ "type": "object", "x-expandableFields": [ "filters" + ], + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" ] }, "invoice_payment_method_options_us_bank_account_linked_account_options_filters": { @@ -20562,7 +22501,10 @@ }, "title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_subcategories" + ] }, "invoice_rendering_pdf": { "description": "", @@ -20583,7 +22525,122 @@ ], "title": "InvoiceRenderingPdf", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "page_size" + ] + }, + "invoice_rendering_template": { + "description": "", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "metadata": { + "additionalProperties": { + "maxLength": 500, + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "nullable": true, + "type": "object" + }, + "nickname": { + "description": "A brief description of the template, hidden from customers", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "invoice_rendering_template" + ], + "type": "string" + }, + "status": { + "description": "The status of the template, one of `active` or `archived`.", + "enum": [ + "active", + "archived" + ], + "type": "string" + }, + "version": { + "description": "Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering", + "type": "integer" + } + }, + "required": [ + "created", + "id", + "livemode", + "metadata", + "nickname", + "object", + "status", + "version" + ], + "title": "InvoiceRenderingTemplate", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "invoice_rendering_template", + "x-stripeMostCommon": [ + "created", + "id", + "livemode", + "metadata", + "nickname", + "object", + "status", + "version" + ], + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/invoice_rendering_templates" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/invoice_rendering_templates/{template}" + }, + { + "method_name": "archive", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoice_rendering_templates/{template}/archive" + }, + { + "method_name": "unarchive", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoice_rendering_templates/{template}/unarchive" + } + ], + "x-stripeResource": { + "class_name": "InvoiceRenderingTemplate", + "has_collection_class": true, + "in_package": "" + } }, "invoice_setting_custom_field": { "description": "", @@ -20605,7 +22662,11 @@ ], "title": "InvoiceSettingCustomField", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "name", + "value" + ] }, "invoice_setting_customer_rendering_options": { "description": "", @@ -20615,14 +22676,25 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "template": { + "description": "ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ - "amount_tax_display" + "amount_tax_display", + "template" ], "title": "InvoiceSettingCustomerRenderingOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount_tax_display", + "template" + ] }, "invoice_setting_customer_setting": { "description": "", @@ -20683,6 +22755,12 @@ "custom_fields", "default_payment_method", "rendering_options" + ], + "x-stripeMostCommon": [ + "custom_fields", + "default_payment_method", + "footer", + "rendering_options" ] }, "invoice_setting_quote_setting": { @@ -20705,6 +22783,10 @@ "type": "object", "x-expandableFields": [ "issuer" + ], + "x-stripeMostCommon": [ + "days_until_due", + "issuer" ] }, "invoice_setting_rendering_options": { @@ -20722,7 +22804,10 @@ ], "title": "InvoiceSettingRenderingOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount_tax_display" + ] }, "invoice_setting_subscription_schedule_phase_setting": { "description": "", @@ -20781,6 +22866,11 @@ "x-expandableFields": [ "account_tax_ids", "issuer" + ], + "x-stripeMostCommon": [ + "account_tax_ids", + "days_until_due", + "issuer" ] }, "invoice_setting_subscription_schedule_setting": { @@ -20834,6 +22924,11 @@ "x-expandableFields": [ "account_tax_ids", "issuer" + ], + "x-stripeMostCommon": [ + "account_tax_ids", + "days_until_due", + "issuer" ] }, "invoice_tax_amount": { @@ -20906,6 +23001,13 @@ "type": "object", "x-expandableFields": [ "tax_rate" + ], + "x-stripeMostCommon": [ + "amount", + "inclusive", + "tax_rate", + "taxability_reason", + "taxable_amount" ] }, "invoice_threshold_reason": { @@ -20932,6 +23034,10 @@ "type": "object", "x-expandableFields": [ "item_reasons" + ], + "x-stripeMostCommon": [ + "amount_gte", + "item_reasons" ] }, "invoice_transfer_data": { @@ -20970,6 +23076,10 @@ "type": "object", "x-expandableFields": [ "destination" + ], + "x-stripeMostCommon": [ + "amount", + "destination" ] }, "invoiceitem": { @@ -21223,6 +23333,17 @@ "test_clock" ], "x-resourceId": "invoiceitem", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "id", + "metadata", + "period", + "price", + "proration" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -21384,6 +23505,15 @@ "konbini", "sepa_debit", "us_bank_account" + ], + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "konbini", + "sepa_debit", + "us_bank_account" ] }, "invoices_payment_settings": { @@ -21455,6 +23585,11 @@ "type": "object", "x-expandableFields": [ "payment_method_options" + ], + "x-stripeMostCommon": [ + "default_mandate", + "payment_method_options", + "payment_method_types" ] }, "invoices_resource_from_invoice": { @@ -21493,6 +23628,10 @@ "type": "object", "x-expandableFields": [ "invoice" + ], + "x-stripeMostCommon": [ + "action", + "invoice" ] }, "invoices_resource_invoice_rendering": { @@ -21512,16 +23651,35 @@ ], "description": "Invoice pdf rendering options", "nullable": true + }, + "template": { + "description": "ID of the rendering template that the invoice is formatted by.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "template_version": { + "description": "Version of the rendering template that the invoice is using.", + "nullable": true, + "type": "integer" } }, "required": [ "amount_tax_display", - "pdf" + "pdf", + "template", + "template_version" ], "title": "InvoicesResourceInvoiceRendering", "type": "object", "x-expandableFields": [ "pdf" + ], + "x-stripeMostCommon": [ + "amount_tax_display", + "pdf", + "template", + "template_version" ] }, "invoices_resource_invoice_tax_id": { @@ -21621,7 +23779,11 @@ ], "title": "InvoicesResourceInvoiceTaxID", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type", + "value" + ] }, "invoices_resource_line_items_credited_items": { "description": "", @@ -21646,7 +23808,11 @@ ], "title": "InvoicesResourceLineItemsCreditedItems", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "invoice", + "invoice_line_items" + ] }, "invoices_resource_line_items_proration_details": { "description": "", @@ -21668,6 +23834,9 @@ "type": "object", "x-expandableFields": [ "credited_items" + ], + "x-stripeMostCommon": [ + "credited_items" ] }, "invoices_resource_shipping_cost": { @@ -21724,6 +23893,13 @@ "x-expandableFields": [ "shipping_rate", "taxes" + ], + "x-stripeMostCommon": [ + "amount_subtotal", + "amount_tax", + "amount_total", + "shipping_rate", + "taxes" ] }, "invoices_resource_status_transitions": { @@ -21762,7 +23938,13 @@ ], "title": "InvoicesResourceStatusTransitions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "finalized_at", + "marked_uncollectible_at", + "paid_at", + "voided_at" + ] }, "issuing.authorization": { "description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)", @@ -22013,6 +24195,16 @@ "verification_data" ], "x-resourceId": "issuing.authorization", + "x-stripeMostCommon": [ + "amount", + "approved", + "card", + "cardholder", + "currency", + "id", + "metadata", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -22332,6 +24524,18 @@ "wallets" ], "x-resourceId": "issuing.card", + "x-stripeMostCommon": [ + "cancellation_reason", + "cardholder", + "currency", + "exp_month", + "exp_year", + "id", + "last4", + "metadata", + "status", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -22540,6 +24744,14 @@ "spending_controls" ], "x-resourceId": "issuing.cardholder", + "x-stripeMostCommon": [ + "billing", + "email", + "id", + "metadata", + "name", + "phone_number" + ], "x-stripeOperations": [ { "method_name": "list", @@ -22714,6 +24926,16 @@ "treasury" ], "x-resourceId": "issuing.dispute", + "x-stripeMostCommon": [ + "amount", + "balance_transactions", + "currency", + "evidence", + "id", + "metadata", + "status", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -22894,6 +25116,21 @@ "rejection_reasons" ], "x-resourceId": "issuing.personalization_design", + "x-stripeMostCommon": [ + "card_logo", + "carrier_text", + "created", + "id", + "livemode", + "lookup_key", + "metadata", + "name", + "object", + "physical_bundle", + "preferences", + "rejection_reasons", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -23011,6 +25248,15 @@ "features" ], "x-resourceId": "issuing.physical_bundle", + "x-stripeMostCommon": [ + "features", + "id", + "livemode", + "name", + "object", + "status", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -23141,6 +25387,20 @@ "network_data" ], "x-resourceId": "issuing.token", + "x-stripeMostCommon": [ + "card", + "created", + "device_fingerprint", + "id", + "last4", + "livemode", + "network", + "network_data", + "network_updated_at", + "object", + "status", + "wallet_provider" + ], "x-stripeOperations": [ { "method_name": "list", @@ -23433,6 +25693,16 @@ "treasury" ], "x-resourceId": "issuing.transaction", + "x-stripeMostCommon": [ + "amount", + "authorization", + "card", + "cardholder", + "currency", + "id", + "metadata", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -23554,7 +25824,11 @@ ], "title": "IssuingAuthorizationAmountDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "atm_fee", + "cashback_amount" + ] }, "issuing_authorization_authentication_exemption": { "description": "", @@ -23584,7 +25858,11 @@ ], "title": "IssuingAuthorizationAuthenticationExemption", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "claimed_by", + "type" + ] }, "issuing_authorization_fleet_cardholder_prompt_data": { "description": "", @@ -23635,7 +25913,15 @@ ], "title": "IssuingAuthorizationFleetCardholderPromptData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "alphanumeric_id", + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] }, "issuing_authorization_fleet_data": { "description": "", @@ -23690,6 +25976,12 @@ "x-expandableFields": [ "cardholder_prompt_data", "reported_breakdown" + ], + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" ] }, "issuing_authorization_fleet_fuel_price_data": { @@ -23707,7 +25999,10 @@ ], "title": "IssuingAuthorizationFleetFuelPriceData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "issuing_authorization_fleet_non_fuel_price_data": { "description": "", @@ -23724,7 +26019,10 @@ ], "title": "IssuingAuthorizationFleetNonFuelPriceData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "issuing_authorization_fleet_reported_breakdown": { "description": "", @@ -23768,6 +26066,11 @@ "fuel", "non_fuel", "tax" + ], + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" ] }, "issuing_authorization_fleet_tax_data": { @@ -23792,7 +26095,11 @@ ], "title": "IssuingAuthorizationFleetTaxData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] }, "issuing_authorization_fuel_data": { "description": "", @@ -23852,7 +26159,14 @@ ], "title": "IssuingAuthorizationFuelData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "issuing_authorization_merchant_data": { "description": "", @@ -23929,7 +26243,19 @@ ], "title": "IssuingAuthorizationMerchantData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "category", + "category_code", + "city", + "country", + "name", + "network_id", + "postal_code", + "state", + "terminal_id", + "url" + ] }, "issuing_authorization_network_data": { "description": "", @@ -23960,7 +26286,12 @@ ], "title": "IssuingAuthorizationNetworkData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "acquiring_institution_id", + "system_trace_audit_number", + "transaction_id" + ] }, "issuing_authorization_pending_request": { "description": "", @@ -24013,6 +26344,15 @@ "type": "object", "x-expandableFields": [ "amount_details" + ], + "x-stripeMostCommon": [ + "amount", + "amount_details", + "currency", + "is_amount_controllable", + "merchant_amount", + "merchant_currency", + "network_risk_score" ] }, "issuing_authorization_request": { @@ -24122,6 +26462,20 @@ "type": "object", "x-expandableFields": [ "amount_details" + ], + "x-stripeMostCommon": [ + "amount", + "amount_details", + "approved", + "authorization_code", + "created", + "currency", + "merchant_amount", + "merchant_currency", + "network_risk_score", + "reason", + "reason_message", + "requested_at" ] }, "issuing_authorization_three_d_secure": { @@ -24144,7 +26498,10 @@ ], "title": "IssuingAuthorizationThreeDSecure", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "result" + ] }, "issuing_authorization_treasury": { "description": "", @@ -24179,7 +26536,12 @@ ], "title": "IssuingAuthorizationTreasury", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "received_credits", + "received_debits", + "transaction" + ] }, "issuing_authorization_verification_data": { "description": "", @@ -24259,6 +26621,15 @@ "x-expandableFields": [ "authentication_exemption", "three_d_secure" + ], + "x-stripeMostCommon": [ + "address_line1_check", + "address_postal_code_check", + "authentication_exemption", + "cvc_check", + "expiry_check", + "postal_code", + "three_d_secure" ] }, "issuing_card.created": { @@ -24317,7 +26688,11 @@ ], "title": "IssuingCardApplePay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "eligible", + "ineligible_reason" + ] }, "issuing_card_authorization_controls": { "description": "", @@ -24976,6 +27351,14 @@ "type": "object", "x-expandableFields": [ "spending_limits" + ], + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "blocked_categories", + "blocked_merchant_countries", + "spending_limits", + "spending_limits_currency" ] }, "issuing_card_google_pay": { @@ -25002,7 +27385,11 @@ ], "title": "IssuingCardGooglePay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "eligible", + "ineligible_reason" + ] }, "issuing_card_shipping": { "description": "", @@ -25107,6 +27494,7 @@ }, "required": [ "address", + "address_validation", "carrier", "customs", "eta", @@ -25125,6 +27513,21 @@ "address", "address_validation", "customs" + ], + "x-stripeMostCommon": [ + "address", + "address_validation", + "carrier", + "customs", + "eta", + "name", + "phone_number", + "require_signature", + "service", + "status", + "tracking_number", + "tracking_url", + "type" ] }, "issuing_card_shipping_address_validation": { @@ -25168,6 +27571,11 @@ "type": "object", "x-expandableFields": [ "normalized_address" + ], + "x-stripeMostCommon": [ + "mode", + "normalized_address", + "result" ] }, "issuing_card_shipping_customs": { @@ -25185,7 +27593,10 @@ ], "title": "IssuingCardShippingCustoms", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "eori_number" + ] }, "issuing_card_spending_limit": { "description": "", @@ -25519,7 +27930,12 @@ ], "title": "IssuingCardSpendingLimit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "issuing_card_wallets": { "description": "", @@ -25547,6 +27963,11 @@ "x-expandableFields": [ "apple_pay", "google_pay" + ], + "x-stripeMostCommon": [ + "apple_pay", + "google_pay", + "primary_account_identifier" ] }, "issuing_cardholder.created": { @@ -25595,6 +28016,9 @@ "type": "object", "x-expandableFields": [ "address" + ], + "x-stripeMostCommon": [ + "address" ] }, "issuing_cardholder_authorization_controls": { @@ -26254,6 +28678,14 @@ "type": "object", "x-expandableFields": [ "spending_limits" + ], + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "blocked_categories", + "blocked_merchant_countries", + "spending_limits", + "spending_limits_currency" ] }, "issuing_cardholder_card_issuing": { @@ -26276,6 +28708,9 @@ "type": "object", "x-expandableFields": [ "user_terms_acceptance" + ], + "x-stripeMostCommon": [ + "user_terms_acceptance" ] }, "issuing_cardholder_company": { @@ -26291,7 +28726,10 @@ ], "title": "IssuingCardholderCompany", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "tax_id_provided" + ] }, "issuing_cardholder_id_document": { "description": "", @@ -26346,6 +28784,10 @@ "x-expandableFields": [ "back", "front" + ], + "x-stripeMostCommon": [ + "back", + "front" ] }, "issuing_cardholder_individual": { @@ -26403,6 +28845,13 @@ "card_issuing", "dob", "verification" + ], + "x-stripeMostCommon": [ + "card_issuing", + "dob", + "first_name", + "last_name", + "verification" ] }, "issuing_cardholder_individual_dob": { @@ -26431,7 +28880,12 @@ ], "title": "IssuingCardholderIndividualDOB", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "issuing_cardholder_requirements": { "description": "", @@ -26474,7 +28928,11 @@ ], "title": "IssuingCardholderRequirements", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "disabled_reason", + "past_due" + ] }, "issuing_cardholder_spending_limit": { "description": "", @@ -26808,7 +29266,12 @@ ], "title": "IssuingCardholderSpendingLimit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "issuing_cardholder_user_terms_acceptance": { "description": "", @@ -26839,7 +29302,12 @@ ], "title": "IssuingCardholderUserTermsAcceptance", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "issuing_cardholder_verification": { "description": "", @@ -26861,6 +29329,9 @@ "type": "object", "x-expandableFields": [ "document" + ], + "x-stripeMostCommon": [ + "document" ] }, "issuing_dispute.closed": { @@ -27058,6 +29529,18 @@ "type": "object", "x-expandableFields": [ "additional_documentation" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_policy_provided", + "cancellation_reason", + "expected_at", + "explanation", + "product_description", + "product_type", + "return_status", + "returned_at" ] }, "issuing_dispute_duplicate_evidence": { @@ -27171,6 +29654,14 @@ "card_statement", "cash_receipt", "check_image" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "card_statement", + "cash_receipt", + "check_image", + "explanation", + "original_transaction" ] }, "issuing_dispute_evidence": { @@ -27230,6 +29721,17 @@ "not_received", "other", "service_not_as_described" + ], + "x-stripeMostCommon": [ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "no_valid_authorization", + "not_received", + "other", + "reason", + "service_not_as_described" ] }, "issuing_dispute_fraudulent_evidence": { @@ -27270,6 +29772,10 @@ "type": "object", "x-expandableFields": [ "additional_documentation" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" ] }, "issuing_dispute_merchandise_not_as_described_evidence": { @@ -27341,6 +29847,14 @@ "type": "object", "x-expandableFields": [ "additional_documentation" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "received_at", + "return_description", + "return_status", + "returned_at" ] }, "issuing_dispute_no_valid_authorization_evidence": { @@ -27381,6 +29895,10 @@ "type": "object", "x-expandableFields": [ "additional_documentation" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" ] }, "issuing_dispute_not_received_evidence": { @@ -27445,6 +29963,13 @@ "type": "object", "x-expandableFields": [ "additional_documentation" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "expected_at", + "explanation", + "product_description", + "product_type" ] }, "issuing_dispute_other_evidence": { @@ -27502,6 +30027,12 @@ "type": "object", "x-expandableFields": [ "additional_documentation" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "product_description", + "product_type" ] }, "issuing_dispute_service_not_as_described_evidence": { @@ -27563,6 +30094,13 @@ "type": "object", "x-expandableFields": [ "additional_documentation" + ], + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_reason", + "explanation", + "received_at" ] }, "issuing_dispute_treasury": { @@ -27586,7 +30124,11 @@ ], "title": "IssuingDisputeTreasury", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "debit_reversal", + "received_debit" + ] }, "issuing_network_token_address": { "description": "", @@ -27608,7 +30150,11 @@ ], "title": "IssuingNetworkTokenAddress", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "line1", + "postal_code" + ] }, "issuing_network_token_device": { "description": "", @@ -27650,7 +30196,15 @@ }, "title": "IssuingNetworkTokenDevice", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "device_fingerprint", + "ip_address", + "location", + "name", + "phone_number", + "type" + ] }, "issuing_network_token_mastercard": { "description": "", @@ -27682,7 +30236,13 @@ ], "title": "IssuingNetworkTokenMastercard", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "card_reference_id", + "token_reference_id", + "token_requestor_id", + "token_requestor_name" + ] }, "issuing_network_token_network_data": { "description": "", @@ -27718,6 +30278,13 @@ "mastercard", "visa", "wallet_provider" + ], + "x-stripeMostCommon": [ + "device", + "mastercard", + "type", + "visa", + "wallet_provider" ] }, "issuing_network_token_visa": { @@ -27751,7 +30318,13 @@ ], "title": "IssuingNetworkTokenVisa", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "card_reference_id", + "token_reference_id", + "token_requestor_id", + "token_risk_score" + ] }, "issuing_network_token_wallet_provider": { "description": "", @@ -27848,6 +30421,18 @@ "type": "object", "x-expandableFields": [ "cardholder_address" + ], + "x-stripeMostCommon": [ + "account_id", + "account_trust_score", + "card_number_source", + "cardholder_address", + "cardholder_name", + "device_trust_score", + "hashed_account_email_address", + "reason_codes", + "suggested_decision", + "suggested_decision_version" ] }, "issuing_personalization_design.activated": { @@ -27950,7 +30535,13 @@ ], "title": "IssuingPersonalizationDesignCarrierText", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "footer_body", + "footer_title", + "header_body", + "header_title" + ] }, "issuing_personalization_design_preferences": { "description": "", @@ -27971,7 +30562,11 @@ ], "title": "IssuingPersonalizationDesignPreferences", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "is_default", + "is_platform_default" + ] }, "issuing_personalization_design_rejection_reasons": { "description": "", @@ -28018,7 +30613,11 @@ ], "title": "IssuingPersonalizationDesignRejectionReasons", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "card_logo", + "carrier_text" + ] }, "issuing_physical_bundle_features": { "description": "", @@ -28058,7 +30657,12 @@ ], "title": "IssuingPhysicalBundleFeatures", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "card_logo", + "carrier_text", + "second_line" + ] }, "issuing_token.created": { "description": "Occurs whenever an issuing digital wallet token is created.", @@ -28144,7 +30748,11 @@ ], "title": "IssuingTransactionAmountDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "atm_fee", + "cashback_amount" + ] }, "issuing_transaction_fleet_cardholder_prompt_data": { "description": "", @@ -28188,7 +30796,14 @@ ], "title": "IssuingTransactionFleetCardholderPromptData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] }, "issuing_transaction_fleet_data": { "description": "", @@ -28235,6 +30850,12 @@ "x-expandableFields": [ "cardholder_prompt_data", "reported_breakdown" + ], + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" ] }, "issuing_transaction_fleet_fuel_price_data": { @@ -28252,7 +30873,10 @@ ], "title": "IssuingTransactionFleetFuelPriceData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "issuing_transaction_fleet_non_fuel_price_data": { "description": "", @@ -28269,7 +30893,10 @@ ], "title": "IssuingTransactionFleetNonFuelPriceData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "issuing_transaction_fleet_reported_breakdown": { "description": "", @@ -28313,6 +30940,11 @@ "fuel", "non_fuel", "tax" + ], + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" ] }, "issuing_transaction_fleet_tax_data": { @@ -28337,7 +30969,11 @@ ], "title": "IssuingTransactionFleetTaxData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] }, "issuing_transaction_flight_data": { "description": "", @@ -28384,6 +31020,13 @@ "type": "object", "x-expandableFields": [ "segments" + ], + "x-stripeMostCommon": [ + "departure_at", + "passenger_name", + "refundable", + "segments", + "travel_agency" ] }, "issuing_transaction_flight_data_leg": { @@ -28435,7 +31078,15 @@ ], "title": "IssuingTransactionFlightDataLeg", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "arrival_airport_code", + "carrier", + "departure_airport_code", + "flight_number", + "service_class", + "stopover_allowed" + ] }, "issuing_transaction_fuel_data": { "description": "", @@ -28477,7 +31128,14 @@ ], "title": "IssuingTransactionFuelData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "issuing_transaction_lodging_data": { "description": "", @@ -28499,7 +31157,11 @@ ], "title": "IssuingTransactionLodgingData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "check_in_at", + "nights" + ] }, "issuing_transaction_network_data": { "description": "", @@ -28530,7 +31192,12 @@ ], "title": "IssuingTransactionNetworkData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "authorization_code", + "processing_date", + "transaction_id" + ] }, "issuing_transaction_purchase_details": { "description": "", @@ -28602,6 +31269,14 @@ "fuel", "lodging", "receipt" + ], + "x-stripeMostCommon": [ + "fleet", + "flight", + "fuel", + "lodging", + "receipt", + "reference" ] }, "issuing_transaction_receipt_data": { @@ -28637,7 +31312,13 @@ ], "title": "IssuingTransactionReceiptData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "description", + "quantity", + "total", + "unit_cost" + ] }, "issuing_transaction_treasury": { "description": "", @@ -28661,7 +31342,11 @@ ], "title": "IssuingTransactionTreasury", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "received_credit", + "received_debit" + ] }, "item": { "description": "A line item.", @@ -28738,7 +31423,6 @@ "amount_tax", "amount_total", "currency", - "description", "id", "object", "price", @@ -28752,6 +31436,20 @@ "taxes" ], "x-resourceId": "item", + "x-stripeMostCommon": [ + "amount_discount", + "amount_subtotal", + "amount_tax", + "amount_total", + "currency", + "description", + "discounts", + "id", + "object", + "price", + "quantity", + "taxes" + ], "x-stripeResource": { "class_name": "LineItem", "has_collection_class": true, @@ -28898,6 +31596,26 @@ "address_kanji", "ownership_declaration", "verification" + ], + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "directors_provided", + "executives_provided", + "export_license_id", + "export_purpose_code", + "name", + "name_kana", + "name_kanji", + "owners_provided", + "ownership_declaration", + "phone", + "structure", + "tax_id_provided", + "tax_id_registrar", + "vat_id_provided", + "verification" ] }, "legal_entity_company_verification": { @@ -28914,6 +31632,9 @@ "type": "object", "x-expandableFields": [ "document" + ], + "x-stripeMostCommon": [ + "document" ] }, "legal_entity_company_verification_document": { @@ -28983,6 +31704,12 @@ "x-expandableFields": [ "back", "front" + ], + "x-stripeMostCommon": [ + "back", + "details", + "details_code", + "front" ] }, "legal_entity_dob": { @@ -29011,7 +31738,12 @@ ], "title": "LegalEntityDOB", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "legal_entity_japan_address": { "description": "", @@ -29070,7 +31802,16 @@ ], "title": "LegalEntityJapanAddress", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "legal_entity_person_verification": { "description": "", @@ -29113,6 +31854,13 @@ "x-expandableFields": [ "additional_document", "document" + ], + "x-stripeMostCommon": [ + "additional_document", + "details", + "details_code", + "document", + "status" ] }, "legal_entity_person_verification_document": { @@ -29182,6 +31930,12 @@ "x-expandableFields": [ "back", "front" + ], + "x-stripeMostCommon": [ + "back", + "details", + "details_code", + "front" ] }, "legal_entity_ubo_declaration": { @@ -29213,7 +31967,12 @@ ], "title": "LegalEntityUBODeclaration", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "level3": { "description": "", @@ -29252,6 +32011,14 @@ "type": "object", "x-expandableFields": [ "line_items" + ], + "x-stripeMostCommon": [ + "customer_reference", + "line_items", + "merchant_reference", + "shipping_address_zip", + "shipping_amount", + "shipping_from_zip" ] }, "level3_line_items": { @@ -29292,10 +32059,18 @@ ], "title": "Level3LineItems", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "discount_amount", + "product_code", + "product_description", + "quantity", + "tax_amount", + "unit_cost" + ] }, "line_item": { - "description": "", + "description": "Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).", "properties": { "amount": { "description": "The amount, in cents (or local equivalent).", @@ -29526,6 +32301,8 @@ "proration_details", "quantity", "subscription", + "tax_amounts", + "tax_rates", "type", "unit_amount_excluding_tax" ], @@ -29545,6 +32322,19 @@ "tax_rates" ], "x-resourceId": "line_item", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "id", + "invoice", + "metadata", + "period", + "price", + "proration", + "quantity", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -29593,6 +32383,10 @@ "type": "object", "x-expandableFields": [ "discount" + ], + "x-stripeMostCommon": [ + "amount", + "discount" ] }, "line_items_tax_amount": { @@ -29644,6 +32438,12 @@ "type": "object", "x-expandableFields": [ "rate" + ], + "x-stripeMostCommon": [ + "amount", + "rate", + "taxability_reason", + "taxable_amount" ] }, "linked_account_options_us_bank_account": { @@ -29692,6 +32492,12 @@ "type": "object", "x-expandableFields": [ "filters" + ], + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch", + "return_url" ] }, "login_link": { @@ -29724,6 +32530,9 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "login_link", + "x-stripeMostCommon": [ + "url" + ], "x-stripeOperations": [ { "method_name": "create", @@ -29831,6 +32640,14 @@ "single_use" ], "x-resourceId": "mandate", + "x-stripeMostCommon": [ + "customer_acceptance", + "id", + "payment_method", + "payment_method_details", + "status", + "type" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -29907,6 +32724,12 @@ "title": "mandate_acss_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ], "x-stripeResource": { "class_name": "AcssDebit", "in_package": "" @@ -29937,7 +32760,10 @@ ], "title": "mandate_au_becs_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "url" + ] }, "mandate_bacs_debit": { "description": "", @@ -29983,7 +32809,13 @@ ], "title": "mandate_bacs_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "network_status", + "reference", + "revocation_reason", + "url" + ] }, "mandate_cashapp": { "description": "", @@ -30069,6 +32901,20 @@ "revolut_pay", "sepa_debit", "us_bank_account" + ], + "x-stripeMostCommon": [ + "acss_debit", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "card", + "cashapp", + "link", + "paypal", + "revolut_pay", + "sepa_debit", + "type", + "us_bank_account" ] }, "mandate_paypal": { @@ -30093,7 +32939,11 @@ ], "title": "mandate_paypal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "billing_agreement_id", + "payer_id" + ] }, "mandate_revolut_pay": { "description": "", @@ -30127,6 +32977,10 @@ "title": "mandate_sepa_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference", + "url" + ], "x-stripeResource": { "class_name": "SepaDebit", "in_package": "" @@ -30150,7 +33004,11 @@ ], "title": "mandate_single_use", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "currency" + ] }, "mandate_us_bank_account": { "description": "", @@ -30167,6 +33025,9 @@ "title": "mandate_us_bank_account", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "collection_method" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" @@ -30196,7 +33057,11 @@ ], "title": "networks", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "available", + "preferred" + ] }, "notification_event_data": { "description": "", @@ -30216,6 +33081,10 @@ "title": "NotificationEventData", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "object", + "previous_attributes" + ], "x-stripeResource": { "class_name": "EventData", "in_package": "" @@ -30243,7 +33112,11 @@ ], "title": "NotificationEventRequest", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "idempotency_key" + ] }, "offline_acceptance": { "description": "", @@ -30274,7 +33147,11 @@ ], "title": "online_acceptance", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "outbound_payments_payment_method_details": { "description": "", @@ -30307,6 +33184,12 @@ "billing_details", "financial_account", "us_bank_account" + ], + "x-stripeMostCommon": [ + "billing_details", + "financial_account", + "type", + "us_bank_account" ] }, "outbound_payments_payment_method_details_financial_account": { @@ -30332,6 +33215,10 @@ "title": "outbound_payments_payment_method_details_financial_account", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "network" + ], "x-stripeResource": { "class_name": "FinancialAccount", "in_package": "" @@ -30424,6 +33311,16 @@ "x-expandableFields": [ "mandate" ], + "x-stripeMostCommon": [ + "account_holder_type", + "account_type", + "bank_name", + "fingerprint", + "last4", + "mandate", + "network", + "routing_number" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" @@ -30457,6 +33354,11 @@ "billing_details", "us_bank_account" ], + "x-stripeMostCommon": [ + "billing_details", + "type", + "us_bank_account" + ], "x-stripeResource": { "class_name": "DestinationPaymentMethodDetails", "in_package": "" @@ -30549,6 +33451,16 @@ "x-expandableFields": [ "mandate" ], + "x-stripeMostCommon": [ + "account_holder_type", + "account_type", + "bank_name", + "fingerprint", + "last4", + "mandate", + "network", + "routing_number" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" @@ -30582,7 +33494,13 @@ ], "title": "PackageDimensions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "height", + "length", + "weight", + "width" + ] }, "payment_flows_amount_details": { "description": "", @@ -30595,6 +33513,9 @@ "type": "object", "x-expandableFields": [ "tip" + ], + "x-stripeMostCommon": [ + "tip" ] }, "payment_flows_amount_details_resource_tip": { @@ -30607,7 +33528,10 @@ }, "title": "PaymentFlowsAmountDetailsResourceTip", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount" + ] }, "payment_flows_automatic_payment_methods_payment_intent": { "description": "", @@ -30630,7 +33554,11 @@ ], "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allow_redirects", + "enabled" + ] }, "payment_flows_automatic_payment_methods_setup_intent": { "description": "", @@ -30654,7 +33582,11 @@ ], "title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allow_redirects", + "enabled" + ] }, "payment_flows_installment_options": { "description": "", @@ -30674,6 +33606,10 @@ "x-expandableFields": [ "plan" ], + "x-stripeMostCommon": [ + "enabled", + "plan" + ], "x-stripeResource": { "class_name": "Installments", "in_package": "" @@ -30713,7 +33649,12 @@ ], "title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "buyer_id", + "fingerprint", + "transaction_id" + ] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization": { "description": "", @@ -30732,7 +33673,10 @@ ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "status" + ] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization": { "description": "", @@ -30751,7 +33695,10 @@ ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "status" + ] }, "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture": { "description": "", @@ -30775,7 +33722,11 @@ ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "maximum_amount_capturable", + "status" + ] }, "payment_flows_private_payment_methods_card_details_api_resource_multicapture": { "description": "", @@ -30794,7 +33745,10 @@ ], "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "status" + ] }, "payment_flows_private_payment_methods_card_present_common_wallet": { "description": "", @@ -30815,7 +33769,10 @@ ], "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type" + ] }, "payment_flows_private_payment_methods_klarna_dob": { "description": "", @@ -30843,7 +33800,12 @@ ], "title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters": { "description": "", @@ -30862,7 +33824,10 @@ }, "title": "PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_subcategories" + ] }, "payment_intent": { "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)", @@ -31331,6 +34296,26 @@ "transfer_data" ], "x-resourceId": "payment_intent", + "x-stripeMostCommon": [ + "amount", + "automatic_payment_methods", + "client_secret", + "currency", + "customer", + "description", + "id", + "last_payment_error", + "latest_charge", + "metadata", + "next_action", + "payment_method", + "receipt_email", + "setup_future_usage", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -31557,6 +34542,9 @@ "x-expandableFields": [ "customer_notification" ], + "x-stripeMostCommon": [ + "customer_notification" + ], "x-stripeResource": { "class_name": "Card", "in_package": "" @@ -31649,6 +34637,27 @@ "wechat_pay_display_qr_code", "wechat_pay_redirect_to_android_app", "wechat_pay_redirect_to_ios_app" + ], + "x-stripeMostCommon": [ + "alipay_handle_redirect", + "boleto_display_details", + "card_await_notification", + "cashapp_handle_redirect_or_display_qr_code", + "display_bank_transfer_instructions", + "konbini_display_details", + "multibanco_display_details", + "oxxo_display_details", + "paynow_display_qr_code", + "pix_display_qr_code", + "promptpay_display_qr_code", + "redirect_to_url", + "swish_handle_redirect_or_display_qr_code", + "type", + "use_stripe_sdk", + "verify_with_microdeposits", + "wechat_pay_display_qr_code", + "wechat_pay_redirect_to_android_app", + "wechat_pay_redirect_to_ios_app" ] }, "payment_intent_next_action_alipay_handle_redirect": { @@ -31688,6 +34697,12 @@ "title": "PaymentIntentNextActionAlipayHandleRedirect", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "native_data", + "native_url", + "return_url", + "url" + ], "x-stripeResource": { "class_name": "NextActionAlipayHandleRedirect", "in_package": "" @@ -31730,6 +34745,12 @@ "title": "payment_intent_next_action_boleto", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_at", + "hosted_voucher_url", + "number", + "pdf" + ], "x-stripeResource": { "class_name": "NextActionDisplayBoletoDetails", "in_package": "" @@ -31757,6 +34778,10 @@ "title": "PaymentIntentNextActionCardAwaitNotification", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "charge_attempt_at", + "customer_approval_required" + ], "x-stripeResource": { "class_name": "NextActionCardAwaitNotification", "in_package": "" @@ -31789,6 +34814,11 @@ "x-expandableFields": [ "qr_code" ], + "x-stripeMostCommon": [ + "hosted_instructions_url", + "mobile_auth_url", + "qr_code" + ], "x-stripeResource": { "class_name": "CashappHandleRedirectOrDisplayQrCode", "in_package": "" @@ -31821,6 +34851,11 @@ "title": "PaymentIntentNextActionCashappQRCode", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_at", + "image_url_png", + "image_url_svg" + ], "x-stripeResource": { "class_name": "CashappQrCode", "in_package": "" @@ -31883,6 +34918,14 @@ "x-expandableFields": [ "financial_addresses" ], + "x-stripeMostCommon": [ + "amount_remaining", + "currency", + "financial_addresses", + "hosted_instructions_url", + "reference", + "type" + ], "x-stripeResource": { "class_name": "NextActionDisplayBankTransferInstructions", "in_package": "" @@ -31925,6 +34968,12 @@ "title": "PaymentIntentNextActionDisplayMultibancoDetails", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "entity", + "expires_at", + "hosted_voucher_url", + "reference" + ], "x-stripeResource": { "class_name": "NextActionMultibancoDisplayDetails", "in_package": "" @@ -31960,6 +35009,11 @@ "title": "PaymentIntentNextActionDisplayOxxoDetails", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after", + "hosted_voucher_url", + "number" + ], "x-stripeResource": { "class_name": "NextActionOxxoDisplayDetails", "in_package": "" @@ -31993,6 +35047,11 @@ "x-expandableFields": [ "stores" ], + "x-stripeMostCommon": [ + "expires_at", + "hosted_voucher_url", + "stores" + ], "x-stripeResource": { "class_name": "NextActionKonbiniDisplayDetails", "in_package": "" @@ -32018,6 +35077,10 @@ "title": "payment_intent_next_action_konbini_familymart", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "confirmation_number", + "payment_code" + ], "x-stripeResource": { "class_name": "Familymart", "in_package": "" @@ -32043,6 +35106,10 @@ "title": "payment_intent_next_action_konbini_lawson", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "confirmation_number", + "payment_code" + ], "x-stripeResource": { "class_name": "Lawson", "in_package": "" @@ -32068,6 +35135,10 @@ "title": "payment_intent_next_action_konbini_ministop", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "confirmation_number", + "payment_code" + ], "x-stripeResource": { "class_name": "Ministop", "in_package": "" @@ -32093,6 +35164,10 @@ "title": "payment_intent_next_action_konbini_seicomart", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "confirmation_number", + "payment_code" + ], "x-stripeResource": { "class_name": "Seicomart", "in_package": "" @@ -32152,6 +35227,12 @@ "ministop", "seicomart" ], + "x-stripeMostCommon": [ + "familymart", + "lawson", + "ministop", + "seicomart" + ], "x-stripeResource": { "class_name": "Stores", "in_package": "" @@ -32191,6 +35272,12 @@ "title": "PaymentIntentNextActionPaynowDisplayQrCode", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "data", + "hosted_instructions_url", + "image_url_png", + "image_url_svg" + ], "x-stripeResource": { "class_name": "PaynowDisplayQrCode", "in_package": "" @@ -32227,6 +35314,13 @@ "title": "PaymentIntentNextActionPixDisplayQrCode", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "data", + "expires_at", + "hosted_instructions_url", + "image_url_png", + "image_url_svg" + ], "x-stripeResource": { "class_name": "PixDisplayQrCode", "in_package": "" @@ -32265,6 +35359,12 @@ "title": "PaymentIntentNextActionPromptpayDisplayQrCode", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "data", + "hosted_instructions_url", + "image_url_png", + "image_url_svg" + ], "x-stripeResource": { "class_name": "PromptpayDisplayQrCode", "in_package": "" @@ -32293,6 +35393,10 @@ "title": "PaymentIntentNextActionRedirectToUrl", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "return_url", + "url" + ], "x-stripeResource": { "class_name": "NextActionRedirectToUrl", "in_package": "" @@ -32325,6 +35429,11 @@ "x-expandableFields": [ "qr_code" ], + "x-stripeMostCommon": [ + "hosted_instructions_url", + "mobile_auth_url", + "qr_code" + ], "x-stripeResource": { "class_name": "SwishHandleRedirectOrDisplayQrCode", "in_package": "" @@ -32357,6 +35466,11 @@ "title": "PaymentIntentNextActionSwishQRCode", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "data", + "image_url_png", + "image_url_svg" + ], "x-stripeResource": { "class_name": "SwishQrCode", "in_package": "" @@ -32392,7 +35506,12 @@ ], "title": "PaymentIntentNextActionVerifyWithMicrodeposits", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "arrival_date", + "hosted_verification_url", + "microdeposit_type" + ] }, "payment_intent_next_action_wechat_pay_display_qr_code": { "description": "", @@ -32433,6 +35552,13 @@ "title": "PaymentIntentNextActionWechatPayDisplayQrCode", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "data", + "hosted_instructions_url", + "image_data_url", + "image_url_png", + "image_url_svg" + ], "x-stripeResource": { "class_name": "WechatPayDisplayQrCode", "in_package": "" @@ -32489,6 +35615,15 @@ "title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "app_id", + "nonce_str", + "package", + "partner_id", + "prepay_id", + "sign", + "timestamp" + ], "x-stripeResource": { "class_name": "WechatPayRedirectToAndroidApp", "in_package": "" @@ -32509,6 +35644,9 @@ "title": "PaymentIntentNextActionWechatPayRedirectToIOSApp", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "native_url" + ], "x-stripeResource": { "class_name": "WechatPayRedirectToIosApp", "in_package": "" @@ -32677,6 +35815,47 @@ "us_bank_account", "wechat_pay", "zip" + ], + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "card_present", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "interac_present", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip" ] }, "payment_intent_payment_method_options_acss_debit": { @@ -32709,6 +35888,11 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "verification_method" ] }, "payment_intent_payment_method_options_au_becs_debit": { @@ -32726,7 +35910,10 @@ }, "title": "payment_intent_payment_method_options_au_becs_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_intent_payment_method_options_bacs_debit": { "description": "", @@ -32748,6 +35935,10 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage" ] }, "payment_intent_payment_method_options_blik": { @@ -32764,7 +35955,10 @@ }, "title": "payment_intent_payment_method_options_blik", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_intent_payment_method_options_card": { "description": "", @@ -32891,6 +36085,21 @@ "x-expandableFields": [ "installments", "mandate_options" + ], + "x-stripeMostCommon": [ + "capture_method", + "installments", + "mandate_options", + "network", + "request_extended_authorization", + "request_incremental_authorization", + "request_multicapture", + "request_overcapture", + "request_three_d_secure", + "require_cvc_recollection", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji" ] }, "payment_intent_payment_method_options_eps": { @@ -32906,7 +36115,10 @@ }, "title": "payment_intent_payment_method_options_eps", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_intent_payment_method_options_link": { "description": "", @@ -32938,7 +36150,12 @@ ], "title": "payment_intent_payment_method_options_link", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "persistent_token", + "setup_future_usage" + ] }, "payment_intent_payment_method_options_mandate_options_acss_debit": { "description": "", @@ -32981,7 +36198,13 @@ ], "title": "payment_intent_payment_method_options_mandate_options_acss_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "custom_mandate_url", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "payment_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", @@ -33025,7 +36248,11 @@ }, "title": "payment_intent_payment_method_options_mobilepay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, "payment_intent_payment_method_options_sepa_debit": { "description": "", @@ -33047,6 +36274,10 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage" ] }, "payment_intent_payment_method_options_swish": { @@ -33071,7 +36302,11 @@ ], "title": "payment_intent_payment_method_options_swish", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference", + "setup_future_usage" + ] }, "payment_intent_payment_method_options_us_bank_account": { "description": "", @@ -33115,6 +36350,13 @@ "x-expandableFields": [ "financial_connections", "mandate_options" + ], + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "preferred_settlement_speed", + "setup_future_usage", + "verification_method" ] }, "payment_intent_processing": { @@ -33138,6 +36380,10 @@ "type": "object", "x-expandableFields": [ "card" + ], + "x-stripeMostCommon": [ + "card", + "type" ] }, "payment_intent_processing_customer_notification": { @@ -33162,6 +36408,10 @@ "title": "PaymentIntentProcessingCustomerNotification", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "approval_requested", + "completes_at" + ], "x-stripeResource": { "class_name": "CustomerNotification", "in_package": "" @@ -33217,6 +36467,15 @@ "x-expandableFields": [ "installments", "routing" + ], + "x-stripeMostCommon": [ + "capture_method", + "installments", + "request_incremental_authorization_support", + "require_cvc_recollection", + "routing", + "setup_future_usage", + "verification_method" ] }, "payment_link": { @@ -33368,6 +36627,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -33591,6 +36856,13 @@ "transfer_data" ], "x-resourceId": "payment_link", + "x-stripeMostCommon": [ + "active", + "id", + "line_items", + "metadata", + "url" + ], "x-stripeOperations": [ { "method_name": "list", @@ -33692,6 +36964,11 @@ "x-expandableFields": [ "hosted_confirmation", "redirect" + ], + "x-stripeMostCommon": [ + "hosted_confirmation", + "redirect", + "type" ] }, "payment_links_resource_automatic_tax": { @@ -33719,6 +36996,10 @@ "type": "object", "x-expandableFields": [ "liability" + ], + "x-stripeMostCommon": [ + "enabled", + "liability" ] }, "payment_links_resource_completed_sessions": { @@ -33739,7 +37020,11 @@ ], "title": "PaymentLinksResourceCompletedSessions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "count", + "limit" + ] }, "payment_links_resource_completion_behavior_confirmation_page": { "description": "", @@ -33756,7 +37041,10 @@ ], "title": "PaymentLinksResourceCompletionBehaviorConfirmationPage", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "custom_message" + ] }, "payment_links_resource_completion_behavior_redirect": { "description": "", @@ -33772,7 +37060,10 @@ ], "title": "PaymentLinksResourceCompletionBehaviorRedirect", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "url" + ] }, "payment_links_resource_consent_collection": { "description": "", @@ -33814,6 +37105,11 @@ "type": "object", "x-expandableFields": [ "payment_method_reuse_agreement" + ], + "x-stripeMostCommon": [ + "payment_method_reuse_agreement", + "promotions", + "terms_of_service" ] }, "payment_links_resource_custom_fields": { @@ -33863,6 +37159,15 @@ "label", "numeric", "text" + ], + "x-stripeMostCommon": [ + "dropdown", + "key", + "label", + "numeric", + "optional", + "text", + "type" ] }, "payment_links_resource_custom_fields_dropdown": { @@ -33883,6 +37188,9 @@ "type": "object", "x-expandableFields": [ "options" + ], + "x-stripeMostCommon": [ + "options" ] }, "payment_links_resource_custom_fields_dropdown_option": { @@ -33906,6 +37214,10 @@ "title": "PaymentLinksResourceCustomFieldsDropdownOption", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "label", + "value" + ], "x-stripeResource": { "class_name": "CustomFieldDropdownOption", "in_package": "" @@ -33934,7 +37246,11 @@ ], "title": "PaymentLinksResourceCustomFieldsLabel", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "custom", + "type" + ] }, "payment_links_resource_custom_fields_numeric": { "description": "", @@ -33956,7 +37272,11 @@ ], "title": "PaymentLinksResourceCustomFieldsNumeric", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "maximum_length", + "minimum_length" + ] }, "payment_links_resource_custom_fields_text": { "description": "", @@ -33978,7 +37298,11 @@ ], "title": "PaymentLinksResourceCustomFieldsText", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "maximum_length", + "minimum_length" + ] }, "payment_links_resource_custom_text": { "description": "", @@ -34033,6 +37357,12 @@ "shipping_address", "submit", "terms_of_service_acceptance" + ], + "x-stripeMostCommon": [ + "after_submit", + "shipping_address", + "submit", + "terms_of_service_acceptance" ] }, "payment_links_resource_custom_text_position": { @@ -34049,7 +37379,10 @@ ], "title": "PaymentLinksResourceCustomTextPosition", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "message" + ] }, "payment_links_resource_invoice_creation": { "description": "", @@ -34076,6 +37409,10 @@ "type": "object", "x-expandableFields": [ "invoice_data" + ], + "x-stripeMostCommon": [ + "enabled", + "invoice_data" ] }, "payment_links_resource_invoice_settings": { @@ -34174,6 +37511,15 @@ "custom_fields", "issuer", "rendering_options" + ], + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "metadata", + "rendering_options" ] }, "payment_links_resource_payment_intent_data": { @@ -34242,7 +37588,16 @@ ], "title": "PaymentLinksResourcePaymentIntentData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "description", + "metadata", + "setup_future_usage", + "statement_descriptor", + "statement_descriptor_suffix", + "transfer_group" + ] }, "payment_links_resource_payment_method_reuse_agreement": { "description": "", @@ -34261,7 +37616,10 @@ ], "title": "PaymentLinksResourcePaymentMethodReuseAgreement", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "position" + ] }, "payment_links_resource_phone_number_collection": { "description": "", @@ -34276,7 +37634,10 @@ ], "title": "PaymentLinksResourcePhoneNumberCollection", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_links_resource_restrictions": { "description": "", @@ -34292,6 +37653,9 @@ "type": "object", "x-expandableFields": [ "completed_sessions" + ], + "x-stripeMostCommon": [ + "completed_sessions" ] }, "payment_links_resource_shipping_address_collection": { @@ -34549,7 +37913,10 @@ ], "title": "PaymentLinksResourceShippingAddressCollection", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allowed_countries" + ] }, "payment_links_resource_shipping_option": { "description": "", @@ -34586,6 +37953,10 @@ "type": "object", "x-expandableFields": [ "shipping_rate" + ], + "x-stripeMostCommon": [ + "shipping_amount", + "shipping_rate" ] }, "payment_links_resource_subscription_data": { @@ -34635,6 +38006,13 @@ "x-expandableFields": [ "invoice_settings", "trial_settings" + ], + "x-stripeMostCommon": [ + "description", + "invoice_settings", + "metadata", + "trial_period_days", + "trial_settings" ] }, "payment_links_resource_subscription_data_invoice_settings": { @@ -34651,6 +38029,9 @@ "type": "object", "x-expandableFields": [ "issuer" + ], + "x-stripeMostCommon": [ + "issuer" ] }, "payment_links_resource_tax_id_collection": { @@ -34666,7 +38047,10 @@ ], "title": "PaymentLinksResourceTaxIdCollection", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_links_resource_transfer_data": { "description": "", @@ -34704,6 +38088,10 @@ "type": "object", "x-expandableFields": [ "destination" + ], + "x-stripeMostCommon": [ + "amount", + "destination" ] }, "payment_method": { @@ -34995,6 +38383,13 @@ "zip" ], "x-resourceId": "payment_method", + "x-stripeMostCommon": [ + "billing_details", + "customer", + "id", + "metadata", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -35152,7 +38547,14 @@ ], "title": "payment_method_acss_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_name", + "fingerprint", + "institution_number", + "last4", + "transit_number" + ] }, "payment_method_affirm": { "description": "", @@ -35204,7 +38606,12 @@ ], "title": "payment_method_au_becs_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bsb_number", + "fingerprint", + "last4" + ] }, "payment_method_bacs_debit": { "description": "", @@ -35235,7 +38642,12 @@ ], "title": "payment_method_bacs_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "fingerprint", + "last4", + "sort_code" + ] }, "payment_method_bancontact": { "description": "", @@ -35265,7 +38677,10 @@ ], "title": "payment_method_boleto", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "tax_id" + ] }, "payment_method_card": { "description": "", @@ -35397,6 +38812,24 @@ "networks", "three_d_secure_usage", "wallet" + ], + "x-stripeMostCommon": [ + "brand", + "checks", + "country", + "description", + "display_brand", + "exp_month", + "exp_year", + "fingerprint", + "funding", + "generated_from", + "iin", + "issuer", + "last4", + "networks", + "three_d_secure_usage", + "wallet" ] }, "payment_method_card_checks": { @@ -35428,7 +38861,12 @@ ], "title": "payment_method_card_checks", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "address_line1_check", + "address_postal_code_check", + "cvc_check" + ] }, "payment_method_card_generated_card": { "description": "", @@ -35479,6 +38917,11 @@ "x-expandableFields": [ "payment_method_details", "setup_attempt" + ], + "x-stripeMostCommon": [ + "charge", + "payment_method_details", + "setup_attempt" ] }, "payment_method_card_present": { @@ -35616,6 +39059,25 @@ "networks", "offline", "wallet" + ], + "x-stripeMostCommon": [ + "brand", + "brand_product", + "cardholder_name", + "country", + "description", + "exp_month", + "exp_year", + "fingerprint", + "funding", + "iin", + "issuer", + "last4", + "networks", + "offline", + "preferred_locales", + "read_method", + "wallet" ] }, "payment_method_card_present_networks": { @@ -35642,7 +39104,11 @@ ], "title": "payment_method_card_present_networks", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "available", + "preferred" + ] }, "payment_method_card_wallet": { "description": "", @@ -35702,6 +39168,17 @@ "masterpass", "samsung_pay", "visa_checkout" + ], + "x-stripeMostCommon": [ + "amex_express_checkout", + "apple_pay", + "dynamic_last4", + "google_pay", + "link", + "masterpass", + "samsung_pay", + "type", + "visa_checkout" ] }, "payment_method_card_wallet_amex_express_checkout": { @@ -35777,6 +39254,12 @@ "x-expandableFields": [ "billing_address", "shipping_address" + ], + "x-stripeMostCommon": [ + "billing_address", + "email", + "name", + "shipping_address" ] }, "payment_method_card_wallet_samsung_pay": { @@ -35831,6 +39314,12 @@ "x-expandableFields": [ "billing_address", "shipping_address" + ], + "x-stripeMostCommon": [ + "billing_address", + "email", + "name", + "shipping_address" ] }, "payment_method_cashapp": { @@ -35855,7 +39344,11 @@ ], "title": "payment_method_cashapp", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "buyer_id", + "cashtag" + ] }, "payment_method_config_biz_payment_method_configuration_details": { "description": "", @@ -35878,7 +39371,11 @@ ], "title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "parent" + ] }, "payment_method_config_resource_display_preference": { "description": "", @@ -35913,7 +39410,12 @@ ], "title": "PaymentMethodConfigResourceDisplayPreference", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "overridable", + "preference", + "value" + ] }, "payment_method_config_resource_payment_method_properties": { "description": "", @@ -35934,6 +39436,10 @@ "type": "object", "x-expandableFields": [ "display_preference" + ], + "x-stripeMostCommon": [ + "available", + "display_preference" ] }, "payment_method_configuration": { @@ -36156,6 +39662,15 @@ "zip" ], "x-resourceId": "payment_method_configuration", + "x-stripeMostCommon": [ + "active", + "application", + "id", + "is_default", + "name", + "object", + "parent" + ], "x-stripeOperations": [ { "method_name": "list", @@ -36390,6 +39905,53 @@ "wechat", "wechat_pay", "zip" + ], + "x-stripeMostCommon": [ + "ach_credit_transfer", + "ach_debit", + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "card_present", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "interac_present", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_credit_transfer", + "sepa_debit", + "sofort", + "stripe_account", + "swish", + "twint", + "type", + "us_bank_account", + "wechat", + "wechat_pay", + "zip" ] }, "payment_method_details_ach_credit_transfer": { @@ -36428,7 +39990,13 @@ ], "title": "payment_method_details_ach_credit_transfer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_number", + "bank_name", + "routing_number", + "swift_code" + ] }, "payment_method_details_ach_debit": { "description": "", @@ -36483,7 +40051,15 @@ ], "title": "payment_method_details_ach_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_holder_type", + "bank_name", + "country", + "fingerprint", + "last4", + "routing_number" + ] }, "payment_method_details_acss_debit": { "description": "", @@ -36533,7 +40109,15 @@ ], "title": "payment_method_details_acss_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_name", + "fingerprint", + "institution_number", + "last4", + "mandate", + "transit_number" + ] }, "payment_method_details_affirm": { "description": "", @@ -36550,7 +40134,10 @@ ], "title": "payment_method_details_affirm", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "transaction_id" + ] }, "payment_method_details_afterpay_clearpay": { "description": "", @@ -36574,7 +40161,11 @@ ], "title": "payment_method_details_afterpay_clearpay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "order_id", + "reference" + ] }, "payment_method_details_amazon_pay": { "description": "", @@ -36617,7 +40208,13 @@ ], "title": "payment_method_details_au_becs_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bsb_number", + "fingerprint", + "last4", + "mandate" + ] }, "payment_method_details_bacs_debit": { "description": "", @@ -36655,7 +40252,13 @@ ], "title": "payment_method_details_bacs_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "fingerprint", + "last4", + "mandate", + "sort_code" + ] }, "payment_method_details_bancontact": { "description": "", @@ -36757,6 +40360,16 @@ "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" + ], + "x-stripeMostCommon": [ + "bank_code", + "bank_name", + "bic", + "generated_sepa_debit", + "generated_sepa_debit_mandate", + "iban_last4", + "preferred_language", + "verified_name" ] }, "payment_method_details_blik": { @@ -36774,7 +40387,10 @@ ], "title": "payment_method_details_blik", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "buyer_id" + ] }, "payment_method_details_boleto": { "description": "", @@ -36790,7 +40406,10 @@ ], "title": "payment_method_details_boleto", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "tax_id" + ] }, "payment_method_details_card": { "description": "", @@ -36970,6 +40589,33 @@ "overcapture", "three_d_secure", "wallet" + ], + "x-stripeMostCommon": [ + "amount_authorized", + "authorization_code", + "brand", + "capture_before", + "checks", + "country", + "description", + "exp_month", + "exp_year", + "extended_authorization", + "fingerprint", + "funding", + "iin", + "incremental_authorization", + "installments", + "issuer", + "last4", + "mandate", + "moto", + "multicapture", + "network", + "network_token", + "overcapture", + "three_d_secure", + "wallet" ] }, "payment_method_details_card_checks": { @@ -37001,7 +40647,12 @@ ], "title": "payment_method_details_card_checks", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "address_line1_check", + "address_postal_code_check", + "cvc_check" + ] }, "payment_method_details_card_installments": { "description": "", @@ -37023,6 +40674,9 @@ "type": "object", "x-expandableFields": [ "plan" + ], + "x-stripeMostCommon": [ + "plan" ] }, "payment_method_details_card_installments_plan": { @@ -37057,7 +40711,12 @@ ], "title": "payment_method_details_card_installments_plan", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, "payment_method_details_card_network_token": { "description": "", @@ -37072,7 +40731,10 @@ ], "title": "payment_method_details_card_network_token", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "used" + ] }, "payment_method_details_card_present": { "description": "", @@ -37258,6 +40920,33 @@ "offline", "receipt", "wallet" + ], + "x-stripeMostCommon": [ + "amount_authorized", + "brand", + "brand_product", + "capture_before", + "cardholder_name", + "country", + "description", + "emv_auth_data", + "exp_month", + "exp_year", + "fingerprint", + "funding", + "generated_card", + "iin", + "incremental_authorization_supported", + "issuer", + "last4", + "network", + "network_transaction_id", + "offline", + "overcapture_supported", + "preferred_locales", + "read_method", + "receipt", + "wallet" ] }, "payment_method_details_card_present_offline": { @@ -37285,6 +40974,10 @@ "title": "payment_method_details_card_present_offline", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "stored_at", + "type" + ], "x-stripeResource": { "class_name": "Offline", "in_package": "" @@ -37365,7 +41058,18 @@ ], "title": "payment_method_details_card_present_receipt", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_type", + "application_cryptogram", + "application_preferred_name", + "authorization_code", + "authorization_response_code", + "cardholder_verification_method", + "dedicated_file_name", + "terminal_verification_results", + "transaction_status_information" + ] }, "payment_method_details_card_wallet": { "description": "", @@ -37425,6 +41129,17 @@ "masterpass", "samsung_pay", "visa_checkout" + ], + "x-stripeMostCommon": [ + "amex_express_checkout", + "apple_pay", + "dynamic_last4", + "google_pay", + "link", + "masterpass", + "samsung_pay", + "type", + "visa_checkout" ] }, "payment_method_details_card_wallet_amex_express_checkout": { @@ -37500,6 +41215,12 @@ "x-expandableFields": [ "billing_address", "shipping_address" + ], + "x-stripeMostCommon": [ + "billing_address", + "email", + "name", + "shipping_address" ] }, "payment_method_details_card_wallet_samsung_pay": { @@ -37554,6 +41275,12 @@ "x-expandableFields": [ "billing_address", "shipping_address" + ], + "x-stripeMostCommon": [ + "billing_address", + "email", + "name", + "shipping_address" ] }, "payment_method_details_cashapp": { @@ -37578,7 +41305,11 @@ ], "title": "payment_method_details_cashapp", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "buyer_id", + "cashtag" + ] }, "payment_method_details_customer_balance": { "description": "", @@ -37638,7 +41369,11 @@ ], "title": "payment_method_details_eps", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank", + "verified_name" + ] }, "payment_method_details_fpx": { "description": "", @@ -37694,7 +41429,12 @@ ], "title": "payment_method_details_fpx", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_holder_type", + "bank", + "transaction_id" + ] }, "payment_method_details_giropay": { "description": "", @@ -37732,7 +41472,13 @@ ], "title": "payment_method_details_giropay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_code", + "bank_name", + "bic", + "verified_name" + ] }, "payment_method_details_grabpay": { "description": "", @@ -37749,7 +41495,10 @@ ], "title": "payment_method_details_grabpay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "transaction_id" + ] }, "payment_method_details_ideal": { "description": "", @@ -37867,6 +41616,14 @@ "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" + ], + "x-stripeMostCommon": [ + "bank", + "bic", + "generated_sepa_debit", + "generated_sepa_debit_mandate", + "iban_last4", + "verified_name" ] }, "payment_method_details_interac_present": { @@ -38010,6 +41767,26 @@ "type": "object", "x-expandableFields": [ "receipt" + ], + "x-stripeMostCommon": [ + "brand", + "cardholder_name", + "country", + "description", + "emv_auth_data", + "exp_month", + "exp_year", + "fingerprint", + "funding", + "generated_card", + "iin", + "issuer", + "last4", + "network", + "network_transaction_id", + "preferred_locales", + "read_method", + "receipt" ] }, "payment_method_details_interac_present_receipt": { @@ -38087,6 +41864,17 @@ "title": "payment_method_details_interac_present_receipt", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_type", + "application_cryptogram", + "application_preferred_name", + "authorization_code", + "authorization_response_code", + "cardholder_verification_method", + "dedicated_file_name", + "terminal_verification_results", + "transaction_status_information" + ], "x-stripeResource": { "class_name": "Receipt", "in_package": "" @@ -38114,7 +41902,11 @@ ], "title": "payment_method_details_klarna", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "payment_method_category", + "preferred_locale" + ] }, "payment_method_details_konbini": { "description": "", @@ -38136,6 +41928,9 @@ "type": "object", "x-expandableFields": [ "store" + ], + "x-stripeMostCommon": [ + "store" ] }, "payment_method_details_konbini_store": { @@ -38158,7 +41953,10 @@ ], "title": "payment_method_details_konbini_store", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "chain" + ] }, "payment_method_details_link": { "description": "", @@ -38175,7 +41973,10 @@ ], "title": "payment_method_details_link", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "country" + ] }, "payment_method_details_mobilepay": { "description": "", @@ -38197,6 +41998,9 @@ "type": "object", "x-expandableFields": [ "card" + ], + "x-stripeMostCommon": [ + "card" ] }, "payment_method_details_multibanco": { @@ -38221,7 +42025,11 @@ ], "title": "payment_method_details_multibanco", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "entity", + "reference" + ] }, "payment_method_details_oxxo": { "description": "", @@ -38238,7 +42046,10 @@ ], "title": "payment_method_details_oxxo", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "number" + ] }, "payment_method_details_p24": { "description": "", @@ -38296,7 +42107,12 @@ ], "title": "payment_method_details_p24", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank", + "reference", + "verified_name" + ] }, "payment_method_details_paynow": { "description": "", @@ -38313,7 +42129,10 @@ ], "title": "payment_method_details_paynow", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference" + ] }, "payment_method_details_paypal": { "description": "", @@ -38363,6 +42182,13 @@ "type": "object", "x-expandableFields": [ "seller_protection" + ], + "x-stripeMostCommon": [ + "payer_email", + "payer_id", + "payer_name", + "seller_protection", + "transaction_id" ] }, "payment_method_details_pix": { @@ -38377,7 +42203,10 @@ }, "title": "payment_method_details_pix", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_transaction_id" + ] }, "payment_method_details_promptpay": { "description": "", @@ -38394,7 +42223,10 @@ ], "title": "payment_method_details_promptpay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference" + ] }, "payment_method_details_revolut_pay": { "description": "", @@ -38432,7 +42264,12 @@ ], "title": "payment_method_details_sepa_credit_transfer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_name", + "bic", + "iban" + ] }, "payment_method_details_sepa_debit": { "description": "", @@ -38484,7 +42321,15 @@ ], "title": "payment_method_details_sepa_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_code", + "branch_code", + "country", + "fingerprint", + "last4", + "mandate" + ] }, "payment_method_details_sofort": { "description": "", @@ -38596,6 +42441,17 @@ "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" + ], + "x-stripeMostCommon": [ + "bank_code", + "bank_name", + "bic", + "country", + "generated_sepa_debit", + "generated_sepa_debit_mandate", + "iban_last4", + "preferred_language", + "verified_name" ] }, "payment_method_details_stripe_account": { @@ -38634,7 +42490,12 @@ ], "title": "payment_method_details_swish", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "fingerprint", + "payment_reference", + "verified_phone_last4" + ] }, "payment_method_details_twint": { "description": "", @@ -38727,6 +42588,16 @@ "type": "object", "x-expandableFields": [ "mandate" + ], + "x-stripeMostCommon": [ + "account_holder_type", + "account_type", + "bank_name", + "fingerprint", + "last4", + "mandate", + "payment_reference", + "routing_number" ] }, "payment_method_details_wechat": { @@ -38758,7 +42629,11 @@ ], "title": "payment_method_details_wechat_pay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "fingerprint", + "transaction_id" + ] }, "payment_method_details_zip": { "description": "", @@ -38834,6 +42709,11 @@ "paypal" ], "x-resourceId": "payment_method_domain", + "x-stripeMostCommon": [ + "domain_name", + "enabled", + "id" + ], "x-stripeOperations": [ { "method_name": "list", @@ -38899,6 +42779,9 @@ "type": "object", "x-expandableFields": [ "status_details" + ], + "x-stripeMostCommon": [ + "status" ] }, "payment_method_domain_resource_payment_method_status_details": { @@ -38915,7 +42798,10 @@ ], "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "error_message" + ] }, "payment_method_eps": { "description": "", @@ -38961,7 +42847,10 @@ ], "title": "payment_method_eps", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank" + ] }, "payment_method_fpx": { "description": "", @@ -39010,7 +42899,11 @@ ], "title": "payment_method_fpx", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "payment_method_giropay": { "description": "", @@ -39083,7 +42976,11 @@ ], "title": "payment_method_ideal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank", + "bic" + ] }, "payment_method_interac_present": { "description": "", @@ -39198,6 +43095,22 @@ "type": "object", "x-expandableFields": [ "networks" + ], + "x-stripeMostCommon": [ + "brand", + "cardholder_name", + "country", + "description", + "exp_month", + "exp_year", + "fingerprint", + "funding", + "iin", + "issuer", + "last4", + "networks", + "preferred_locales", + "read_method" ] }, "payment_method_klarna": { @@ -39217,6 +43130,9 @@ "type": "object", "x-expandableFields": [ "dob" + ], + "x-stripeMostCommon": [ + "dob" ] }, "payment_method_konbini": { @@ -39246,7 +43162,11 @@ ], "title": "payment_method_link", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "email", + "persistent_token" + ] }, "payment_method_mobilepay": { "description": "", @@ -39287,7 +43207,12 @@ }, "title": "payment_method_options_affirm", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "setup_future_usage" + ] }, "payment_method_options_afterpay_clearpay": { "description": "", @@ -39319,7 +43244,12 @@ ], "title": "payment_method_options_afterpay_clearpay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, "payment_method_options_alipay": { "description": "", @@ -39335,7 +43265,10 @@ }, "title": "payment_method_options_alipay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_amazon_pay": { "description": "", @@ -39358,7 +43291,11 @@ }, "title": "payment_method_options_amazon_pay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, "payment_method_options_bancontact": { "description": "", @@ -39387,7 +43324,11 @@ ], "title": "payment_method_options_bancontact", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, "payment_method_options_boleto": { "description": "", @@ -39411,7 +43352,11 @@ ], "title": "payment_method_options_boleto", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "payment_method_options_card_installments": { "description": "", @@ -39448,6 +43393,11 @@ "x-expandableFields": [ "available_plans", "plan" + ], + "x-stripeMostCommon": [ + "available_plans", + "enabled", + "plan" ] }, "payment_method_options_card_mandate_options": { @@ -39529,6 +43479,17 @@ "title": "payment_method_options_card_mandate_options", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ], "x-stripeResource": { "class_name": "MandateOptions", "in_package": "" @@ -39559,6 +43520,11 @@ "type": "object", "x-expandableFields": [ "routing" + ], + "x-stripeMostCommon": [ + "request_extended_authorization", + "request_incremental_authorization_support", + "routing" ] }, "payment_method_options_card_present_routing": { @@ -39580,6 +43546,9 @@ "title": "payment_method_options_card_present_routing", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "requested_priority" + ], "x-stripeResource": { "class_name": "Routing", "in_package": "" @@ -39607,7 +43576,11 @@ }, "title": "payment_method_options_cashapp", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, "payment_method_options_customer_balance": { "description": "", @@ -39638,6 +43611,11 @@ "type": "object", "x-expandableFields": [ "bank_transfer" + ], + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" ] }, "payment_method_options_customer_balance_bank_transfer": { @@ -39684,6 +43662,11 @@ "type": "object", "x-expandableFields": [ "eu_bank_transfer" + ], + "x-stripeMostCommon": [ + "eu_bank_transfer", + "requested_address_types", + "type" ] }, "payment_method_options_customer_balance_eu_bank_account": { @@ -39707,7 +43690,10 @@ ], "title": "payment_method_options_customer_balance_eu_bank_account", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "country" + ] }, "payment_method_options_fpx": { "description": "", @@ -39722,7 +43708,10 @@ }, "title": "payment_method_options_fpx", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_giropay": { "description": "", @@ -39737,7 +43726,10 @@ }, "title": "payment_method_options_giropay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_grabpay": { "description": "", @@ -39752,7 +43744,10 @@ }, "title": "payment_method_options_grabpay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_ideal": { "description": "", @@ -39768,7 +43763,10 @@ }, "title": "payment_method_options_ideal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_interac_present": { "description": "", @@ -39807,7 +43805,12 @@ ], "title": "payment_method_options_klarna", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "setup_future_usage" + ] }, "payment_method_options_konbini": { "description": "", @@ -39851,7 +43854,14 @@ ], "title": "payment_method_options_konbini", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "confirmation_number", + "expires_after_days", + "expires_at", + "product_description", + "setup_future_usage" + ] }, "payment_method_options_multibanco": { "description": "", @@ -39866,7 +43876,10 @@ }, "title": "payment_method_options_multibanco", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_oxxo": { "description": "", @@ -39888,7 +43901,11 @@ ], "title": "payment_method_options_oxxo", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "payment_method_options_p24": { "description": "", @@ -39903,7 +43920,10 @@ }, "title": "payment_method_options_p24", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_paynow": { "description": "", @@ -39918,7 +43938,10 @@ }, "title": "payment_method_options_paynow", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_paypal": { "description": "", @@ -39957,7 +43980,13 @@ ], "title": "payment_method_options_paypal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "reference", + "setup_future_usage" + ] }, "payment_method_options_pix": { "description": "", @@ -39986,7 +44015,12 @@ ], "title": "payment_method_options_pix", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "expires_after_seconds", + "expires_at", + "setup_future_usage" + ] }, "payment_method_options_promptpay": { "description": "", @@ -40001,7 +44035,10 @@ }, "title": "payment_method_options_promptpay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_revolut_pay": { "description": "", @@ -40024,7 +44061,11 @@ }, "title": "payment_method_options_revolut_pay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, "payment_method_options_sofort": { "description": "", @@ -40057,7 +44098,11 @@ ], "title": "payment_method_options_sofort", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, "payment_method_options_twint": { "description": "", @@ -40072,7 +44117,10 @@ }, "title": "payment_method_options_twint", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_options_us_bank_account_mandate_options": { "description": "", @@ -40088,7 +44136,10 @@ }, "title": "payment_method_options_us_bank_account_mandate_options", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "collection_method" + ] }, "payment_method_options_wechat_pay": { "description": "", @@ -40124,7 +44175,12 @@ ], "title": "payment_method_options_wechat_pay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] }, "payment_method_options_zip": { "description": "", @@ -40139,7 +44195,10 @@ }, "title": "payment_method_options_zip", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "payment_method_oxxo": { "description": "", @@ -40191,7 +44250,10 @@ ], "title": "payment_method_p24", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank" + ] }, "payment_method_paynow": { "description": "", @@ -40222,7 +44284,11 @@ ], "title": "payment_method_paypal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "payer_email", + "payer_id" + ] }, "payment_method_pix": { "description": "", @@ -40300,6 +44366,14 @@ "type": "object", "x-expandableFields": [ "generated_from" + ], + "x-stripeMostCommon": [ + "bank_code", + "branch_code", + "country", + "fingerprint", + "generated_from", + "last4" ] }, "payment_method_sofort": { @@ -40317,7 +44391,10 @@ ], "title": "payment_method_sofort", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "country" + ] }, "payment_method_swish": { "description": "", @@ -40419,6 +44496,17 @@ "x-expandableFields": [ "networks", "status_details" + ], + "x-stripeMostCommon": [ + "account_holder_type", + "account_type", + "bank_name", + "financial_connections_account", + "fingerprint", + "last4", + "networks", + "routing_number", + "status_details" ] }, "payment_method_us_bank_account_blocked": { @@ -40463,7 +44551,11 @@ ], "title": "payment_method_us_bank_account_blocked", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "network_code", + "reason" + ] }, "payment_method_us_bank_account_status_details": { "description": "", @@ -40476,6 +44568,9 @@ "type": "object", "x-expandableFields": [ "blocked" + ], + "x-stripeMostCommon": [ + "blocked" ] }, "payment_method_wechat_pay": { @@ -40512,6 +44607,9 @@ "type": "object", "x-expandableFields": [ "recovery" + ], + "x-stripeMostCommon": [ + "recovery" ] }, "payment_pages_checkout_session_after_expiration_recovery": { @@ -40546,7 +44644,13 @@ ], "title": "PaymentPagesCheckoutSessionAfterExpirationRecovery", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allow_promotion_codes", + "enabled", + "expires_at", + "url" + ] }, "payment_pages_checkout_session_automatic_tax": { "description": "", @@ -40584,6 +44688,11 @@ "type": "object", "x-expandableFields": [ "liability" + ], + "x-stripeMostCommon": [ + "enabled", + "liability", + "status" ] }, "payment_pages_checkout_session_consent": { @@ -40614,7 +44723,11 @@ ], "title": "PaymentPagesCheckoutSessionConsent", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "promotions", + "terms_of_service" + ] }, "payment_pages_checkout_session_consent_collection": { "description": "", @@ -40656,6 +44769,11 @@ "type": "object", "x-expandableFields": [ "payment_method_reuse_agreement" + ], + "x-stripeMostCommon": [ + "payment_method_reuse_agreement", + "promotions", + "terms_of_service" ] }, "payment_pages_checkout_session_currency_conversion": { @@ -40688,7 +44806,13 @@ ], "title": "PaymentPagesCheckoutSessionCurrencyConversion", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount_subtotal", + "amount_total", + "fx_rate", + "source_currency" + ] }, "payment_pages_checkout_session_custom_fields": { "description": "", @@ -40737,6 +44861,15 @@ "label", "numeric", "text" + ], + "x-stripeMostCommon": [ + "dropdown", + "key", + "label", + "numeric", + "optional", + "text", + "type" ] }, "payment_pages_checkout_session_custom_fields_dropdown": { @@ -40772,6 +44905,11 @@ "x-expandableFields": [ "options" ], + "x-stripeMostCommon": [ + "default_value", + "options", + "value" + ], "x-stripeResource": { "class_name": "CustomFieldDropdown", "in_package": "" @@ -40800,7 +44938,11 @@ ], "title": "PaymentPagesCheckoutSessionCustomFieldsLabel", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "custom", + "type" + ] }, "payment_pages_checkout_session_custom_fields_numeric": { "description": "", @@ -40837,6 +44979,12 @@ "title": "PaymentPagesCheckoutSessionCustomFieldsNumeric", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length", + "value" + ], "x-stripeResource": { "class_name": "CustomFieldNumeric", "in_package": "" @@ -40863,6 +45011,10 @@ "title": "PaymentPagesCheckoutSessionCustomFieldsOption", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "label", + "value" + ], "x-stripeResource": { "class_name": "CustomFieldDropdownOption", "in_package": "" @@ -40902,7 +45054,13 @@ ], "title": "PaymentPagesCheckoutSessionCustomFieldsText", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length", + "value" + ] }, "payment_pages_checkout_session_custom_text": { "description": "", @@ -40957,6 +45115,12 @@ "shipping_address", "submit", "terms_of_service_acceptance" + ], + "x-stripeMostCommon": [ + "after_submit", + "shipping_address", + "submit", + "terms_of_service_acceptance" ] }, "payment_pages_checkout_session_custom_text_position": { @@ -40973,7 +45137,10 @@ ], "title": "PaymentPagesCheckoutSessionCustomTextPosition", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "message" + ] }, "payment_pages_checkout_session_customer_details": { "description": "", @@ -41037,6 +45204,14 @@ "x-expandableFields": [ "address", "tax_ids" + ], + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone", + "tax_exempt", + "tax_ids" ] }, "payment_pages_checkout_session_invoice_creation": { @@ -41058,6 +45233,10 @@ "type": "object", "x-expandableFields": [ "invoice_data" + ], + "x-stripeMostCommon": [ + "enabled", + "invoice_data" ] }, "payment_pages_checkout_session_invoice_settings": { @@ -41156,6 +45335,15 @@ "custom_fields", "issuer", "rendering_options" + ], + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "metadata", + "rendering_options" ] }, "payment_pages_checkout_session_payment_method_reuse_agreement": { @@ -41175,7 +45363,10 @@ ], "title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "position" + ] }, "payment_pages_checkout_session_phone_number_collection": { "description": "", @@ -41190,7 +45381,10 @@ ], "title": "PaymentPagesCheckoutSessionPhoneNumberCollection", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_pages_checkout_session_saved_payment_method_options": { "description": "", @@ -41234,7 +45428,12 @@ ], "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allow_redisplay_filters", + "payment_method_remove", + "payment_method_save" + ] }, "payment_pages_checkout_session_shipping_address_collection": { "description": "", @@ -41492,6 +45691,9 @@ "title": "PaymentPagesCheckoutSessionShippingAddressCollection", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "allowed_countries" + ], "x-stripeResource": { "class_name": "ShippingAddressCollection", "in_package": "" @@ -41551,6 +45753,13 @@ "x-expandableFields": [ "shipping_rate", "taxes" + ], + "x-stripeMostCommon": [ + "amount_subtotal", + "amount_tax", + "amount_total", + "shipping_rate", + "taxes" ] }, "payment_pages_checkout_session_shipping_option": { @@ -41588,6 +45797,10 @@ "type": "object", "x-expandableFields": [ "shipping_rate" + ], + "x-stripeMostCommon": [ + "shipping_amount", + "shipping_rate" ] }, "payment_pages_checkout_session_tax_id": { @@ -41687,7 +45900,11 @@ ], "title": "PaymentPagesCheckoutSessionTaxID", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type", + "value" + ] }, "payment_pages_checkout_session_tax_id_collection": { "description": "", @@ -41702,7 +45919,10 @@ ], "title": "PaymentPagesCheckoutSessionTaxIDCollection", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_pages_checkout_session_total_details": { "description": "", @@ -41733,6 +45953,12 @@ "type": "object", "x-expandableFields": [ "breakdown" + ], + "x-stripeMostCommon": [ + "amount_discount", + "amount_shipping", + "amount_tax", + "breakdown" ] }, "payment_pages_checkout_session_total_details_resource_breakdown": { @@ -41762,6 +45988,10 @@ "x-expandableFields": [ "discounts", "taxes" + ], + "x-stripeMostCommon": [ + "discounts", + "taxes" ] }, "payment_source": { @@ -42108,6 +46338,16 @@ "reversed_by" ], "x-resourceId": "payout", + "x-stripeMostCommon": [ + "amount", + "arrival_date", + "currency", + "description", + "id", + "metadata", + "statement_descriptor", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -42289,7 +46529,11 @@ ], "title": "paypal_seller_protection", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "dispute_categories", + "status" + ] }, "period": { "description": "", @@ -42313,7 +46557,11 @@ ], "title": "Period", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "end", + "start" + ] }, "person": { "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).", @@ -42516,6 +46764,19 @@ "verification" ], "x-resourceId": "person", + "x-stripeMostCommon": [ + "account", + "address", + "dob", + "email", + "first_name", + "id", + "last_name", + "metadata", + "phone", + "relationship", + "requirements" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -42657,7 +46918,12 @@ ], "title": "PersonAdditionalTOSAcceptance", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "person_additional_tos_acceptances": { "description": "", @@ -42679,6 +46945,9 @@ "type": "object", "x-expandableFields": [ "account" + ], + "x-stripeMostCommon": [ + "account" ] }, "person_future_requirements": { @@ -42745,6 +47014,14 @@ "x-expandableFields": [ "alternatives", "errors" + ], + "x-stripeMostCommon": [ + "alternatives", + "currently_due", + "errors", + "eventually_due", + "past_due", + "pending_verification" ] }, "person_relationship": { @@ -42798,7 +47075,16 @@ ], "title": "PersonRelationship", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "director", + "executive", + "legal_guardian", + "owner", + "percent_ownership", + "representative", + "title" + ] }, "person_requirements": { "description": "", @@ -42864,6 +47150,14 @@ "x-expandableFields": [ "alternatives", "errors" + ], + "x-stripeMostCommon": [ + "alternatives", + "currently_due", + "errors", + "eventually_due", + "past_due", + "pending_verification" ] }, "plan": { @@ -43058,6 +47352,16 @@ "transform_usage" ], "x-resourceId": "plan", + "x-stripeMostCommon": [ + "active", + "amount", + "currency", + "id", + "interval", + "metadata", + "nickname", + "product" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -43189,7 +47493,14 @@ ], "title": "PlanTier", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "flat_amount", + "flat_amount_decimal", + "unit_amount", + "unit_amount_decimal", + "up_to" + ] }, "platform_earning_fee_source": { "description": "", @@ -43218,7 +47529,12 @@ ], "title": "PlatformEarningFeeSource", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "charge", + "payout", + "type" + ] }, "portal_business_profile": { "description": "", @@ -43249,7 +47565,12 @@ ], "title": "PortalBusinessProfile", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "headline", + "privacy_policy_url", + "terms_of_service_url" + ] }, "portal_customer_update": { "description": "", @@ -43280,7 +47601,11 @@ ], "title": "PortalCustomerUpdate", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "allowed_updates", + "enabled" + ] }, "portal_features": { "description": "", @@ -43316,6 +47641,13 @@ "payment_method_update", "subscription_cancel", "subscription_update" + ], + "x-stripeMostCommon": [ + "customer_update", + "invoice_history", + "payment_method_update", + "subscription_cancel", + "subscription_update" ] }, "portal_flows_after_completion_hosted_confirmation": { @@ -43333,7 +47665,10 @@ ], "title": "PortalFlowsAfterCompletionHostedConfirmation", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "custom_message" + ] }, "portal_flows_after_completion_redirect": { "description": "", @@ -43349,7 +47684,10 @@ ], "title": "PortalFlowsAfterCompletionRedirect", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "return_url" + ] }, "portal_flows_coupon_offer": { "description": "", @@ -43365,7 +47703,10 @@ ], "title": "PortalFlowsCouponOffer", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "coupon" + ] }, "portal_flows_flow": { "description": "", @@ -43425,6 +47766,13 @@ "subscription_cancel", "subscription_update", "subscription_update_confirm" + ], + "x-stripeMostCommon": [ + "after_completion", + "subscription_cancel", + "subscription_update", + "subscription_update_confirm", + "type" ] }, "portal_flows_flow_after_completion": { @@ -43468,6 +47816,11 @@ "x-expandableFields": [ "hosted_confirmation", "redirect" + ], + "x-stripeMostCommon": [ + "hosted_confirmation", + "redirect", + "type" ] }, "portal_flows_flow_subscription_cancel": { @@ -43496,6 +47849,10 @@ "type": "object", "x-expandableFields": [ "retention" + ], + "x-stripeMostCommon": [ + "retention", + "subscription" ] }, "portal_flows_flow_subscription_update": { @@ -43512,7 +47869,10 @@ ], "title": "PortalFlowsFlowSubscriptionUpdate", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "subscription" + ] }, "portal_flows_flow_subscription_update_confirm": { "description": "", @@ -43548,6 +47908,11 @@ "x-expandableFields": [ "discounts", "items" + ], + "x-stripeMostCommon": [ + "discounts", + "items", + "subscription" ] }, "portal_flows_retention": { @@ -43578,6 +47943,10 @@ "type": "object", "x-expandableFields": [ "coupon_offer" + ], + "x-stripeMostCommon": [ + "coupon_offer", + "type" ] }, "portal_flows_subscription_update_confirm_discount": { @@ -43602,7 +47971,11 @@ ], "title": "PortalFlowsSubscriptionUpdateConfirmDiscount", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "coupon", + "promotion_code" + ] }, "portal_flows_subscription_update_confirm_item": { "description": "", @@ -43630,7 +48003,12 @@ ], "title": "PortalFlowsSubscriptionUpdateConfirmItem", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "price", + "quantity" + ] }, "portal_invoice_list": { "description": "", @@ -43645,7 +48023,10 @@ ], "title": "PortalInvoiceList", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "portal_login_page": { "description": "", @@ -43667,7 +48048,11 @@ ], "title": "PortalLoginPage", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled", + "url" + ] }, "portal_payment_method_update": { "description": "", @@ -43682,7 +48067,10 @@ ], "title": "PortalPaymentMethodUpdate", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "portal_subscription_cancel": { "description": "", @@ -43722,6 +48110,12 @@ "type": "object", "x-expandableFields": [ "cancellation_reason" + ], + "x-stripeMostCommon": [ + "cancellation_reason", + "enabled", + "mode", + "proration_behavior" ] }, "portal_subscription_cancellation_reason": { @@ -43755,7 +48149,11 @@ ], "title": "PortalSubscriptionCancellationReason", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled", + "options" + ] }, "portal_subscription_update": { "description": "", @@ -43803,6 +48201,12 @@ "type": "object", "x-expandableFields": [ "products" + ], + "x-stripeMostCommon": [ + "default_allowed_updates", + "enabled", + "products", + "proration_behavior" ] }, "portal_subscription_update_product": { @@ -43828,7 +48232,11 @@ ], "title": "PortalSubscriptionUpdateProduct", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "prices", + "product" + ] }, "price": { "description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).", @@ -44027,6 +48435,17 @@ "transform_quantity" ], "x-resourceId": "price", + "x-stripeMostCommon": [ + "active", + "currency", + "id", + "metadata", + "nickname", + "product", + "recurring", + "type", + "unit_amount" + ], "x-stripeOperations": [ { "method_name": "list", @@ -44159,7 +48578,14 @@ ], "title": "PriceTier", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "flat_amount", + "flat_amount_decimal", + "unit_amount", + "unit_amount_decimal", + "up_to" + ] }, "product": { "description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://stripe.com/docs/payment-links),\n[accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://stripe.com/docs/products-prices/overview)", @@ -44336,6 +48762,14 @@ "tax_code" ], "x-resourceId": "product", + "x-stripeMostCommon": [ + "active", + "default_price", + "description", + "id", + "metadata", + "name" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -44470,6 +48904,10 @@ "entitlement_feature" ], "x-resourceId": "product_feature", + "x-stripeMostCommon": [ + "entitlement_feature", + "id" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -44517,7 +48955,10 @@ }, "title": "ProductMarketingFeature", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "name" + ] }, "promotion_code": { "description": "A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to\ncreate multiple codes for a single coupon.", @@ -44632,6 +49073,12 @@ "restrictions" ], "x-resourceId": "promotion_code", + "x-stripeMostCommon": [ + "code", + "coupon", + "id", + "metadata" + ], "x-stripeOperations": [ { "method_name": "list", @@ -44713,7 +49160,10 @@ ], "title": "PromotionCodeCurrencyOption", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "minimum_amount" + ] }, "promotion_codes_resource_restrictions": { "description": "", @@ -44750,6 +49200,12 @@ "type": "object", "x-expandableFields": [ "currency_options" + ], + "x-stripeMostCommon": [ + "currency_options", + "first_time_transaction", + "minimum_amount", + "minimum_amount_currency" ] }, "quote": { @@ -44997,6 +49453,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -45192,6 +49654,11 @@ "transfer_data" ], "x-resourceId": "quote", + "x-stripeMostCommon": [ + "id", + "line_items", + "metadata" + ], "x-stripeOperations": [ { "method_name": "list", @@ -45370,6 +49837,11 @@ "type": "object", "x-expandableFields": [ "liability" + ], + "x-stripeMostCommon": [ + "enabled", + "liability", + "status" ] }, "quotes_resource_computed": { @@ -45397,6 +49869,10 @@ "x-expandableFields": [ "recurring", "upfront" + ], + "x-stripeMostCommon": [ + "recurring", + "upfront" ] }, "quotes_resource_from_quote": { @@ -45434,6 +49910,10 @@ "type": "object", "x-expandableFields": [ "quote" + ], + "x-stripeMostCommon": [ + "is_revision", + "quote" ] }, "quotes_resource_recurring": { @@ -45476,6 +49956,13 @@ "type": "object", "x-expandableFields": [ "total_details" + ], + "x-stripeMostCommon": [ + "amount_subtotal", + "amount_total", + "interval", + "interval_count", + "total_details" ] }, "quotes_resource_status_transitions": { @@ -45507,7 +49994,12 @@ ], "title": "QuotesResourceStatusTransitions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "accepted_at", + "canceled_at", + "finalized_at" + ] }, "quotes_resource_subscription_data_subscription_data": { "description": "", @@ -45547,7 +50039,13 @@ ], "title": "QuotesResourceSubscriptionDataSubscriptionData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "description", + "effective_date", + "metadata", + "trial_period_days" + ] }, "quotes_resource_total_details": { "description": "", @@ -45578,6 +50076,12 @@ "type": "object", "x-expandableFields": [ "breakdown" + ], + "x-stripeMostCommon": [ + "amount_discount", + "amount_shipping", + "amount_tax", + "breakdown" ] }, "quotes_resource_total_details_resource_breakdown": { @@ -45607,6 +50111,10 @@ "x-expandableFields": [ "discounts", "taxes" + ], + "x-stripeMostCommon": [ + "discounts", + "taxes" ] }, "quotes_resource_transfer_data": { @@ -45651,6 +50159,11 @@ "type": "object", "x-expandableFields": [ "destination" + ], + "x-stripeMostCommon": [ + "amount", + "amount_percent", + "destination" ] }, "quotes_resource_upfront": { @@ -45701,6 +50214,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "total_details": { @@ -45717,6 +50236,12 @@ "x-expandableFields": [ "line_items", "total_details" + ], + "x-stripeMostCommon": [ + "amount_subtotal", + "amount_total", + "line_items", + "total_details" ] }, "radar.early_fraud_warning": { @@ -45807,6 +50332,16 @@ "payment_intent" ], "x-resourceId": "radar.early_fraud_warning", + "x-stripeMostCommon": [ + "actionable", + "charge", + "created", + "fraud_type", + "id", + "livemode", + "object", + "payment_intent" + ], "x-stripeOperations": [ { "method_name": "list", @@ -45937,6 +50472,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -45982,6 +50523,14 @@ "list_items" ], "x-resourceId": "radar.value_list", + "x-stripeMostCommon": [ + "alias", + "id", + "item_type", + "list_items", + "metadata", + "name" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -46078,6 +50627,11 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "radar.value_list_item", + "x-stripeMostCommon": [ + "id", + "value", + "value_list" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -46125,7 +50679,10 @@ }, "title": "RadarRadarOptions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "session" + ] }, "radar_review_resource_location": { "description": "", @@ -46168,7 +50725,14 @@ ], "title": "RadarReviewResourceLocation", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "city", + "country", + "latitude", + "longitude", + "region" + ] }, "radar_review_resource_session": { "description": "", @@ -46206,7 +50770,13 @@ ], "title": "RadarReviewResourceSession", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "browser", + "device", + "platform", + "version" + ] }, "received_payment_method_details_financial_account": { "description": "", @@ -46231,6 +50801,10 @@ "title": "received_payment_method_details_financial_account", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "network" + ], "x-stripeResource": { "class_name": "FinancialAccount", "in_package": "" @@ -46294,7 +50868,10 @@ ], "title": "Recurring", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "interval" + ] }, "refund": { "description": "Refund objects allow you to refund a previously created charge that isn't\nrefunded yet. Funds are refunded to the credit or debit card that's\ninitially charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)", @@ -46527,6 +51104,17 @@ "transfer_reversal" ], "x-resourceId": "refund", + "x-stripeMostCommon": [ + "amount", + "charge", + "currency", + "description", + "id", + "metadata", + "payment_intent", + "reason", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -46761,6 +51349,39 @@ "us_bank_transfer", "wechat_pay", "zip" + ], + "x-stripeMostCommon": [ + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_bank_transfer", + "blik", + "br_bank_transfer", + "card", + "cashapp", + "customer_cash_balance", + "eps", + "eu_bank_transfer", + "gb_bank_transfer", + "giropay", + "grabpay", + "jp_bank_transfer", + "klarna", + "multibanco", + "mx_bank_transfer", + "p24", + "paynow", + "paypal", + "pix", + "revolut", + "sofort", + "swish", + "th_bank_transfer", + "type", + "us_bank_transfer", + "wechat_pay", + "zip" ] }, "refund_destination_details_card": { @@ -46796,7 +51417,13 @@ ], "title": "refund_destination_details_card", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference", + "reference_status", + "reference_type", + "type" + ] }, "refund_destination_details_generic": { "description": "", @@ -46820,7 +51447,11 @@ ], "title": "refund_destination_details_generic", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference", + "reference_status" + ] }, "refund_next_action": { "description": "", @@ -46848,6 +51479,10 @@ "type": "object", "x-expandableFields": [ "display_details" + ], + "x-stripeMostCommon": [ + "display_details", + "type" ] }, "refund_next_action_display_details": { @@ -46870,6 +51505,10 @@ "type": "object", "x-expandableFields": [ "email_sent" + ], + "x-stripeMostCommon": [ + "email_sent", + "expires_at" ] }, "reporting.report_run": { @@ -46950,6 +51589,13 @@ "result" ], "x-resourceId": "reporting.report_run", + "x-stripeMostCommon": [ + "id", + "parameters", + "report_type", + "result", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -47079,6 +51725,12 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "reporting.report_type", + "x-stripeMostCommon": [ + "data_available_end", + "data_available_start", + "id", + "name" + ], "x-stripeOperations": [ { "method_name": "list", @@ -47156,6 +51808,13 @@ "title": "ReserveTransaction", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "id", + "object" + ], "x-stripeResource": { "class_name": "ReserveTransaction", "in_package": "", @@ -47311,6 +51970,13 @@ "session" ], "x-resourceId": "review", + "x-stripeMostCommon": [ + "charge", + "id", + "open", + "payment_intent", + "reason" + ], "x-stripeOperations": [ { "method_name": "list", @@ -47399,6 +52065,11 @@ "title": "RadarRule", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "action", + "id", + "predicate" + ], "x-stripeResource": { "class_name": "Rule", "in_package": "Radar" @@ -47485,6 +52156,14 @@ "file" ], "x-resourceId": "scheduled_query_run", + "x-stripeMostCommon": [ + "data_load_time", + "file", + "id", + "sql", + "status", + "title" + ], "x-stripeOperations": [ { "method_name": "list", @@ -47532,6 +52211,10 @@ "type": "object", "x-expandableFields": [ "liability" + ], + "x-stripeMostCommon": [ + "enabled", + "liability" ] }, "secret_service_resource_scope": { @@ -47556,7 +52239,11 @@ ], "title": "SecretServiceResourceScope", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type", + "user" + ] }, "sepa_debit_generated_from": { "description": "", @@ -47611,6 +52298,10 @@ "x-expandableFields": [ "charge", "setup_attempt" + ], + "x-stripeMostCommon": [ + "charge", + "setup_attempt" ] }, "setup_attempt": { @@ -47808,6 +52499,23 @@ "setup_intent" ], "x-resourceId": "setup_attempt", + "x-stripeMostCommon": [ + "application", + "attach_to_self", + "created", + "customer", + "flow_directions", + "id", + "livemode", + "object", + "on_behalf_of", + "payment_method", + "payment_method_details", + "setup_error", + "setup_intent", + "status", + "usage" + ], "x-stripeOperations": [ { "method_name": "list", @@ -47906,6 +52614,26 @@ "sepa_debit", "sofort", "us_bank_account" + ], + "x-stripeMostCommon": [ + "acss_debit", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "boleto", + "card", + "card_present", + "cashapp", + "ideal", + "klarna", + "link", + "paypal", + "revolut_pay", + "sepa_debit", + "sofort", + "type", + "us_bank_account" ] }, "setup_attempt_payment_method_details_acss_debit": { @@ -48041,6 +52769,16 @@ "generated_sepa_debit", "generated_sepa_debit_mandate" ], + "x-stripeMostCommon": [ + "bank_code", + "bank_name", + "bic", + "generated_sepa_debit", + "generated_sepa_debit_mandate", + "iban_last4", + "preferred_language", + "verified_name" + ], "x-stripeResource": { "class_name": "Bancontact", "in_package": "" @@ -48166,6 +52904,22 @@ "checks", "three_d_secure", "wallet" + ], + "x-stripeMostCommon": [ + "brand", + "checks", + "country", + "description", + "exp_month", + "exp_year", + "fingerprint", + "funding", + "iin", + "issuer", + "last4", + "network", + "three_d_secure", + "wallet" ] }, "setup_attempt_payment_method_details_card_checks": { @@ -48197,7 +52951,12 @@ ], "title": "setup_attempt_payment_method_details_card_checks", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "address_line1_check", + "address_postal_code_check", + "cvc_check" + ] }, "setup_attempt_payment_method_details_card_present": { "description": "", @@ -48242,6 +53001,10 @@ "generated_card", "offline" ], + "x-stripeMostCommon": [ + "generated_card", + "offline" + ], "x-stripeResource": { "class_name": "CardPresent", "in_package": "" @@ -48274,6 +53037,11 @@ "x-expandableFields": [ "apple_pay", "google_pay" + ], + "x-stripeMostCommon": [ + "apple_pay", + "google_pay", + "type" ] }, "setup_attempt_payment_method_details_cashapp": { @@ -48399,6 +53167,14 @@ "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" + ], + "x-stripeMostCommon": [ + "bank", + "bic", + "generated_sepa_debit", + "generated_sepa_debit_mandate", + "iban_last4", + "verified_name" ] }, "setup_attempt_payment_method_details_klarna": { @@ -48540,6 +53316,16 @@ "x-expandableFields": [ "generated_sepa_debit", "generated_sepa_debit_mandate" + ], + "x-stripeMostCommon": [ + "bank_code", + "bank_name", + "bic", + "generated_sepa_debit", + "generated_sepa_debit_mandate", + "iban_last4", + "preferred_language", + "verified_name" ] }, "setup_attempt_payment_method_details_us_bank_account": { @@ -48884,6 +53670,19 @@ "single_use_mandate" ], "x-resourceId": "setup_intent", + "x-stripeMostCommon": [ + "automatic_payment_methods", + "client_secret", + "customer", + "description", + "id", + "last_setup_error", + "metadata", + "next_action", + "payment_method", + "status", + "usage" + ], "x-stripeOperations": [ { "method_name": "list", @@ -49052,6 +53851,13 @@ "cashapp_handle_redirect_or_display_qr_code", "redirect_to_url", "verify_with_microdeposits" + ], + "x-stripeMostCommon": [ + "cashapp_handle_redirect_or_display_qr_code", + "redirect_to_url", + "type", + "use_stripe_sdk", + "verify_with_microdeposits" ] }, "setup_intent_next_action_redirect_to_url": { @@ -49077,6 +53883,10 @@ "title": "SetupIntentNextActionRedirectToUrl", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "return_url", + "url" + ], "x-stripeResource": { "class_name": "NextActionRedirectToUrl", "in_package": "" @@ -49112,7 +53922,12 @@ ], "title": "SetupIntentNextActionVerifyWithMicrodeposits", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "arrival_date", + "hosted_verification_url", + "microdeposit_type" + ] }, "setup_intent_payment_method_options": { "description": "", @@ -49157,6 +53972,17 @@ "paypal", "sepa_debit", "us_bank_account" + ], + "x-stripeMostCommon": [ + "acss_debit", + "amazon_pay", + "bacs_debit", + "card", + "card_present", + "link", + "paypal", + "sepa_debit", + "us_bank_account" ] }, "setup_intent_payment_method_options_acss_debit": { @@ -49192,6 +54018,11 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "verification_method" ] }, "setup_intent_payment_method_options_amazon_pay": { @@ -49212,6 +54043,9 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options" ] }, "setup_intent_payment_method_options_card": { @@ -49266,6 +54100,11 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options", + "network", + "request_three_d_secure" ] }, "setup_intent_payment_method_options_card_mandate_options": { @@ -49352,6 +54191,18 @@ "title": "setup_intent_payment_method_options_card_mandate_options", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "amount_type", + "currency", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ], "x-stripeResource": { "class_name": "MandateOptions", "in_package": "" @@ -49379,7 +54230,10 @@ ], "title": "setup_intent_payment_method_options_link", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "persistent_token" + ] }, "setup_intent_payment_method_options_mandate_options_acss_debit": { "description": "", @@ -49433,7 +54287,14 @@ ], "title": "setup_intent_payment_method_options_mandate_options_acss_debit", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", @@ -49472,7 +54333,10 @@ ], "title": "setup_intent_payment_method_options_paypal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "billing_agreement_id" + ] }, "setup_intent_payment_method_options_sepa_debit": { "description": "", @@ -49485,6 +54349,9 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options" ] }, "setup_intent_payment_method_options_us_bank_account": { @@ -49512,6 +54379,11 @@ "x-expandableFields": [ "financial_connections", "mandate_options" + ], + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "verification_method" ] }, "setup_intent_type_specific_payment_method_options_client": { @@ -49530,7 +54402,10 @@ }, "title": "SetupIntentTypeSpecificPaymentMethodOptionsClient", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "verification_method" + ] }, "shipping": { "description": "", @@ -49567,6 +54442,13 @@ "x-expandableFields": [ "address" ], + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ], "x-stripeResource": { "class_name": "ShippingDetails", "in_package": "" @@ -49685,6 +54567,14 @@ "tax_code" ], "x-resourceId": "shipping_rate", + "x-stripeMostCommon": [ + "active", + "display_name", + "fixed_amount", + "id", + "metadata", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -49744,7 +54634,11 @@ ], "title": "ShippingRateCurrencyOption", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "shipping_rate_delivery_estimate": { "description": "", @@ -49777,6 +54671,10 @@ "x-expandableFields": [ "maximum", "minimum" + ], + "x-stripeMostCommon": [ + "maximum", + "minimum" ] }, "shipping_rate_delivery_estimate_bound": { @@ -49804,7 +54702,11 @@ ], "title": "ShippingRateDeliveryEstimateBound", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "shipping_rate_fixed_amount": { "description": "", @@ -49833,6 +54735,11 @@ "type": "object", "x-expandableFields": [ "currency_options" + ], + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" ] }, "sigma.scheduled_query_run.created": { @@ -49865,7 +54772,10 @@ ], "title": "SigmaScheduledQueryRunError", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "message" + ] }, "source": { "description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).", @@ -50073,6 +54983,18 @@ "source_order" ], "x-resourceId": "source", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "id", + "metadata", + "owner", + "redirect", + "statement_descriptor", + "status", + "type" + ], "x-stripeOperations": [ { "method_name": "detach", @@ -50257,7 +55179,11 @@ ], "title": "SourceCodeVerificationFlow", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "attempts_remaining", + "status" + ] }, "source_mandate_notification": { "description": "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.", @@ -50335,6 +55261,20 @@ "sepa_debit", "source" ], + "x-stripeMostCommon": [ + "acss_debit", + "amount", + "bacs_debit", + "created", + "id", + "livemode", + "object", + "reason", + "sepa_debit", + "source", + "status", + "type" + ], "x-stripeResource": { "class_name": "SourceMandateNotification", "in_package": "" @@ -50351,7 +55291,10 @@ }, "title": "SourceMandateNotificationAcssDebitData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "statement_descriptor" + ] }, "source_mandate_notification_bacs_debit_data": { "description": "", @@ -50364,7 +55307,10 @@ }, "title": "SourceMandateNotificationBacsDebitData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "last4" + ] }, "source_mandate_notification_sepa_debit_data": { "description": "", @@ -50387,7 +55333,12 @@ }, "title": "SourceMandateNotificationSepaDebitData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "creditor_identifier", + "last4", + "mandate_reference" + ] }, "source_order": { "description": "", @@ -50427,6 +55378,13 @@ "x-expandableFields": [ "items", "shipping" + ], + "x-stripeMostCommon": [ + "amount", + "currency", + "email", + "items", + "shipping" ] }, "source_order_item": { @@ -50475,7 +55433,15 @@ ], "title": "SourceOrderItem", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "parent", + "quantity", + "type" + ] }, "source_owner": { "description": "", @@ -50550,6 +55516,16 @@ "x-expandableFields": [ "address", "verified_address" + ], + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone", + "verified_address", + "verified_email", + "verified_name", + "verified_phone" ] }, "source_receiver_flow": { @@ -50594,7 +55570,15 @@ ], "title": "SourceReceiverFlow", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "address", + "amount_charged", + "amount_received", + "amount_returned", + "refund_attributes_method", + "refund_attributes_status" + ] }, "source_redirect_flow": { "description": "", @@ -50629,7 +55613,13 @@ ], "title": "SourceRedirectFlow", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "failure_reason", + "return_url", + "status", + "url" + ] }, "source_transaction": { "description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.", @@ -50732,6 +55722,22 @@ "sepa_credit_transfer" ], "x-resourceId": "source_transaction", + "x-stripeMostCommon": [ + "ach_credit_transfer", + "amount", + "chf_credit_transfer", + "created", + "currency", + "gbp_credit_transfer", + "id", + "livemode", + "object", + "paper_check", + "sepa_credit_transfer", + "source", + "status", + "type" + ], "x-stripeResource": { "class_name": "SourceTransaction", "has_collection_class": true, @@ -50764,7 +55770,13 @@ }, "title": "SourceTransactionAchCreditTransferData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "customer_data", + "fingerprint", + "last4", + "routing_number" + ] }, "source_transaction_chf_credit_transfer_data": { "description": "", @@ -50797,7 +55809,14 @@ }, "title": "SourceTransactionChfCreditTransferData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference", + "sender_address_country", + "sender_address_line1", + "sender_iban", + "sender_name" + ] }, "source_transaction_gbp_credit_transfer_data": { "description": "", @@ -50840,7 +55859,16 @@ }, "title": "SourceTransactionGbpCreditTransferData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "fingerprint", + "funding_method", + "last4", + "reference", + "sender_account_number", + "sender_name", + "sender_sort_code" + ] }, "source_transaction_paper_check_data": { "description": "", @@ -50858,7 +55886,11 @@ }, "title": "SourceTransactionPaperCheckData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "available_at", + "invoices" + ] }, "source_transaction_sepa_credit_transfer_data": { "description": "", @@ -50881,7 +55913,12 @@ }, "title": "SourceTransactionSepaCreditTransferData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference", + "sender_iban", + "sender_name" + ] }, "source_type_ach_credit_transfer": { "properties": { @@ -51959,6 +56996,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "latest_invoice": { @@ -52248,6 +57291,22 @@ "trial_settings" ], "x-resourceId": "subscription", + "x-stripeMostCommon": [ + "cancel_at_period_end", + "currency", + "current_period_end", + "current_period_start", + "customer", + "default_payment_method", + "description", + "id", + "items", + "latest_invoice", + "metadata", + "pending_setup_intent", + "pending_update", + "status" + ], "x-stripeOperations": [ { "method_name": "cancel", @@ -52338,6 +57397,10 @@ "type": "object", "x-expandableFields": [ "liability" + ], + "x-stripeMostCommon": [ + "enabled", + "liability" ] }, "subscription_billing_thresholds": { @@ -52360,7 +57423,11 @@ ], "title": "SubscriptionBillingThresholds", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, "subscription_details_data": { "description": "", @@ -52380,7 +57447,10 @@ ], "title": "SubscriptionDetailsData", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "metadata" + ] }, "subscription_item": { "description": "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.", @@ -52486,6 +57556,13 @@ "tax_rates" ], "x-resourceId": "subscription_item", + "x-stripeMostCommon": [ + "id", + "metadata", + "price", + "quantity", + "subscription" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -52550,7 +57627,10 @@ ], "title": "SubscriptionItemBillingThresholds", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "usage_gte" + ] }, "subscription_payment_method_options_card": { "description": "", @@ -52596,6 +57676,11 @@ "type": "object", "x-expandableFields": [ "mandate_options" + ], + "x-stripeMostCommon": [ + "mandate_options", + "network", + "request_three_d_secure" ] }, "subscription_pending_invoice_item_interval": { @@ -52622,7 +57707,11 @@ ], "title": "SubscriptionPendingInvoiceItemInterval", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "interval", + "interval_count" + ] }, "subscription_schedule": { "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)", @@ -52845,6 +57934,15 @@ "test_clock" ], "x-resourceId": "subscription_schedule", + "x-stripeMostCommon": [ + "current_phase", + "customer", + "id", + "metadata", + "phases", + "status", + "subscription" + ], "x-stripeOperations": [ { "method_name": "list", @@ -53067,6 +58165,12 @@ "discounts", "price", "tax_rates" + ], + "x-stripeMostCommon": [ + "discounts", + "price", + "quantity", + "tax_rates" ] }, "subscription_schedule_configuration_item": { @@ -53175,6 +58279,15 @@ "plan", "price", "tax_rates" + ], + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" ] }, "subscription_schedule_current_phase": { @@ -53197,7 +58310,11 @@ ], "title": "SubscriptionScheduleCurrentPhase", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "end_date", + "start_date" + ] }, "subscription_schedule_phase_configuration": { "description": "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.", @@ -53430,6 +58547,29 @@ "items", "on_behalf_of", "transfer_data" + ], + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "metadata", + "on_behalf_of", + "proration_behavior", + "start_date", + "transfer_data", + "trial_end" ] }, "subscription_schedules_resource_default_settings": { @@ -53548,6 +58688,18 @@ "invoice_settings", "on_behalf_of", "transfer_data" + ], + "x-stripeMostCommon": [ + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "default_payment_method", + "description", + "invoice_settings", + "on_behalf_of", + "transfer_data" ] }, "subscription_schedules_resource_default_settings_automatic_tax": { @@ -53575,6 +58727,10 @@ "type": "object", "x-expandableFields": [ "liability" + ], + "x-stripeMostCommon": [ + "enabled", + "liability" ] }, "subscription_transfer_data": { @@ -53613,6 +58769,10 @@ "type": "object", "x-expandableFields": [ "destination" + ], + "x-stripeMostCommon": [ + "amount_percent", + "destination" ] }, "subscriptions_resource_billing_cycle_anchor_config": { @@ -53652,7 +58812,14 @@ ], "title": "SubscriptionsResourceBillingCycleAnchorConfig", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "day_of_month", + "hour", + "minute", + "month", + "second" + ] }, "subscriptions_resource_pause_collection": { "description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.", @@ -53679,7 +58846,11 @@ ], "title": "SubscriptionsResourcePauseCollection", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "behavior", + "resumes_at" + ] }, "subscriptions_resource_payment_method_options": { "description": "", @@ -53767,6 +58938,15 @@ "konbini", "sepa_debit", "us_bank_account" + ], + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "konbini", + "sepa_debit", + "us_bank_account" ] }, "subscriptions_resource_payment_settings": { @@ -53841,6 +59021,11 @@ "type": "object", "x-expandableFields": [ "payment_method_options" + ], + "x-stripeMostCommon": [ + "payment_method_options", + "payment_method_types", + "save_default_payment_method" ] }, "subscriptions_resource_pending_update": { @@ -53888,6 +59073,13 @@ "type": "object", "x-expandableFields": [ "subscription_items" + ], + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "expires_at", + "subscription_items", + "trial_end", + "trial_from_plan" ] }, "subscriptions_resource_subscription_invoice_settings": { @@ -53935,6 +59127,10 @@ "x-expandableFields": [ "account_tax_ids", "issuer" + ], + "x-stripeMostCommon": [ + "account_tax_ids", + "issuer" ] }, "subscriptions_trials_resource_end_behavior": { @@ -53955,7 +59151,10 @@ ], "title": "SubscriptionsTrialsResourceEndBehavior", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "missing_payment_method" + ] }, "subscriptions_trials_resource_trial_settings": { "description": "Configures how this subscription behaves during the trial period.", @@ -53971,6 +59170,9 @@ "type": "object", "x-expandableFields": [ "end_behavior" + ], + "x-stripeMostCommon": [ + "end_behavior" ] }, "tax.calculation": { @@ -54045,6 +59247,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -54123,6 +59331,19 @@ "tax_breakdown" ], "x-resourceId": "tax.calculation", + "x-stripeMostCommon": [ + "amount_total", + "currency", + "customer_details", + "expires_at", + "id", + "line_items", + "object", + "shipping_cost", + "tax_amount_exclusive", + "tax_amount_inclusive", + "tax_breakdown" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -54234,6 +59455,19 @@ "tax_breakdown" ], "x-resourceId": "tax.calculation_line_item", + "x-stripeMostCommon": [ + "amount", + "amount_tax", + "id", + "livemode", + "object", + "product", + "quantity", + "reference", + "tax_behavior", + "tax_breakdown", + "tax_code" + ], "x-stripeResource": { "class_name": "CalculationLineItem", "has_collection_class": true, @@ -54310,6 +59544,17 @@ "country_options" ], "x-resourceId": "tax.registration", + "x-stripeMostCommon": [ + "active_from", + "country", + "country_options", + "created", + "expires_at", + "id", + "livemode", + "object", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -54400,6 +59645,14 @@ "status_details" ], "x-resourceId": "tax.settings", + "x-stripeMostCommon": [ + "defaults", + "head_office", + "livemode", + "object", + "status", + "status_details" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -54503,6 +59756,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "livemode": { @@ -54603,6 +59862,16 @@ "shipping_cost" ], "x-resourceId": "tax.transaction", + "x-stripeMostCommon": [ + "currency", + "customer_details", + "id", + "line_items", + "metadata", + "object", + "reference", + "type" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -54741,6 +60010,21 @@ "reversal" ], "x-resourceId": "tax.transaction_line_item", + "x-stripeMostCommon": [ + "amount", + "amount_tax", + "id", + "livemode", + "metadata", + "object", + "product", + "quantity", + "reference", + "reversal", + "tax_behavior", + "tax_code", + "type" + ], "x-stripeResource": { "class_name": "TransactionLineItem", "has_collection_class": true, @@ -54783,6 +60067,12 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "tax_code", + "x-stripeMostCommon": [ + "description", + "id", + "name", + "object" + ], "x-stripeOperations": [ { "method_name": "list", @@ -54846,6 +60136,13 @@ "title": "TaxDeductedAtSource", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "id", + "object", + "period_end", + "period_start", + "tax_deduction_account_number" + ], "x-stripeResource": { "class_name": "TaxDeductedAtSource", "in_package": "", @@ -54934,6 +60231,12 @@ "account", "application", "customer" + ], + "x-stripeMostCommon": [ + "account", + "application", + "customer", + "type" ] }, "tax_id": { @@ -55111,6 +60414,13 @@ "verification" ], "x-resourceId": "tax_id", + "x-stripeMostCommon": [ + "country", + "customer", + "id", + "type", + "value" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -55231,7 +60541,12 @@ ], "title": "tax_id_verification", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "status", + "verified_address", + "verified_name" + ] }, "tax_product_registrations_resource_country_options": { "description": "", @@ -55464,6 +60779,64 @@ "us", "vn", "za" + ], + "x-stripeMostCommon": [ + "ae", + "at", + "au", + "be", + "bg", + "bh", + "ca", + "ch", + "cl", + "co", + "cy", + "cz", + "de", + "dk", + "ee", + "eg", + "es", + "fi", + "fr", + "gb", + "ge", + "gr", + "hr", + "hu", + "id", + "ie", + "is", + "it", + "jp", + "ke", + "kr", + "kz", + "lt", + "lu", + "lv", + "mt", + "mx", + "my", + "ng", + "nl", + "no", + "nz", + "om", + "pl", + "pt", + "ro", + "sa", + "se", + "sg", + "si", + "sk", + "th", + "tr", + "us", + "vn", + "za" ] }, "tax_product_registrations_resource_country_options_ca_province_standard": { @@ -55480,7 +60853,10 @@ ], "title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "province" + ] }, "tax_product_registrations_resource_country_options_canada": { "description": "", @@ -55505,6 +60881,10 @@ "type": "object", "x-expandableFields": [ "province_standard" + ], + "x-stripeMostCommon": [ + "province_standard", + "type" ] }, "tax_product_registrations_resource_country_options_default": { @@ -55523,7 +60903,10 @@ ], "title": "TaxProductRegistrationsResourceCountryOptionsDefault", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type" + ] }, "tax_product_registrations_resource_country_options_eu_standard": { "description": "", @@ -55542,7 +60925,10 @@ ], "title": "TaxProductRegistrationsResourceCountryOptionsEuStandard", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "tax_product_registrations_resource_country_options_europe": { "description": "", @@ -55568,6 +60954,10 @@ "type": "object", "x-expandableFields": [ "standard" + ], + "x-stripeMostCommon": [ + "standard", + "type" ] }, "tax_product_registrations_resource_country_options_simplified": { @@ -55586,7 +60976,10 @@ ], "title": "TaxProductRegistrationsResourceCountryOptionsSimplified", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type" + ] }, "tax_product_registrations_resource_country_options_united_states": { "description": "", @@ -55623,6 +61016,12 @@ "x-expandableFields": [ "local_amusement_tax", "local_lease_tax" + ], + "x-stripeMostCommon": [ + "local_amusement_tax", + "local_lease_tax", + "state", + "type" ] }, "tax_product_registrations_resource_country_options_us_local_amusement_tax": { @@ -55639,7 +61038,10 @@ ], "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "jurisdiction" + ] }, "tax_product_registrations_resource_country_options_us_local_lease_tax": { "description": "", @@ -55655,7 +61057,10 @@ ], "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "jurisdiction" + ] }, "tax_product_resource_customer_details": { "description": "", @@ -55713,6 +61118,13 @@ "x-expandableFields": [ "address", "tax_ids" + ], + "x-stripeMostCommon": [ + "address", + "address_source", + "ip_address", + "tax_ids", + "taxability_override" ] }, "tax_product_resource_customer_details_resource_tax_id": { @@ -55811,7 +61223,11 @@ ], "title": "TaxProductResourceCustomerDetailsResourceTaxId", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "type", + "value" + ] }, "tax_product_resource_jurisdiction": { "description": "", @@ -55852,7 +61268,13 @@ ], "title": "TaxProductResourceJurisdiction", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "country", + "display_name", + "level", + "state" + ] }, "tax_product_resource_line_item_tax_breakdown": { "description": "", @@ -55920,6 +61342,14 @@ "x-expandableFields": [ "jurisdiction", "tax_rate_details" + ], + "x-stripeMostCommon": [ + "amount", + "jurisdiction", + "sourcing", + "tax_rate_details", + "taxability_reason", + "taxable_amount" ] }, "tax_product_resource_line_item_tax_rate_details": { @@ -55962,7 +61392,12 @@ ], "title": "TaxProductResourceLineItemTaxRateDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "display_name", + "percentage_decimal", + "tax_type" + ] }, "tax_product_resource_postal_address": { "description": "", @@ -56013,7 +61448,15 @@ ], "title": "TaxProductResourcePostalAddress", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "tax_product_resource_ship_from_details": { "description": "", @@ -56029,6 +61472,9 @@ "type": "object", "x-expandableFields": [ "address" + ], + "x-stripeMostCommon": [ + "address" ] }, "tax_product_resource_tax_breakdown": { @@ -56082,6 +61528,13 @@ "type": "object", "x-expandableFields": [ "tax_rate_details" + ], + "x-stripeMostCommon": [ + "amount", + "inclusive", + "tax_rate_details", + "taxability_reason", + "taxable_amount" ] }, "tax_product_resource_tax_calculation_shipping_cost": { @@ -56131,6 +61584,14 @@ "type": "object", "x-expandableFields": [ "tax_breakdown" + ], + "x-stripeMostCommon": [ + "amount", + "amount_tax", + "shipping_rate", + "tax_behavior", + "tax_breakdown", + "tax_code" ] }, "tax_product_resource_tax_rate_details": { @@ -56182,7 +61643,13 @@ ], "title": "TaxProductResourceTaxRateDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "country", + "percentage_decimal", + "state", + "tax_type" + ] }, "tax_product_resource_tax_settings_defaults": { "description": "", @@ -56210,7 +61677,11 @@ ], "title": "TaxProductResourceTaxSettingsDefaults", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "tax_behavior", + "tax_code" + ] }, "tax_product_resource_tax_settings_head_office": { "description": "", @@ -56226,6 +61697,9 @@ "type": "object", "x-expandableFields": [ "address" + ], + "x-stripeMostCommon": [ + "address" ] }, "tax_product_resource_tax_settings_status_details": { @@ -56243,6 +61717,10 @@ "x-expandableFields": [ "active", "pending" + ], + "x-stripeMostCommon": [ + "active", + "pending" ] }, "tax_product_resource_tax_settings_status_details_resource_active": { @@ -56270,7 +61748,10 @@ ], "title": "TaxProductResourceTaxSettingsStatusDetailsResourcePending", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "missing_fields" + ] }, "tax_product_resource_tax_transaction_line_item_resource_reversal": { "description": "", @@ -56286,7 +61767,10 @@ ], "title": "TaxProductResourceTaxTransactionLineItemResourceReversal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "original_line_item" + ] }, "tax_product_resource_tax_transaction_resource_reversal": { "description": "", @@ -56303,7 +61787,10 @@ ], "title": "TaxProductResourceTaxTransactionResourceReversal", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "original_transaction" + ] }, "tax_product_resource_tax_transaction_shipping_cost": { "description": "", @@ -56352,6 +61839,14 @@ "type": "object", "x-expandableFields": [ "tax_breakdown" + ], + "x-stripeMostCommon": [ + "amount", + "amount_tax", + "shipping_rate", + "tax_behavior", + "tax_breakdown", + "tax_code" ] }, "tax_rate": { @@ -56489,6 +61984,18 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "tax_rate", + "x-stripeMostCommon": [ + "active", + "country", + "description", + "display_name", + "id", + "inclusive", + "jurisdiction", + "metadata", + "percentage", + "state" + ], "x-stripeOperations": [ { "method_name": "list", @@ -56624,6 +62131,14 @@ "verifone_p400" ], "x-resourceId": "terminal.configuration", + "x-stripeMostCommon": [ + "bbpos_wisepos_e", + "id", + "is_account_default", + "stripe_s700", + "tipping", + "verifone_p400" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -56696,6 +62211,10 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "terminal.connection_token", + "x-stripeMostCommon": [ + "location", + "secret" + ], "x-stripeOperations": [ { "method_name": "create", @@ -56765,6 +62284,12 @@ "address" ], "x-resourceId": "terminal.location", + "x-stripeMostCommon": [ + "address", + "display_name", + "id", + "metadata" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -56931,6 +62456,15 @@ "location" ], "x-resourceId": "terminal.reader", + "x-stripeMostCommon": [ + "device_type", + "id", + "label", + "location", + "metadata", + "serial_number", + "status" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -57074,7 +62608,12 @@ }, "title": "TerminalConfigurationConfigurationResourceCurrencySpecificConfig", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "terminal_configuration_configuration_resource_device_type_specific_config": { "description": "", @@ -57103,6 +62642,9 @@ "type": "object", "x-expandableFields": [ "splashscreen" + ], + "x-stripeMostCommon": [ + "splashscreen" ] }, "terminal_configuration_configuration_resource_offline_config": { @@ -57119,7 +62661,10 @@ ], "title": "TerminalConfigurationConfigurationResourceOfflineConfig", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enabled" + ] }, "terminal_configuration_configuration_resource_reboot_window": { "description": "", @@ -57139,7 +62684,11 @@ ], "title": "TerminalConfigurationConfigurationResourceRebootWindow", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "end_hour", + "start_hour" + ] }, "terminal_configuration_configuration_resource_tipping": { "description": "", @@ -57204,6 +62753,22 @@ "sek", "sgd", "usd" + ], + "x-stripeMostCommon": [ + "aud", + "cad", + "chf", + "czk", + "dkk", + "eur", + "gbp", + "hkd", + "myr", + "nok", + "nzd", + "sek", + "sgd", + "usd" ] }, "terminal_reader_reader_resource_cart": { @@ -57240,6 +62805,12 @@ "type": "object", "x-expandableFields": [ "line_items" + ], + "x-stripeMostCommon": [ + "currency", + "line_items", + "tax", + "total" ] }, "terminal_reader_reader_resource_line_item": { @@ -57266,7 +62837,12 @@ ], "title": "TerminalReaderReaderResourceLineItem", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount", + "description", + "quantity" + ] }, "terminal_reader_reader_resource_process_config": { "description": "Represents a per-transaction override of a reader configuration", @@ -57287,6 +62863,11 @@ "type": "object", "x-expandableFields": [ "tipping" + ], + "x-stripeMostCommon": [ + "enable_customer_cancellation", + "skip_tipping", + "tipping" ] }, "terminal_reader_reader_resource_process_payment_intent_action": { @@ -57323,6 +62904,9 @@ "x-expandableFields": [ "payment_intent", "process_config" + ], + "x-stripeMostCommon": [ + "payment_intent" ] }, "terminal_reader_reader_resource_process_setup_config": { @@ -57335,7 +62919,10 @@ }, "title": "TerminalReaderReaderResourceProcessSetupConfig", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enable_customer_cancellation" + ] }, "terminal_reader_reader_resource_process_setup_intent_action": { "description": "Represents a reader action to process a setup intent", @@ -57376,6 +62963,9 @@ "x-expandableFields": [ "process_config", "setup_intent" + ], + "x-stripeMostCommon": [ + "setup_intent" ] }, "terminal_reader_reader_resource_reader_action": { @@ -57439,6 +63029,16 @@ "process_setup_intent", "refund_payment", "set_reader_display" + ], + "x-stripeMostCommon": [ + "failure_code", + "failure_message", + "process_payment_intent", + "process_setup_intent", + "refund_payment", + "set_reader_display", + "status", + "type" ] }, "terminal_reader_reader_resource_refund_payment_action": { @@ -57541,6 +63141,17 @@ "payment_intent", "refund", "refund_payment_config" + ], + "x-stripeMostCommon": [ + "amount", + "charge", + "metadata", + "payment_intent", + "reason", + "refund", + "refund_application_fee", + "refund_payment_config", + "reverse_transfer" ] }, "terminal_reader_reader_resource_refund_payment_config": { @@ -57553,7 +63164,10 @@ }, "title": "TerminalReaderReaderResourceRefundPaymentConfig", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "enable_customer_cancellation" + ] }, "terminal_reader_reader_resource_set_reader_display_action": { "description": "Represents a reader action to set the reader display", @@ -57583,6 +63197,10 @@ "type": "object", "x-expandableFields": [ "cart" + ], + "x-stripeMostCommon": [ + "cart", + "type" ] }, "terminal_reader_reader_resource_tipping_config": { @@ -57595,7 +63213,10 @@ }, "title": "TerminalReaderReaderResourceTippingConfig", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "amount_eligible" + ] }, "test_helpers.test_clock": { "description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.", @@ -57645,6 +63266,9 @@ "ready" ], "type": "string" + }, + "status_details": { + "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details" } }, "required": [ @@ -57659,8 +63283,21 @@ ], "title": "TestClock", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "status_details" + ], "x-resourceId": "test_helpers.test_clock", + "x-stripeMostCommon": [ + "created", + "deletes_after", + "frozen_time", + "id", + "livemode", + "name", + "object", + "status", + "status_details" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -57864,7 +63501,15 @@ ], "title": "three_d_secure_details", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "authentication_flow", + "electronic_commerce_indicator", + "result", + "result_reason", + "transaction_id", + "version" + ] }, "three_d_secure_details_charge": { "description": "", @@ -57960,7 +63605,17 @@ ], "title": "three_d_secure_details_charge", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "authentication_flow", + "electronic_commerce_indicator", + "exemption_indicator", + "exemption_indicator_applied", + "result", + "result_reason", + "transaction_id", + "version" + ] }, "three_d_secure_usage": { "description": "", @@ -57975,7 +63630,10 @@ ], "title": "three_d_secure_usage", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "supported" + ] }, "thresholds_resource_alert_filter": { "description": "", @@ -58008,6 +63666,9 @@ "type": "object", "x-expandableFields": [ "customer" + ], + "x-stripeMostCommon": [ + "customer" ] }, "thresholds_resource_usage_threshold_config": { @@ -58054,6 +63715,11 @@ "type": "object", "x-expandableFields": [ "meter" + ], + "x-stripeMostCommon": [ + "gte", + "meter", + "recurrence" ] }, "token": { @@ -58118,6 +63784,10 @@ "card" ], "x-resourceId": "token", + "x-stripeMostCommon": [ + "card", + "id" + ], "x-stripeOperations": [ { "method_name": "retrieve", @@ -58154,7 +63824,10 @@ ], "title": "token_card_networks", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "preferred" + ] }, "topup": { "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)", @@ -58298,6 +63971,14 @@ "source" ], "x-resourceId": "topup", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "id", + "metadata", + "status" + ], "x-stripeOperations": [ { "method_name": "list", @@ -58570,6 +64251,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "reversed": { @@ -58586,7 +64273,7 @@ "$ref": "#/components/schemas/charge" } ], - "description": "ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.", + "description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -58635,6 +64322,14 @@ "source_transaction" ], "x-resourceId": "transfer", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "destination", + "id", + "metadata" + ], "x-stripeOperations": [ { "method_name": "list", @@ -58756,6 +64451,10 @@ "type": "object", "x-expandableFields": [ "destination" + ], + "x-stripeMostCommon": [ + "amount", + "destination" ] }, "transfer_reversal": { @@ -58896,6 +64595,13 @@ "transfer" ], "x-resourceId": "transfer_reversal", + "x-stripeMostCommon": [ + "amount", + "currency", + "id", + "metadata", + "transfer" + ], "x-stripeOperations": [ { "method_name": "list", @@ -58984,7 +64690,13 @@ ], "title": "TransferSchedule", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "delay_days", + "interval", + "monthly_anchor", + "weekly_anchor" + ] }, "transform_quantity": { "description": "", @@ -59008,7 +64720,11 @@ ], "title": "TransformQuantity", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "divide_by", + "round" + ] }, "transform_usage": { "description": "", @@ -59032,7 +64748,11 @@ ], "title": "TransformUsage", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "divide_by", + "round" + ] }, "treasury.credit_reversal": { "description": "You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.", @@ -59154,6 +64874,22 @@ "transaction" ], "x-resourceId": "treasury.credit_reversal", + "x-stripeMostCommon": [ + "amount", + "created", + "currency", + "financial_account", + "hosted_regulatory_receipt_url", + "id", + "livemode", + "metadata", + "network", + "object", + "received_credit", + "status", + "status_transitions", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -59347,6 +65083,23 @@ "transaction" ], "x-resourceId": "treasury.debit_reversal", + "x-stripeMostCommon": [ + "amount", + "created", + "currency", + "financial_account", + "hosted_regulatory_receipt_url", + "id", + "linked_flows", + "livemode", + "metadata", + "network", + "object", + "received_debit", + "status", + "status_transitions", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -59590,6 +65343,24 @@ "status_details" ], "x-resourceId": "treasury.financial_account", + "x-stripeMostCommon": [ + "active_features", + "balance", + "country", + "created", + "features", + "financial_addresses", + "id", + "livemode", + "metadata", + "object", + "pending_features", + "platform_restrictions", + "restricted_features", + "status", + "status_details", + "supported_currencies" + ], "x-stripeOperations": [ { "method_name": "list", @@ -59735,6 +65506,16 @@ "outbound_transfers" ], "x-resourceId": "treasury.financial_account_features", + "x-stripeMostCommon": [ + "card_issuing", + "deposit_insurance", + "financial_addresses", + "inbound_transfers", + "intra_stripe_flows", + "object", + "outbound_payments", + "outbound_transfers" + ], "x-stripeResource": { "class_name": "FinancialAccountFeatures", "in_package": "Treasury" @@ -59903,6 +65684,28 @@ "transaction" ], "x-resourceId": "treasury.inbound_transfer", + "x-stripeMostCommon": [ + "amount", + "cancelable", + "created", + "currency", + "description", + "failure_details", + "financial_account", + "hosted_regulatory_receipt_url", + "id", + "linked_flows", + "livemode", + "metadata", + "object", + "origin_payment_method", + "origin_payment_method_details", + "returned", + "statement_descriptor", + "status", + "status_transitions", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -60212,6 +66015,30 @@ "transaction" ], "x-resourceId": "treasury.outbound_payment", + "x-stripeMostCommon": [ + "amount", + "cancelable", + "created", + "currency", + "customer", + "description", + "destination_payment_method", + "destination_payment_method_details", + "end_user_details", + "expected_arrival_date", + "financial_account", + "hosted_regulatory_receipt_url", + "id", + "livemode", + "metadata", + "object", + "returned_details", + "statement_descriptor", + "status", + "status_transitions", + "tracking_details", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -60552,6 +66379,28 @@ "transaction" ], "x-resourceId": "treasury.outbound_transfer", + "x-stripeMostCommon": [ + "amount", + "cancelable", + "created", + "currency", + "description", + "destination_payment_method", + "destination_payment_method_details", + "expected_arrival_date", + "financial_account", + "hosted_regulatory_receipt_url", + "id", + "livemode", + "metadata", + "object", + "returned_details", + "statement_descriptor", + "status", + "status_transitions", + "tracking_details", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -60871,6 +66720,24 @@ "transaction" ], "x-resourceId": "treasury.received_credit", + "x-stripeMostCommon": [ + "amount", + "created", + "currency", + "description", + "failure_code", + "financial_account", + "hosted_regulatory_receipt_url", + "id", + "initiating_payment_method_details", + "linked_flows", + "livemode", + "network", + "object", + "reversal_details", + "status", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -61089,6 +66956,24 @@ "transaction" ], "x-resourceId": "treasury.received_debit", + "x-stripeMostCommon": [ + "amount", + "created", + "currency", + "description", + "failure_code", + "financial_account", + "hosted_regulatory_receipt_url", + "id", + "initiating_payment_method_details", + "linked_flows", + "livemode", + "network", + "object", + "reversal_details", + "status", + "transaction" + ], "x-stripeOperations": [ { "method_name": "list", @@ -61197,6 +67082,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] }, "financial_account": { @@ -61287,6 +67178,23 @@ "status_transitions" ], "x-resourceId": "treasury.transaction", + "x-stripeMostCommon": [ + "amount", + "balance_impact", + "created", + "currency", + "description", + "entries", + "financial_account", + "flow", + "flow_details", + "flow_type", + "id", + "livemode", + "object", + "status", + "status_transitions" + ], "x-stripeOperations": [ { "method_name": "list", @@ -61448,6 +67356,21 @@ "transaction" ], "x-resourceId": "treasury.transaction_entry", + "x-stripeMostCommon": [ + "balance_impact", + "created", + "currency", + "effective_at", + "financial_account", + "flow", + "flow_details", + "flow_type", + "id", + "livemode", + "object", + "transaction", + "type" + ], "x-stripeOperations": [ { "method_name": "list", @@ -61509,6 +67432,13 @@ "title": "TreasuryFinancialAccountsResourceABARecord", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "account_holder_name", + "account_number", + "account_number_last4", + "bank_name", + "routing_number" + ], "x-stripeResource": { "class_name": "Aba", "in_package": "" @@ -61548,6 +67478,11 @@ "x-expandableFields": [ "status_details" ], + "x-stripeMostCommon": [ + "requested", + "status", + "status_details" + ], "x-stripeResource": { "class_name": "AbaToggleSettings", "in_package": "" @@ -61587,6 +67522,11 @@ "x-expandableFields": [ "status_details" ], + "x-stripeMostCommon": [ + "requested", + "status", + "status_details" + ], "x-stripeResource": { "class_name": "AchToggleSettings", "in_package": "" @@ -61625,6 +67565,11 @@ "title": "TreasuryFinancialAccountsResourceBalance", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "cash", + "inbound_pending", + "outbound_pending" + ], "x-stripeResource": { "class_name": "Balance", "in_package": "" @@ -61652,6 +67597,9 @@ "title": "TreasuryFinancialAccountsResourceClosedStatusDetails", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reasons" + ], "x-stripeResource": { "class_name": "Closed", "in_package": "" @@ -61691,6 +67639,11 @@ "type": "object", "x-expandableFields": [ "aba" + ], + "x-stripeMostCommon": [ + "aba", + "supported_networks", + "type" ] }, "treasury_financial_accounts_resource_financial_addresses_features": { @@ -61705,6 +67658,9 @@ "x-expandableFields": [ "aba" ], + "x-stripeMostCommon": [ + "aba" + ], "x-stripeResource": { "class_name": "FinancialAddresses", "in_package": "" @@ -61722,6 +67678,9 @@ "x-expandableFields": [ "ach" ], + "x-stripeMostCommon": [ + "ach" + ], "x-stripeResource": { "class_name": "InboundTransfers", "in_package": "" @@ -61743,6 +67702,10 @@ "ach", "us_domestic_wire" ], + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ], "x-stripeResource": { "class_name": "OutboundPayments", "in_package": "" @@ -61764,6 +67727,10 @@ "ach", "us_domestic_wire" ], + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ], "x-stripeResource": { "class_name": "OutboundTransfers", "in_package": "" @@ -61798,6 +67765,10 @@ "title": "TreasuryFinancialAccountsResourcePlatformRestrictions", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "inbound_flows", + "outbound_flows" + ], "x-stripeResource": { "class_name": "PlatformRestriction", "in_package": "" @@ -61824,6 +67795,9 @@ "x-expandableFields": [ "closed" ], + "x-stripeMostCommon": [ + "closed" + ], "x-stripeResource": { "class_name": "StatusDetails", "in_package": "" @@ -61863,6 +67837,11 @@ "x-expandableFields": [ "status_details" ], + "x-stripeMostCommon": [ + "requested", + "status", + "status_details" + ], "x-stripeResource": { "class_name": "ToggleSettings", "in_package": "" @@ -61915,6 +67894,11 @@ "title": "TreasuryFinancialAccountsResourceTogglesSettingStatusDetails", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "code", + "resolution", + "restriction" + ], "x-stripeResource": { "class_name": "StatusDetails", "in_package": "" @@ -61948,7 +67932,10 @@ ], "title": "TreasuryInboundTransfersResourceFailureDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "code" + ] }, "treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows": { "description": "", @@ -61965,7 +67952,10 @@ ], "title": "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "received_debit" + ] }, "treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions": { "description": "", @@ -61996,6 +67986,11 @@ "title": "TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "canceled_at", + "failed_at", + "succeeded_at" + ], "x-stripeResource": { "class_name": "StatusTransitions", "in_package": "" @@ -62015,7 +68010,10 @@ ], "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "trace_id" + ] }, "treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": { "description": "", @@ -62037,7 +68035,11 @@ ], "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "ip_address", + "present" + ] }, "treasury_outbound_payments_resource_outbound_payment_resource_status_transitions": { "description": "", @@ -62076,6 +68078,12 @@ "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "canceled_at", + "failed_at", + "posted_at", + "returned_at" + ], "x-stripeResource": { "class_name": "StatusTransitions", "in_package": "" @@ -62107,6 +68115,11 @@ "x-expandableFields": [ "ach", "us_domestic_wire" + ], + "x-stripeMostCommon": [ + "ach", + "type", + "us_domestic_wire" ] }, "treasury_outbound_payments_resource_returned_status": { @@ -62156,6 +68169,10 @@ "type": "object", "x-expandableFields": [ "transaction" + ], + "x-stripeMostCommon": [ + "code", + "transaction" ] }, "treasury_outbound_payments_resource_us_domestic_wire_tracking_details": { @@ -62187,7 +68204,12 @@ ], "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "chips", + "imad", + "omad" + ] }, "treasury_outbound_transfers_resource_ach_tracking_details": { "description": "", @@ -62203,7 +68225,10 @@ ], "title": "TreasuryOutboundTransfersResourceACHTrackingDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "trace_id" + ] }, "treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details": { "description": "", @@ -62231,6 +68256,11 @@ "x-expandableFields": [ "ach", "us_domestic_wire" + ], + "x-stripeMostCommon": [ + "ach", + "type", + "us_domestic_wire" ] }, "treasury_outbound_transfers_resource_returned_details": { @@ -62281,6 +68311,10 @@ "x-expandableFields": [ "transaction" ], + "x-stripeMostCommon": [ + "code", + "transaction" + ], "x-stripeResource": { "class_name": "ReturnedDetails", "in_package": "" @@ -62323,6 +68357,12 @@ "title": "TreasuryOutboundTransfersResourceStatusTransitions", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "canceled_at", + "failed_at", + "posted_at", + "returned_at" + ], "x-stripeResource": { "class_name": "StatusTransitions", "in_package": "" @@ -62357,7 +68397,12 @@ ], "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "chips", + "imad", + "omad" + ] }, "treasury_received_credits_resource_linked_flows": { "description": "", @@ -62413,6 +68458,14 @@ "type": "object", "x-expandableFields": [ "source_flow_details" + ], + "x-stripeMostCommon": [ + "credit_reversal", + "issuing_authorization", + "issuing_transaction", + "source_flow", + "source_flow_details", + "source_flow_type" ] }, "treasury_received_credits_resource_reversal_details": { @@ -62443,7 +68496,11 @@ ], "title": "TreasuryReceivedCreditsResourceReversalDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "deadline", + "restricted_reason" + ] }, "treasury_received_credits_resource_source_flows_details": { "description": "", @@ -62478,6 +68535,12 @@ "credit_reversal", "outbound_payment", "payout" + ], + "x-stripeMostCommon": [ + "credit_reversal", + "outbound_payment", + "payout", + "type" ] }, "treasury_received_credits_resource_status_transitions": { @@ -62495,7 +68558,10 @@ ], "title": "TreasuryReceivedCreditsResourceStatusTransitions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "posted_at" + ] }, "treasury_received_debits_resource_debit_reversal_linked_flows": { "description": "", @@ -62512,7 +68578,10 @@ ], "title": "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "issuing_dispute" + ] }, "treasury_received_debits_resource_linked_flows": { "description": "", @@ -62557,7 +68626,14 @@ ], "title": "TreasuryReceivedDebitsResourceLinkedFlows", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "debit_reversal", + "inbound_transfer", + "issuing_authorization", + "issuing_transaction", + "payout" + ] }, "treasury_received_debits_resource_reversal_details": { "description": "", @@ -62587,7 +68663,11 @@ ], "title": "TreasuryReceivedDebitsResourceReversalDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "deadline", + "restricted_reason" + ] }, "treasury_received_debits_resource_status_transitions": { "description": "", @@ -62604,7 +68684,10 @@ ], "title": "TreasuryReceivedDebitsResourceStatusTransitions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "completed_at" + ] }, "treasury_shared_resource_billing_details": { "description": "", @@ -62635,6 +68718,11 @@ "x-expandableFields": [ "address" ], + "x-stripeMostCommon": [ + "address", + "email", + "name" + ], "x-stripeResource": { "class_name": "BillingDetails", "in_package": "" @@ -62687,6 +68775,14 @@ "billing_details", "financial_account", "us_bank_account" + ], + "x-stripeMostCommon": [ + "balance", + "billing_details", + "financial_account", + "issuing_card", + "type", + "us_bank_account" ] }, "treasury_shared_resource_initiating_payment_method_details_us_bank_account": { @@ -62719,6 +68815,11 @@ "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "bank_name", + "last4", + "routing_number" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" @@ -62746,7 +68847,11 @@ ], "title": "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "posted_at", + "void_at" + ] }, "treasury_transactions_resource_balance_impact": { "description": "Change to a FinancialAccount's balance", @@ -62771,7 +68876,12 @@ ], "title": "TreasuryTransactionsResourceBalanceImpact", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "cash", + "inbound_pending", + "outbound_pending" + ] }, "treasury_transactions_resource_flow_details": { "description": "", @@ -62830,6 +68940,17 @@ "outbound_transfer", "received_credit", "received_debit" + ], + "x-stripeMostCommon": [ + "credit_reversal", + "debit_reversal", + "inbound_transfer", + "issuing_authorization", + "outbound_payment", + "outbound_transfer", + "received_credit", + "received_debit", + "type" ] }, "us_bank_account_networks": { @@ -62859,7 +68980,11 @@ ], "title": "us_bank_account_networks", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "preferred", + "supported" + ] }, "usage_record": { "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)\n\nThis is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).", @@ -62907,6 +69032,12 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "usage_record", + "x-stripeMostCommon": [ + "id", + "quantity", + "subscription_item", + "timestamp" + ], "x-stripeOperations": [ { "method_name": "create", @@ -62974,6 +69105,15 @@ "period" ], "x-resourceId": "usage_record_summary", + "x-stripeMostCommon": [ + "id", + "invoice", + "livemode", + "object", + "period", + "subscription_item", + "total_usage" + ], "x-stripeOperations": [ { "method_name": "list", @@ -63006,7 +69146,10 @@ ], "title": "verification_session_redaction", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [], + "x-stripeMostCommon": [ + "status" + ] }, "webhook_endpoint": { "description": "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)", @@ -63099,6 +69242,15 @@ "type": "object", "x-expandableFields": [], "x-resourceId": "webhook_endpoint", + "x-stripeMostCommon": [ + "api_version", + "description", + "enabled_events", + "id", + "metadata", + "status", + "url" + ], "x-stripeOperations": [ { "method_name": "delete", @@ -63282,11 +69434,12 @@ "type": "string" } }, - "required": [ - "fields" - ], "title": "collection_options_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fields", + "future_requirements" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -63318,7 +69471,13 @@ "account", "type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "refresh_url", + "return_url", + "type" + ] } } }, @@ -63391,14 +69550,21 @@ } }, "title": "account_features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "external_account_collection" + ] } }, "required": [ "enabled" ], "title": "account_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "account_onboarding": { "description": "Configuration for the account onboarding embedded component.", @@ -63416,14 +69582,21 @@ } }, "title": "account_features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "external_account_collection" + ] } }, "required": [ "enabled" ], "title": "account_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "balances": { "description": "Configuration for the balances embedded component.", @@ -63453,14 +69626,24 @@ } }, "title": "payouts_features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "edit_payout_schedule", + "external_account_collection", + "instant_payouts", + "standard_payouts" + ] } }, "required": [ "enabled" ], "title": "payouts_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "documents": { "description": "Configuration for the documents embedded component.", @@ -63480,7 +69663,11 @@ "enabled" ], "title": "base_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "notification_banner": { "description": "Configuration for the notification banner embedded component.", @@ -63498,14 +69685,21 @@ } }, "title": "account_features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "external_account_collection" + ] } }, "required": [ "enabled" ], "title": "account_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "payment_details": { "description": "Configuration for the payment details embedded component.", @@ -63535,14 +69729,24 @@ } }, "title": "payments_features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_payments", + "destination_on_behalf_of_charge_management", + "dispute_management", + "refund_management" + ] } }, "required": [ "enabled" ], "title": "payments_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "payments": { "description": "Configuration for the payments embedded component.", @@ -63572,14 +69776,24 @@ } }, "title": "payments_features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_payments", + "destination_on_behalf_of_charge_management", + "dispute_management", + "refund_management" + ] } }, "required": [ "enabled" ], "title": "payments_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "payouts": { "description": "Configuration for the payouts embedded component.", @@ -63609,14 +69823,24 @@ } }, "title": "payouts_features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "edit_payout_schedule", + "external_account_collection", + "instant_payouts", + "standard_payouts" + ] } }, "required": [ "enabled" ], "title": "payouts_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "payouts_list": { "description": "Configuration for the payouts list embedded component.", @@ -63636,7 +69860,11 @@ "enabled" ], "title": "base_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "tax_registrations": { "description": "Configuration for the tax registrations embedded component.", @@ -63656,7 +69884,11 @@ "enabled" ], "title": "base_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "tax_settings": { "description": "Configuration for the tax settings embedded component.", @@ -63676,11 +69908,40 @@ "enabled" ], "title": "base_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] } }, "title": "account_session_create_components_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_management", + "account_onboarding", + "app_install", + "app_viewport", + "balances", + "capital_financing", + "capital_financing_application", + "capital_financing_promotion", + "capital_overview", + "documents", + "financial_account", + "financial_account_transactions", + "issuing_card", + "issuing_cards_list", + "notification_banner", + "payment_details", + "payment_method_settings", + "payments", + "payouts", + "payouts_list", + "recipients", + "tax_registrations", + "tax_settings" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -63695,7 +69956,11 @@ "account", "components" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "components" + ] } } }, @@ -63758,7 +70023,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -63867,6 +70138,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -63967,7 +70244,12 @@ "fiscal_year_end" ], "title": "annual_revenue_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "fiscal_year_end" + ] }, "estimated_worker_count": { "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", @@ -63995,7 +70277,11 @@ "currency" ], "title": "monthly_estimated_revenue_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] }, "name": { "description": "The customer-facing business name.", @@ -64042,7 +70328,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "support_email": { "description": "A publicly available email address for sending support issues to.", @@ -64073,7 +70367,26 @@ } }, "title": "business_profile_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "annual_revenue", + "estimated_worker_count", + "industry", + "mcc", + "monthly_estimated_revenue", + "name", + "payment_collection_methods", + "privacy_policy_url", + "product_description", + "singapore_account_activity_survey", + "specified_commercial_transactions_act_url", + "support_address", + "support_email", + "support_phone", + "support_url", + "terms_of_service_url", + "url" + ] }, "business_type": { "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", @@ -64098,7 +70411,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "affirm_payments": { "description": "The affirm_payments capability.", @@ -64109,7 +70425,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "afterpay_clearpay_payments": { "description": "The afterpay_clearpay_payments capability.", @@ -64120,7 +70439,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "amazon_pay_payments": { "description": "The amazon_pay_payments capability.", @@ -64131,7 +70453,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "au_becs_debit_payments": { "description": "The au_becs_debit_payments capability.", @@ -64142,7 +70467,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bacs_debit_payments": { "description": "The bacs_debit_payments capability.", @@ -64153,7 +70481,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bancontact_payments": { "description": "The bancontact_payments capability.", @@ -64164,7 +70495,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bank_transfer_payments": { "description": "The bank_transfer_payments capability.", @@ -64175,7 +70509,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "blik_payments": { "description": "The blik_payments capability.", @@ -64186,7 +70523,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "boleto_payments": { "description": "The boleto_payments capability.", @@ -64197,7 +70537,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "card_issuing": { "description": "The card_issuing capability.", @@ -64208,7 +70551,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "card_payments": { "description": "The card_payments capability.", @@ -64219,7 +70565,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "cartes_bancaires_payments": { "description": "The cartes_bancaires_payments capability.", @@ -64230,7 +70579,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "cashapp_payments": { "description": "The cashapp_payments capability.", @@ -64241,7 +70593,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "eps_payments": { "description": "The eps_payments capability.", @@ -64252,7 +70607,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "fpx_payments": { "description": "The fpx_payments capability.", @@ -64263,7 +70621,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "gb_bank_transfer_payments": { "description": "The gb_bank_transfer_payments capability.", @@ -64274,7 +70635,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "giropay_payments": { "description": "The giropay_payments capability.", @@ -64285,7 +70649,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "grabpay_payments": { "description": "The grabpay_payments capability.", @@ -64296,7 +70663,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "ideal_payments": { "description": "The ideal_payments capability.", @@ -64307,7 +70677,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "india_international_payments": { "description": "The india_international_payments capability.", @@ -64318,7 +70691,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "jcb_payments": { "description": "The jcb_payments capability.", @@ -64329,7 +70705,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "jp_bank_transfer_payments": { "description": "The jp_bank_transfer_payments capability.", @@ -64340,7 +70719,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "klarna_payments": { "description": "The klarna_payments capability.", @@ -64351,7 +70733,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "konbini_payments": { "description": "The konbini_payments capability.", @@ -64362,7 +70747,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "legacy_payments": { "description": "The legacy_payments capability.", @@ -64373,7 +70761,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "link_payments": { "description": "The link_payments capability.", @@ -64384,7 +70775,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "mobilepay_payments": { "description": "The mobilepay_payments capability.", @@ -64395,7 +70789,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "multibanco_payments": { "description": "The multibanco_payments capability.", @@ -64406,7 +70803,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "mx_bank_transfer_payments": { "description": "The mx_bank_transfer_payments capability.", @@ -64417,7 +70817,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "oxxo_payments": { "description": "The oxxo_payments capability.", @@ -64428,7 +70831,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "p24_payments": { "description": "The p24_payments capability.", @@ -64439,7 +70845,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "paynow_payments": { "description": "The paynow_payments capability.", @@ -64450,7 +70859,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "promptpay_payments": { "description": "The promptpay_payments capability.", @@ -64461,7 +70873,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "revolut_pay_payments": { "description": "The revolut_pay_payments capability.", @@ -64472,7 +70887,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sepa_bank_transfer_payments": { "description": "The sepa_bank_transfer_payments capability.", @@ -64483,7 +70901,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sepa_debit_payments": { "description": "The sepa_debit_payments capability.", @@ -64494,7 +70915,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sofort_payments": { "description": "The sofort_payments capability.", @@ -64505,7 +70929,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "swish_payments": { "description": "The swish_payments capability.", @@ -64516,7 +70943,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "tax_reporting_us_1099_k": { "description": "The tax_reporting_us_1099_k capability.", @@ -64527,7 +70957,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "tax_reporting_us_1099_misc": { "description": "The tax_reporting_us_1099_misc capability.", @@ -64538,7 +70971,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "transfers": { "description": "The transfers capability.", @@ -64549,7 +70985,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "treasury": { "description": "The treasury capability.", @@ -64560,7 +70999,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "twint_payments": { "description": "The twint_payments capability.", @@ -64571,7 +71013,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "us_bank_account_ach_payments": { "description": "The us_bank_account_ach_payments capability.", @@ -64582,7 +71027,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "us_bank_transfer_payments": { "description": "The us_bank_transfer_payments capability.", @@ -64593,7 +71041,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "zip_payments": { "description": "The zip_payments capability.", @@ -64604,11 +71055,125 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "capabilities_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach_debit_payments", + "acss_debit_payments", + "affirm_payments", + "afterpay_clearpay_payments", + "alipay_payments", + "alma_payments", + "amazon_pay_payments", + "apple_pay_later_payments", + "au_bank_transfer_payments", + "au_becs_debit_payments", + "bacs_debit_payments", + "bacs_debit_stripe_sun_payments", + "bancontact_payments", + "bank_transfer_payments", + "beneficiary_transfers", + "billie_payments", + "bizum_payments", + "blik_payments", + "boleto_payments", + "ca_bank_transfer_payments", + "capchase_pay_payments", + "card_issuing", + "card_issuing_charge_card", + "card_issuing_charge_card_stripe", + "card_issuing_spend_card_cross_river", + "card_payments", + "cartes_bancaires_payments", + "cash_advances", + "cashapp_payments", + "crypto_payments", + "crypto_transfers", + "demo_pay_payments", + "duitnow_payments", + "dummy_passthrough_card_payments", + "eps_payments", + "fpx_payments", + "funding_credit", + "gb_bank_transfer_payments", + "giropay_payments", + "gopay_payments", + "grabpay_payments", + "id_bank_transfer_payments", + "id_bank_transfer_payments_bca", + "id_credit_transfer_payments", + "ideal_payments", + "india_international_payments", + "jcb_payments", + "jp_bank_transfer_payments", + "kakao_pay_payments", + "klarna_payments", + "konbini_payments", + "kr_card_payments", + "kr_market_payments", + "kriya_payments", + "legacy_payments", + "link_payments", + "loans", + "mb_way_payments", + "meta_pay_payments", + "mobilepay_payments", + "mondu_payments", + "multibanco_payments", + "mx_bank_transfer_payments", + "naver_pay_payments", + "netbanking_payments", + "ng_bank_payments", + "ng_bank_transfer_payments", + "ng_card_payments", + "ng_market_payments", + "ng_ussd_payments", + "nz_bank_account_becs_debit_payments", + "nz_bank_transfer_payments", + "oxxo_payments", + "p24_payments", + "pay_by_bank_payments", + "payco_payments", + "payments", + "paynow_payments", + "paypal_payments", + "payto_payments", + "pix_payments", + "promptpay_payments", + "qris_payments", + "rechnung_payments", + "revolut_pay_payments", + "samsung_pay_payments", + "satispay_payments", + "sepa_bank_transfer_payments", + "sepa_debit_payments", + "sequra_payments", + "shopeepay_payments", + "sofort_payments", + "south_korea_market_payments", + "submerchant_payments", + "sunbit_payments", + "swish_payments", + "tax_reporting_us_1099_k", + "tax_reporting_us_1099_misc", + "transfers", + "treasury", + "treasury_evolve", + "treasury_fifth_third", + "treasury_goldman_sachs", + "twint_payments", + "upi_payments", + "us_bank_account_ach_payments", + "us_bank_transfer_payments", + "wechat_pay_payments", + "zip_payments" + ] }, "company": { "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", @@ -64648,7 +71213,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", @@ -64690,7 +71263,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", @@ -64732,7 +71315,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "directors_provided": { "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", @@ -64790,7 +71383,12 @@ } }, "title": "company_ownership_declaration", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "phone": { "description": "The company's phone number (used for verification).", @@ -64866,15 +71464,53 @@ } }, "title": "verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "company_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "contact_point_verification_address", + "cross_border_transaction_classifications", + "directors_provided", + "executives_provided", + "export_license_id", + "export_purpose_code", + "fiscal_code", + "invoicing_recipient_code", + "name", + "name_kana", + "name_kanji", + "owners_provided", + "ownership_declaration", + "pan", + "phone", + "registered_email", + "registration_date", + "registration_number", + "stock_data", + "structure", + "tax_deduction_account_number", + "tax_id", + "tax_id_registrar", + "vat_id", + "vat_registration_status", + "verification" + ] }, "controller": { "description": "A hash of configuration describing the account controller's attributes.", @@ -64892,7 +71528,10 @@ } }, "title": "controller_fees_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payer" + ] }, "losses": { "description": "A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.", @@ -64907,7 +71546,10 @@ } }, "title": "controller_losses_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payments" + ] }, "requirement_collection": { "description": "A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.", @@ -64931,11 +71573,22 @@ } }, "title": "controller_dashboard_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] } }, "title": "controller_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application", + "dashboard", + "fees", + "losses", + "requirement_collection", + "stripe_dashboard" + ] }, "country": { "description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.", @@ -64962,7 +71615,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_license": { "description": "One or more documents that demonstrate proof of a company's license to operate.", @@ -64977,7 +71633,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_memorandum_of_association": { "description": "One or more documents showing the company's Memorandum of Association.", @@ -64992,7 +71651,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_ministerial_decree": { "description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.", @@ -65007,7 +71669,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_registration_verification": { "description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.", @@ -65022,7 +71687,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_tax_id_verification": { "description": "One or more documents that demonstrate proof of a company's tax ID.", @@ -65037,7 +71705,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "proof_of_registration": { "description": "One or more documents showing the company’s proof of registration with the national business registry.", @@ -65052,11 +71723,25 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_account_ownership_verification", + "company_address_verification", + "company_license", + "company_memorandum_of_association", + "company_ministerial_decree", + "company_registration_verification", + "company_tax_id_verification", + "company_vat_id_verification", + "proof_of_registration" + ] }, "email": { "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.", @@ -65114,7 +71799,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", @@ -65156,7 +71849,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", @@ -65198,7 +71901,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -65223,7 +71936,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -65369,7 +72087,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "Describes the person’s relationship to the account.", @@ -65407,7 +72133,17 @@ } }, "title": "individual_relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "controller", + "director", + "executive", + "officer", + "owner", + "partner", + "percent_ownership", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", @@ -65432,7 +72168,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -65449,15 +72189,50 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, "title": "individual_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "birth_city", + "birth_country", + "dob", + "email", + "first_name", + "first_name_kana", + "first_name_kanji", + "full_name_aliases", + "gender", + "id_number", + "id_number_secondary", + "last_name", + "last_name_kana", + "last_name_kanji", + "maiden_name", + "metadata", + "phone", + "political_exposure", + "registered_address", + "relationship", + "ssn_last_4", + "verification" + ] }, "metadata": { "anyOf": [ @@ -65488,7 +72263,10 @@ } }, "title": "bacs_debit_payments_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name" + ] }, "branding": { "description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.", @@ -65515,7 +72293,14 @@ } }, "title": "branding_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "icon", + "logo", + "primary_color", + "secondary_color", + "show_support_phone" + ] }, "card_issuing": { "description": "Settings specific to the account's use of the Card Issuing product.", @@ -65549,11 +72334,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "card_issuing_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tos_acceptance", + "tos_acceptances" + ] }, "card_payments": { "description": "Settings specific to card charging on the account.", @@ -65571,7 +72365,11 @@ } }, "title": "decline_charge_on_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "avs_failure", + "cvc_failure" + ] }, "statement_descriptor_prefix": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.", @@ -65610,7 +72408,14 @@ } }, "title": "card_payments_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "decline_on", + "onboarding_policy", + "statement_descriptor_prefix", + "statement_descriptor_prefix_kana", + "statement_descriptor_prefix_kanji" + ] }, "payments": { "description": "Settings that apply across payment methods for charging on the account.", @@ -65632,7 +72437,12 @@ } }, "title": "payments_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "statement_descriptor", + "statement_descriptor_kana", + "statement_descriptor_kanji" + ] }, "payouts": { "description": "Settings specific to the account's payouts.", @@ -65691,7 +72501,15 @@ } }, "title": "transfer_schedule_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "automatic", + "delay_days", + "interval", + "monthly_anchor", + "timezone", + "weekly_anchor" + ] }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", @@ -65700,7 +72518,12 @@ } }, "title": "payout_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "debit_negative_balances", + "schedule", + "statement_descriptor" + ] }, "treasury": { "description": "Settings specific to the account's Treasury FinancialAccounts.", @@ -65734,15 +72557,41 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "treasury_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tos_acceptance" + ] } }, "title": "settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "affirm_payments", + "apply_future_requirements", + "bacs_debit_payments", + "bank_bca_onboarding", + "branding", + "capital", + "card_issuing", + "card_issuing_charge_card", + "card_issuing_payout", + "card_payments", + "funding_credit", + "konbini_payments", + "payments", + "payouts", + "tax_forms", + "treasury" + ] }, "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.", @@ -65768,7 +72617,13 @@ } }, "title": "tos_acceptance_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "service_agreement", + "user_agent" + ] }, "type": { "description": "The type of Stripe account to create. May be one of `custom`, `express` or `standard`.", @@ -65780,7 +72635,19 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "business_type", + "capabilities", + "company", + "controller", + "country", + "email", + "individual", + "metadata", + "tos_acceptance", + "type" + ] } } }, @@ -66018,7 +72885,12 @@ "fiscal_year_end" ], "title": "annual_revenue_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "fiscal_year_end" + ] }, "estimated_worker_count": { "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", @@ -66046,7 +72918,11 @@ "currency" ], "title": "monthly_estimated_revenue_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] }, "name": { "description": "The customer-facing business name.", @@ -66093,7 +72969,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "support_email": { "description": "A publicly available email address for sending support issues to.", @@ -66124,7 +73008,26 @@ } }, "title": "business_profile_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "annual_revenue", + "estimated_worker_count", + "industry", + "mcc", + "monthly_estimated_revenue", + "name", + "payment_collection_methods", + "privacy_policy_url", + "product_description", + "singapore_account_activity_survey", + "specified_commercial_transactions_act_url", + "support_address", + "support_email", + "support_phone", + "support_url", + "terms_of_service_url", + "url" + ] }, "business_type": { "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", @@ -66149,7 +73052,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "affirm_payments": { "description": "The affirm_payments capability.", @@ -66160,7 +73066,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "afterpay_clearpay_payments": { "description": "The afterpay_clearpay_payments capability.", @@ -66171,7 +73080,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "amazon_pay_payments": { "description": "The amazon_pay_payments capability.", @@ -66182,7 +73094,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "au_becs_debit_payments": { "description": "The au_becs_debit_payments capability.", @@ -66193,7 +73108,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bacs_debit_payments": { "description": "The bacs_debit_payments capability.", @@ -66204,7 +73122,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bancontact_payments": { "description": "The bancontact_payments capability.", @@ -66215,7 +73136,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bank_transfer_payments": { "description": "The bank_transfer_payments capability.", @@ -66226,7 +73150,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "blik_payments": { "description": "The blik_payments capability.", @@ -66237,7 +73164,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "boleto_payments": { "description": "The boleto_payments capability.", @@ -66248,7 +73178,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "card_issuing": { "description": "The card_issuing capability.", @@ -66259,7 +73192,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "card_payments": { "description": "The card_payments capability.", @@ -66270,7 +73206,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "cartes_bancaires_payments": { "description": "The cartes_bancaires_payments capability.", @@ -66281,7 +73220,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "cashapp_payments": { "description": "The cashapp_payments capability.", @@ -66292,7 +73234,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "eps_payments": { "description": "The eps_payments capability.", @@ -66303,7 +73248,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "fpx_payments": { "description": "The fpx_payments capability.", @@ -66314,7 +73262,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "gb_bank_transfer_payments": { "description": "The gb_bank_transfer_payments capability.", @@ -66325,7 +73276,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "giropay_payments": { "description": "The giropay_payments capability.", @@ -66336,7 +73290,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "grabpay_payments": { "description": "The grabpay_payments capability.", @@ -66347,7 +73304,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "ideal_payments": { "description": "The ideal_payments capability.", @@ -66358,7 +73318,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "india_international_payments": { "description": "The india_international_payments capability.", @@ -66369,7 +73332,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "jcb_payments": { "description": "The jcb_payments capability.", @@ -66380,7 +73346,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "jp_bank_transfer_payments": { "description": "The jp_bank_transfer_payments capability.", @@ -66391,7 +73360,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "klarna_payments": { "description": "The klarna_payments capability.", @@ -66402,7 +73374,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "konbini_payments": { "description": "The konbini_payments capability.", @@ -66413,7 +73388,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "legacy_payments": { "description": "The legacy_payments capability.", @@ -66424,7 +73402,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "link_payments": { "description": "The link_payments capability.", @@ -66435,7 +73416,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "mobilepay_payments": { "description": "The mobilepay_payments capability.", @@ -66446,7 +73430,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "multibanco_payments": { "description": "The multibanco_payments capability.", @@ -66457,7 +73444,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "mx_bank_transfer_payments": { "description": "The mx_bank_transfer_payments capability.", @@ -66468,7 +73458,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "oxxo_payments": { "description": "The oxxo_payments capability.", @@ -66479,7 +73472,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "p24_payments": { "description": "The p24_payments capability.", @@ -66490,7 +73486,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "paynow_payments": { "description": "The paynow_payments capability.", @@ -66501,7 +73500,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "promptpay_payments": { "description": "The promptpay_payments capability.", @@ -66512,7 +73514,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "revolut_pay_payments": { "description": "The revolut_pay_payments capability.", @@ -66523,7 +73528,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sepa_bank_transfer_payments": { "description": "The sepa_bank_transfer_payments capability.", @@ -66534,7 +73542,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sepa_debit_payments": { "description": "The sepa_debit_payments capability.", @@ -66545,7 +73556,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sofort_payments": { "description": "The sofort_payments capability.", @@ -66556,7 +73570,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "swish_payments": { "description": "The swish_payments capability.", @@ -66567,7 +73584,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "tax_reporting_us_1099_k": { "description": "The tax_reporting_us_1099_k capability.", @@ -66578,7 +73598,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "tax_reporting_us_1099_misc": { "description": "The tax_reporting_us_1099_misc capability.", @@ -66589,7 +73612,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "transfers": { "description": "The transfers capability.", @@ -66600,7 +73626,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "treasury": { "description": "The treasury capability.", @@ -66611,7 +73640,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "twint_payments": { "description": "The twint_payments capability.", @@ -66622,7 +73654,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "us_bank_account_ach_payments": { "description": "The us_bank_account_ach_payments capability.", @@ -66633,7 +73668,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "us_bank_transfer_payments": { "description": "The us_bank_transfer_payments capability.", @@ -66644,7 +73682,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "zip_payments": { "description": "The zip_payments capability.", @@ -66655,11 +73696,125 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "capabilities_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach_debit_payments", + "acss_debit_payments", + "affirm_payments", + "afterpay_clearpay_payments", + "alipay_payments", + "alma_payments", + "amazon_pay_payments", + "apple_pay_later_payments", + "au_bank_transfer_payments", + "au_becs_debit_payments", + "bacs_debit_payments", + "bacs_debit_stripe_sun_payments", + "bancontact_payments", + "bank_transfer_payments", + "beneficiary_transfers", + "billie_payments", + "bizum_payments", + "blik_payments", + "boleto_payments", + "ca_bank_transfer_payments", + "capchase_pay_payments", + "card_issuing", + "card_issuing_charge_card", + "card_issuing_charge_card_stripe", + "card_issuing_spend_card_cross_river", + "card_payments", + "cartes_bancaires_payments", + "cash_advances", + "cashapp_payments", + "crypto_payments", + "crypto_transfers", + "demo_pay_payments", + "duitnow_payments", + "dummy_passthrough_card_payments", + "eps_payments", + "fpx_payments", + "funding_credit", + "gb_bank_transfer_payments", + "giropay_payments", + "gopay_payments", + "grabpay_payments", + "id_bank_transfer_payments", + "id_bank_transfer_payments_bca", + "id_credit_transfer_payments", + "ideal_payments", + "india_international_payments", + "jcb_payments", + "jp_bank_transfer_payments", + "kakao_pay_payments", + "klarna_payments", + "konbini_payments", + "kr_card_payments", + "kr_market_payments", + "kriya_payments", + "legacy_payments", + "link_payments", + "loans", + "mb_way_payments", + "meta_pay_payments", + "mobilepay_payments", + "mondu_payments", + "multibanco_payments", + "mx_bank_transfer_payments", + "naver_pay_payments", + "netbanking_payments", + "ng_bank_payments", + "ng_bank_transfer_payments", + "ng_card_payments", + "ng_market_payments", + "ng_ussd_payments", + "nz_bank_account_becs_debit_payments", + "nz_bank_transfer_payments", + "oxxo_payments", + "p24_payments", + "pay_by_bank_payments", + "payco_payments", + "payments", + "paynow_payments", + "paypal_payments", + "payto_payments", + "pix_payments", + "promptpay_payments", + "qris_payments", + "rechnung_payments", + "revolut_pay_payments", + "samsung_pay_payments", + "satispay_payments", + "sepa_bank_transfer_payments", + "sepa_debit_payments", + "sequra_payments", + "shopeepay_payments", + "sofort_payments", + "south_korea_market_payments", + "submerchant_payments", + "sunbit_payments", + "swish_payments", + "tax_reporting_us_1099_k", + "tax_reporting_us_1099_misc", + "transfers", + "treasury", + "treasury_evolve", + "treasury_fifth_third", + "treasury_goldman_sachs", + "twint_payments", + "upi_payments", + "us_bank_account_ach_payments", + "us_bank_transfer_payments", + "wechat_pay_payments", + "zip_payments" + ] }, "company": { "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", @@ -66699,7 +73854,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", @@ -66741,7 +73904,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", @@ -66783,7 +73956,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "directors_provided": { "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", @@ -66841,7 +74024,12 @@ } }, "title": "company_ownership_declaration", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "phone": { "description": "The company's phone number (used for verification).", @@ -66917,15 +74105,53 @@ } }, "title": "verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "company_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "contact_point_verification_address", + "cross_border_transaction_classifications", + "directors_provided", + "executives_provided", + "export_license_id", + "export_purpose_code", + "fiscal_code", + "invoicing_recipient_code", + "name", + "name_kana", + "name_kanji", + "owners_provided", + "ownership_declaration", + "pan", + "phone", + "registered_email", + "registration_date", + "registration_number", + "stock_data", + "structure", + "tax_deduction_account_number", + "tax_id", + "tax_id_registrar", + "vat_id", + "vat_registration_status", + "verification" + ] }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", @@ -66947,7 +74173,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_license": { "description": "One or more documents that demonstrate proof of a company's license to operate.", @@ -66962,7 +74191,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_memorandum_of_association": { "description": "One or more documents showing the company's Memorandum of Association.", @@ -66977,7 +74209,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_ministerial_decree": { "description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.", @@ -66992,7 +74227,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_registration_verification": { "description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.", @@ -67007,7 +74245,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_tax_id_verification": { "description": "One or more documents that demonstrate proof of a company's tax ID.", @@ -67022,7 +74263,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "proof_of_registration": { "description": "One or more documents showing the company’s proof of registration with the national business registry.", @@ -67037,11 +74281,25 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_account_ownership_verification", + "company_address_verification", + "company_license", + "company_memorandum_of_association", + "company_ministerial_decree", + "company_registration_verification", + "company_tax_id_verification", + "company_vat_id_verification", + "proof_of_registration" + ] }, "email": { "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.", @@ -67099,7 +74357,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", @@ -67141,7 +74407,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", @@ -67183,7 +74459,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -67208,7 +74494,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -67354,7 +74645,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "Describes the person’s relationship to the account.", @@ -67392,7 +74691,17 @@ } }, "title": "individual_relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "controller", + "director", + "executive", + "officer", + "owner", + "partner", + "percent_ownership", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", @@ -67417,7 +74726,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -67434,15 +74747,50 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, "title": "individual_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "birth_city", + "birth_country", + "dob", + "email", + "first_name", + "first_name_kana", + "first_name_kanji", + "full_name_aliases", + "gender", + "id_number", + "id_number_secondary", + "last_name", + "last_name_kana", + "last_name_kanji", + "maiden_name", + "metadata", + "phone", + "political_exposure", + "registered_address", + "relationship", + "ssn_last_4", + "verification" + ] }, "metadata": { "anyOf": [ @@ -67473,7 +74821,10 @@ } }, "title": "bacs_debit_payments_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name" + ] }, "branding": { "description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.", @@ -67500,7 +74851,14 @@ } }, "title": "branding_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "icon", + "logo", + "primary_color", + "secondary_color", + "show_support_phone" + ] }, "card_issuing": { "description": "Settings specific to the account's use of the Card Issuing product.", @@ -67534,11 +74892,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "card_issuing_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tos_acceptance", + "tos_acceptances" + ] }, "card_payments": { "description": "Settings specific to card charging on the account.", @@ -67556,7 +74923,11 @@ } }, "title": "decline_charge_on_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "avs_failure", + "cvc_failure" + ] }, "statement_descriptor_prefix": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.", @@ -67595,7 +74966,14 @@ } }, "title": "card_payments_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "decline_on", + "onboarding_policy", + "statement_descriptor_prefix", + "statement_descriptor_prefix_kana", + "statement_descriptor_prefix_kanji" + ] }, "invoices": { "description": "Settings specific to the account's use of Invoices.", @@ -67620,7 +74998,10 @@ } }, "title": "invoices_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_account_tax_ids" + ] }, "payments": { "description": "Settings that apply across payment methods for charging on the account.", @@ -67642,7 +75023,12 @@ } }, "title": "payments_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "statement_descriptor", + "statement_descriptor_kana", + "statement_descriptor_kanji" + ] }, "payouts": { "description": "Settings specific to the account's payouts.", @@ -67701,7 +75087,15 @@ } }, "title": "transfer_schedule_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "automatic", + "delay_days", + "interval", + "monthly_anchor", + "timezone", + "weekly_anchor" + ] }, "statement_descriptor": { "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.", @@ -67710,7 +75104,12 @@ } }, "title": "payout_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "debit_negative_balances", + "schedule", + "statement_descriptor" + ] }, "treasury": { "description": "Settings specific to the account's Treasury FinancialAccounts.", @@ -67744,15 +75143,42 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "treasury_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tos_acceptance" + ] } }, "title": "settings_specs_update", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "affirm_payments", + "apply_future_requirements", + "bacs_debit_payments", + "bank_bca_onboarding", + "branding", + "capital", + "card_issuing", + "card_issuing_charge_card", + "card_issuing_payout", + "card_payments", + "funding_credit", + "invoices", + "konbini_payments", + "payments", + "payouts", + "tax_forms", + "treasury" + ] }, "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.", @@ -67778,10 +75204,25 @@ } }, "title": "tos_acceptance_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "service_agreement", + "user_agent" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "business_type", + "capabilities", + "company", + "email", + "individual", + "metadata", + "tos_acceptance" + ] } } }, @@ -67895,6 +75336,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -68039,7 +75486,10 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } } }, @@ -68203,6 +75653,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -68281,7 +75737,11 @@ "required": [ "external_account" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "external_account", + "metadata" + ] } } }, @@ -68567,11 +76027,17 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "external_account_documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_account_ownership_verification" + ] }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", @@ -68614,7 +76080,11 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_for_currency", + "metadata" + ] } } }, @@ -68792,7 +76262,17 @@ } }, "title": "all_people_relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "representative" + ] }, "style": "deepObject" }, @@ -68861,6 +76341,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -68982,11 +76468,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "person_additional_tos_acceptances_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "representative" + ] }, "address": { "description": "The person's address.", @@ -69023,7 +76518,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", @@ -69065,7 +76568,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", @@ -69107,7 +76620,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -69132,7 +76655,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -69169,7 +76697,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", @@ -69194,7 +76725,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", @@ -69219,11 +76753,20 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "person_documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "DASHBOARD_proof_of_liveness", + "company_authorization", + "passport", + "visa" + ] }, "email": { "description": "The person's email address.", @@ -69375,7 +76918,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", @@ -69421,7 +76972,20 @@ } }, "title": "relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "controller", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "percent_ownership", + "representative", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", @@ -69445,7 +77009,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -69462,14 +77030,34 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "first_name", + "id_number", + "last_name", + "metadata", + "phone", + "relationship", + "ssn_last_4" + ] } } }, @@ -69750,11 +77338,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "person_additional_tos_acceptances_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "representative" + ] }, "address": { "description": "The person's address.", @@ -69791,7 +77388,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", @@ -69833,7 +77438,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", @@ -69875,7 +77490,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -69900,7 +77525,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -69937,7 +77567,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", @@ -69962,7 +77595,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", @@ -69987,11 +77623,20 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "person_documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "DASHBOARD_proof_of_liveness", + "company_authorization", + "passport", + "visa" + ] }, "email": { "description": "The person's email address.", @@ -70143,7 +77788,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", @@ -70189,7 +77842,20 @@ } }, "title": "relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "controller", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "percent_ownership", + "representative", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", @@ -70213,7 +77879,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -70230,14 +77900,34 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "first_name", + "id_number", + "last_name", + "metadata", + "phone", + "relationship", + "ssn_last_4" + ] } } }, @@ -70312,7 +78002,10 @@ "required": [ "reason" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reason" + ] } } }, @@ -70459,6 +78152,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -70507,7 +78206,10 @@ "required": [ "domain_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "domain_name" + ] } } }, @@ -70700,7 +78402,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -70811,6 +78519,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -70974,7 +78688,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -71189,6 +78906,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -71258,7 +78981,11 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "metadata" + ] } } }, @@ -71355,7 +79082,11 @@ "type" ], "title": "scope_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] }, "style": "deepObject" }, @@ -71425,6 +79156,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -71506,7 +79243,11 @@ "type" ], "title": "scope_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] } }, "required": [ @@ -71514,7 +79255,13 @@ "payload", "scope" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_at", + "name", + "payload", + "scope" + ] } } }, @@ -71598,14 +79345,22 @@ "type" ], "title": "scope_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] } }, "required": [ "name", "scope" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "scope" + ] } } }, @@ -71692,7 +79447,11 @@ "type" ], "title": "scope_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] }, "style": "deepObject" } @@ -71825,7 +79584,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -71979,6 +79744,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -72080,7 +79851,8 @@ "enum": [ "usage_threshold" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "style": "form" }, @@ -72197,6 +79969,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -72243,7 +80021,8 @@ "enum": [ "usage_threshold" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -72260,10 +80039,26 @@ "description": "Limit the scope to this alert only to this customer.", "maxLength": 5000, "type": "string" + }, + "subscription": { + "description": "Limit the scope of this rated usage alert to this subscription.", + "maxLength": 5000, + "type": "string" + }, + "subscription_item": { + "description": "Limit the scope of this rated usage alert to this subscription item.", + "maxLength": 5000, + "type": "string" } }, "title": "alert_filter", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "price", + "subscription", + "subscription_item" + ] }, "title": { "description": "The title of the alert.", @@ -72296,14 +80091,25 @@ "recurrence" ], "title": "usage_threshold_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gte", + "meter", + "recurrence" + ] } }, "required": [ "alert_type", "title" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "alert_type", + "filter", + "title", + "usage_threshold_config" + ] } } }, @@ -72632,7 +80438,10 @@ } }, "title": "event_adjustment_cancel_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "identifier" + ] }, "event_name": { "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", @@ -72659,7 +80468,12 @@ "event_name", "type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancel", + "event_name", + "type" + ] } } }, @@ -72744,7 +80558,13 @@ "event_name", "payload" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "event_name", + "identifier", + "payload", + "timestamp" + ] } } }, @@ -72895,6 +80715,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -72961,7 +80787,11 @@ "type" ], "title": "customer_mapping_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "event_payload_key", + "type" + ] }, "default_aggregation": { "description": "The default settings to aggregate a meter's events with.", @@ -72979,7 +80809,10 @@ "formula" ], "title": "aggregation_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "formula" + ] }, "display_name": { "description": "The meter's name.", @@ -73020,7 +80853,10 @@ "event_payload_key" ], "title": "meter_value_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "event_payload_key" + ] } }, "required": [ @@ -73028,7 +80864,15 @@ "display_name", "event_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_mapping", + "default_aggregation", + "display_name", + "event_name", + "event_time_window", + "value_settings" + ] } } }, @@ -73168,7 +81012,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name" + ] } } }, @@ -73431,6 +81278,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -73645,6 +81498,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -73726,7 +81585,12 @@ } }, "title": "business_profile_create_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "headline", + "privacy_policy_url", + "terms_of_service_url" + ] }, "default_return_url": { "anyOf": [ @@ -73790,7 +81654,11 @@ "enabled" ], "title": "customer_update_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_updates", + "enabled" + ] }, "invoice_history": { "description": "Information about showing the billing history in the portal.", @@ -73804,7 +81672,10 @@ "enabled" ], "title": "invoice_list_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_method_update": { "description": "Information about updating payment methods in the portal.", @@ -73818,7 +81689,10 @@ "enabled" ], "title": "payment_method_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "subscription_cancel": { "description": "Information about canceling subscriptions in the portal.", @@ -73863,7 +81737,11 @@ "options" ], "title": "subscription_cancellation_reason_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "options" + ] }, "enabled": { "description": "Whether the feature is enabled.", @@ -73891,7 +81769,14 @@ "enabled" ], "title": "subscription_cancel_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason", + "cancellation_redirect", + "enabled", + "mode", + "proration_behavior" + ] }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", @@ -73946,7 +81831,11 @@ "product" ], "title": "subscription_update_product_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "prices", + "product" + ] }, "type": "array" }, @@ -73975,11 +81864,25 @@ "products" ], "title": "subscription_update_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_allowed_updates", + "enabled", + "products", + "proration_behavior", + "schedule_at_period_end" + ] } }, "title": "features_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_update", + "invoice_history", + "payment_method_update", + "subscription_cancel", + "subscription_update" + ] }, "login_page": { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", @@ -73993,7 +81896,10 @@ "enabled" ], "title": "login_page_create_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "metadata": { "additionalProperties": { @@ -74007,7 +81913,14 @@ "business_profile", "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "business_profile", + "default_return_url", + "features", + "login_page", + "metadata" + ] } } }, @@ -74203,7 +82116,12 @@ } }, "title": "business_profile_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "headline", + "privacy_policy_url", + "terms_of_service_url" + ] }, "default_return_url": { "anyOf": [ @@ -74264,7 +82182,11 @@ } }, "title": "customer_update_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_updates", + "enabled" + ] }, "invoice_history": { "description": "Information about showing the billing history in the portal.", @@ -74278,7 +82200,10 @@ "enabled" ], "title": "invoice_list_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_method_update": { "description": "Information about updating payment methods in the portal.", @@ -74292,7 +82217,10 @@ "enabled" ], "title": "payment_method_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "subscription_cancel": { "description": "Information about canceling subscriptions in the portal.", @@ -74336,7 +82264,11 @@ "enabled" ], "title": "subscription_cancellation_reason_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "options" + ] }, "enabled": { "description": "Whether the feature is enabled.", @@ -74361,7 +82293,14 @@ } }, "title": "subscription_cancel_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason", + "cancellation_redirect", + "enabled", + "mode", + "proration_behavior" + ] }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", @@ -74416,7 +82355,11 @@ "product" ], "title": "subscription_update_product_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "prices", + "product" + ] }, "type": "array" }, @@ -74440,11 +82383,25 @@ } }, "title": "subscription_update_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_allowed_updates", + "enabled", + "products", + "proration_behavior", + "schedule_at_period_end" + ] } }, "title": "features_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_update", + "invoice_history", + "payment_method_update", + "subscription_cancel", + "subscription_update" + ] }, "login_page": { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", @@ -74458,7 +82415,10 @@ "enabled" ], "title": "login_page_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "metadata": { "anyOf": [ @@ -74478,7 +82438,15 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "business_profile", + "default_return_url", + "features", + "login_page", + "metadata" + ] } } }, @@ -74562,7 +82530,10 @@ } }, "title": "after_completion_hosted_confirmation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_message" + ] }, "redirect": { "description": "Configuration when `after_completion.type=redirect`.", @@ -74576,7 +82547,10 @@ "return_url" ], "title": "after_completion_redirect_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "return_url" + ] }, "type": { "description": "The specified behavior after the flow is completed.", @@ -74592,7 +82566,12 @@ "type" ], "title": "flow_data_after_completion_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "hosted_confirmation", + "redirect", + "type" + ] }, "subscription_cancel": { "description": "Configuration when `flow_data.type=subscription_cancel`.", @@ -74613,7 +82592,10 @@ "coupon" ], "title": "coupon_offer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": { "description": "Type of retention strategy to use with the customer.", @@ -74628,7 +82610,11 @@ "type" ], "title": "retention_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon_offer", + "type" + ] }, "subscription": { "description": "The ID of the subscription to be canceled.", @@ -74640,7 +82626,11 @@ "subscription" ], "title": "flow_data_subscription_cancel_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "retention", + "subscription" + ] }, "subscription_update": { "description": "Configuration when `flow_data.type=subscription_update`.", @@ -74655,7 +82645,10 @@ "subscription" ], "title": "flow_data_subscription_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "subscription" + ] }, "subscription_update_confirm": { "description": "Configuration when `flow_data.type=subscription_update_confirm`.", @@ -74676,7 +82669,11 @@ } }, "title": "subscription_update_confirm_discount_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon", + "promotion_code" + ] }, "type": "array" }, @@ -74703,7 +82700,13 @@ "id" ], "title": "subscription_update_confirm_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "deleted", + "id", + "price", + "quantity" + ] }, "type": "array" }, @@ -74718,7 +82721,13 @@ "subscription" ], "title": "flow_data_subscription_update_confirm_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "discounts", + "items", + "recurring_items", + "subscription" + ] }, "type": { "description": "Type of flow that the customer will go through.", @@ -74735,7 +82744,14 @@ "type" ], "title": "flow_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after_completion", + "subscription_cancel", + "subscription_update", + "subscription_update_confirm", + "type" + ] }, "locale": { "description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.", @@ -74802,7 +82818,15 @@ "required": [ "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "configuration", + "customer", + "flow_data", + "locale", + "on_behalf_of", + "return_url" + ] } } }, @@ -74865,7 +82889,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -75007,6 +83037,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -75105,7 +83141,11 @@ "account" ], "title": "destination_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "amount" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -75147,7 +83187,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "receipt_email": { "description": "The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).", @@ -75191,7 +83235,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -75219,7 +83271,14 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "source": { "description": "A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.", @@ -75254,14 +83313,32 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).", "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "application_fee", + "currency", + "customer", + "description", + "destination", + "metadata", + "receipt_email", + "shipping", + "source", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -75405,6 +83482,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -75566,7 +83651,10 @@ "user_report" ], "title": "fraud_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "user_report" + ] }, "metadata": { "anyOf": [ @@ -75628,7 +83716,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -75656,14 +83752,28 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "description", + "metadata", + "receipt_email", + "shipping" + ] } } }, @@ -75768,14 +83878,24 @@ } }, "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount" + ] }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.", "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "application_fee", + "receipt_email", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -75919,6 +84039,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -76047,7 +84173,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -76084,7 +84216,10 @@ "email" ], "title": "customer_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "email" + ] }, "style": "deepObject" }, @@ -76237,6 +84372,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -76373,11 +84514,18 @@ "enabled" ], "title": "recovery_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_promotion_codes", + "enabled" + ] } }, "title": "after_expiration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "recovery" + ] }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", @@ -76410,14 +84558,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_address_collection": { "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", @@ -76456,7 +84612,10 @@ "position" ], "title": "payment_method_reuse_agreement_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "position" + ] }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.", @@ -76476,7 +84635,12 @@ } }, "title": "consent_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_reuse_agreement", + "promotions", + "terms_of_service" + ] }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.", @@ -76514,7 +84678,11 @@ "value" ], "title": "custom_field_option_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "label", + "value" + ] }, "type": "array" } @@ -76523,7 +84691,11 @@ "options" ], "title": "custom_field_dropdown_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "options" + ] }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", @@ -76551,7 +84723,11 @@ "type" ], "title": "custom_field_label_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom", + "type" + ] }, "numeric": { "description": "Configuration for `type=numeric` fields.", @@ -76571,7 +84747,12 @@ } }, "title": "custom_field_numeric_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", @@ -76595,7 +84776,12 @@ } }, "title": "custom_field_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "type": { "description": "The type of the field.", @@ -76613,7 +84799,16 @@ "type" ], "title": "custom_field_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dropdown", + "key", + "label", + "numeric", + "optional", + "text", + "type" + ] }, "type": "array" }, @@ -76634,7 +84829,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -76659,7 +84857,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -76684,7 +84885,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -76709,7 +84913,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -76722,7 +84929,13 @@ } }, "title": "custom_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after_submit", + "shipping_address", + "submit", + "terms_of_service_acceptance" + ] }, "customer": { "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.", @@ -76773,7 +84986,12 @@ } }, "title": "customer_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "shipping" + ] }, "discounts": { "description": "The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.", @@ -76791,7 +85009,11 @@ } }, "title": "discount_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon", + "promotion_code" + ] }, "type": "array" }, @@ -76857,7 +85079,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -76900,7 +85126,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "additionalProperties": { @@ -76924,7 +85154,11 @@ } }, "title": "rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title" + ] }, { "enum": [ @@ -76937,14 +85171,27 @@ } }, "title": "invoice_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "metadata", + "rendering_options" + ] } }, "required": [ "enabled" ], "title": "invoice_creation_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "invoice_data" + ] }, "line_items": { "description": "A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\n\nFor `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.", @@ -76970,7 +85217,12 @@ "enabled" ], "title": "adjustable_quantity_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "maximum", + "minimum" + ] }, "dynamic_tax_rates": { "description": "The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.", @@ -77034,7 +85286,14 @@ "name" ], "title": "product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", @@ -77058,7 +85317,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -77083,7 +85345,12 @@ "currency" ], "title": "price_data_with_product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.", @@ -77099,7 +85366,18 @@ } }, "title": "line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "adjustable_quantity", + "display", + "dynamic_tax_rates", + "metadata", + "price", + "price_data", + "pricing_spec", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -77252,7 +85530,15 @@ "line1" ], "title": "address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -77280,7 +85566,14 @@ "name" ], "title": "shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", @@ -77308,7 +85601,11 @@ "destination" ], "title": "transfer_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.", @@ -77316,7 +85613,23 @@ } }, "title": "payment_intent_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_amount", + "capture_method", + "cross_border_classification", + "description", + "fulfillment_date", + "metadata", + "on_behalf_of", + "receipt_email", + "setup_future_usage", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix", + "transfer_data", + "transfer_group" + ] }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", @@ -77345,7 +85658,10 @@ } }, "title": "payment_method_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redisplay" + ] }, "payment_method_options": { "description": "Payment-method-specific configuration.", @@ -77413,7 +85729,14 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", @@ -77436,7 +85759,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "setup_future_usage", + "verification_method" + ] }, "affirm": { "description": "contains details about the Affirm payment method options.", @@ -77450,7 +85779,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "afterpay_clearpay": { "description": "contains details about the Afterpay Clearpay payment method options.", @@ -77464,7 +85796,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "alipay": { "description": "contains details about the Alipay payment method options.", @@ -77478,7 +85813,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "setup_future_usage" + ] }, "amazon_pay": { "description": "contains details about the AmazonPay payment method options.", @@ -77493,7 +85832,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "au_becs_debit": { "description": "contains details about the AU Becs Debit payment method options.", @@ -77507,7 +85849,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "bacs_debit": { "description": "contains details about the Bacs Debit payment method options.", @@ -77523,7 +85868,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "target_date" + ] }, "bancontact": { "description": "contains details about the Bancontact payment method options.", @@ -77537,7 +85886,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "boleto": { "description": "contains details about the Boleto payment method options.", @@ -77557,7 +85909,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "card": { "description": "contains details about the Card payment method options.", @@ -77571,7 +85927,10 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", @@ -77603,7 +85962,15 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "request_three_d_secure", + "restrictions", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji" + ] }, "cashapp": { "description": "contains details about the Cashapp Pay payment method options.", @@ -77619,7 +85986,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "customer_balance": { "description": "contains details about the Customer Balance payment method options.", @@ -77640,7 +86010,10 @@ "country" ], "title": "eu_bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", @@ -77676,7 +86049,13 @@ "type" ], "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "requested_address_types", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -77694,7 +86073,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" + ] }, "eps": { "description": "contains details about the EPS payment method options.", @@ -77708,7 +86092,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "fpx": { "description": "contains details about the FPX payment method options.", @@ -77722,7 +86109,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "giropay": { "description": "contains details about the Giropay payment method options.", @@ -77736,7 +86126,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "grabpay": { "description": "contains details about the Grabpay payment method options.", @@ -77750,7 +86143,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "ideal": { "description": "contains details about the Ideal payment method options.", @@ -77764,7 +86160,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "klarna": { "description": "contains details about the Klarna payment method options.", @@ -77778,7 +86177,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "konbini": { "description": "contains details about the Konbini payment method options.", @@ -77796,7 +86198,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "link": { "description": "contains details about the Link payment method options.", @@ -77811,7 +86217,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "mobilepay": { "description": "contains details about the Mobilepay payment method options.", @@ -77825,7 +86234,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "multibanco": { "description": "contains details about the Multibanco payment method options.", @@ -77839,7 +86251,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "oxxo": { "description": "contains details about the OXXO payment method options.", @@ -77857,7 +86272,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "p24": { "description": "contains details about the P24 payment method options.", @@ -77875,7 +86294,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "tos_shown_and_accepted" + ] }, "paynow": { "description": "contains details about the PayNow payment method options.", @@ -77889,7 +86312,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "paypal": { "description": "contains details about the PayPal payment method options.", @@ -77951,7 +86377,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "reference", + "reference_id", + "risk_correlation_id", + "setup_future_usage", + "subsellers" + ] }, "pix": { "description": "contains details about the Pix payment method options.", @@ -77962,7 +86397,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_seconds" + ] }, "revolut_pay": { "description": "contains details about the RevolutPay payment method options.", @@ -77977,7 +86415,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "sepa_debit": { "description": "contains details about the Sepa Debit payment method options.", @@ -77993,7 +86434,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "target_date", + "verification_method" + ] }, "sofort": { "description": "contains details about the Sofort payment method options.", @@ -78007,7 +86453,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "swish": { "description": "contains details about the Swish payment method options.", @@ -78019,7 +86468,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorization_method", + "reference" + ] }, "us_bank_account": { "description": "contains details about the Us Bank Account payment method options.", @@ -78057,7 +86510,11 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "permissions", + "prefetch" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).", @@ -78079,7 +86536,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "setup_future_usage", + "verification_method" + ] }, "wechat_pay": { "description": "contains details about the WeChat Pay payment method options.", @@ -78111,11 +86573,59 @@ "client" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "boleto", + "card", + "cashapp", + "customer_balance", + "demo_pay", + "eps", + "fpx", + "giropay", + "grabpay", + "id_bank_transfer", + "ideal", + "klarna", + "konbini", + "kr_market", + "link", + "mobilepay", + "multibanco", + "ng_card", + "ng_market", + "oxxo", + "p24", + "pay_by_bank", + "paynow", + "paypal", + "payto", + "pix", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "upi", + "us_bank_account", + "wechat_pay" + ] }, "payment_method_types": { "description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nYou can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nSee [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.", @@ -78176,10 +86686,13 @@ "enabled" ], "title": "phone_number_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "redirect_on_completion": { - "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -78217,7 +86730,12 @@ } }, "title": "saved_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redisplay_filters", + "payment_method_remove", + "payment_method_save" + ] }, "setup_intent_data": { "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.", @@ -78240,7 +86758,12 @@ } }, "title": "setup_intent_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "metadata", + "on_behalf_of" + ] }, "shipping_address_collection": { "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.", @@ -78496,7 +87019,10 @@ "allowed_countries" ], "title": "shipping_address_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_countries" + ] }, "shipping_options": { "description": "The shipping rate options to apply to this Session. Up to a maximum of 5.", @@ -78537,7 +87063,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -78563,11 +87093,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -78606,7 +87144,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -78617,7 +87159,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -78651,11 +87198,21 @@ "display_name" ], "title": "method_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } }, "title": "shipping_option_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate", + "shipping_rate_data" + ] }, "type": "array" }, @@ -78717,11 +87274,18 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "issuer" + ] }, "metadata": { "additionalProperties": { @@ -78758,7 +87322,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial_end": { "description": "Unix timestamp representing the end of the trial period the customer\nwill get before being charged for the first time. Has to be at least\n48 hours in the future.", @@ -78789,18 +87357,38 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] } }, "title": "subscription_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_percent", + "billing_cycle_anchor", + "default_tax_rates", + "description", + "invoice_settings", + "metadata", + "on_behalf_of", + "proration_behavior", + "tax_filing_currency", + "transfer_data", + "trial_end", + "trial_period_days" + ] }, "success_url": { "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded`. If you’d like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).", @@ -78819,7 +87407,11 @@ "enabled" ], "title": "tax_id_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "required" + ] }, "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", @@ -78831,7 +87423,17 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "client_reference_id", + "customer", + "customer_email", + "line_items", + "metadata", + "mode", + "return_url", + "success_url" + ] } } }, @@ -78985,7 +87587,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -79199,6 +87804,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -79325,6 +87936,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -79383,7 +88000,10 @@ "public_name" ], "title": "beneficiary_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "public_name" + ] }, "currency": { "description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.", @@ -79419,7 +88039,15 @@ "required": [ "product" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "beneficiary", + "currency", + "metadata", + "metric_tons", + "product" + ] } } }, @@ -79577,7 +88205,10 @@ "public_name" ], "title": "beneficiary_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "public_name" + ] }, { "enum": [ @@ -79604,7 +88235,11 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "beneficiary", + "metadata" + ] } } }, @@ -79809,6 +88444,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -80003,6 +88644,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -80265,6 +88912,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -80385,7 +89038,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -80496,6 +89155,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -80558,7 +89223,11 @@ } }, "title": "applies_to_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "product_classes", + "products" + ] }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).", @@ -80576,7 +89245,10 @@ "amount_off" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_off" + ] }, "description": "Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -80644,7 +89316,16 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_off", + "currency", + "duration", + "duration_in_months", + "metadata", + "name", + "percent_off" + ] } } }, @@ -80839,7 +89520,10 @@ "amount_off" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_off" + ] }, "description": "Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -80875,7 +89559,11 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "name" + ] } } }, @@ -80938,7 +89626,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -81070,6 +89764,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -81196,7 +89896,12 @@ "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate", + "taxable_amount" + ] }, "type": "array" }, @@ -81249,7 +89954,18 @@ "type" ], "title": "credit_note_line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_line_item", + "quantity", + "tax_amounts", + "tax_rates", + "type", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -81297,13 +90013,23 @@ } }, "title": "credit_note_shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate" + ] } }, "required": [ "invoice" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice", + "lines", + "memo", + "metadata", + "reason" + ] } } }, @@ -81461,7 +90187,12 @@ "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate", + "taxable_amount" + ] }, "type": "array" }, @@ -81514,7 +90245,18 @@ "type" ], "title": "credit_note_line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_line_item", + "quantity", + "tax_amounts", + "tax_rates", + "type", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -81606,7 +90348,10 @@ } }, "title": "credit_note_shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate" + ] }, "style": "deepObject" } @@ -81797,7 +90542,12 @@ "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate", + "taxable_amount" + ] }, "type": "array" }, @@ -81850,7 +90600,18 @@ "type" ], "title": "credit_note_line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_line_item", + "quantity", + "tax_amounts", + "tax_rates", + "type", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -81942,7 +90703,10 @@ } }, "title": "credit_note_shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate" + ] }, "style": "deepObject" }, @@ -82012,6 +90776,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -82148,6 +90918,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -82286,7 +91062,11 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "memo", + "metadata" + ] } } }, @@ -82418,7 +91198,10 @@ "enabled" ], "title": "buy_button_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_element": { "description": "Configuration for the Payment Element.", @@ -82483,14 +91266,28 @@ } }, "title": "features_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_allow_redisplay_filters", + "payment_method_redisplay", + "payment_method_redisplay_limit", + "payment_method_remove", + "payment_method_save", + "payment_method_save_usage", + "payment_method_set_as_default", + "payment_method_update" + ] } }, "required": [ "enabled" ], "title": "payment_element_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "pricing_table": { "description": "Configuration for the pricing table.", @@ -82504,11 +91301,22 @@ "enabled" ], "title": "pricing_table_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] } }, "title": "components", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "buy_button", + "customer_sheet", + "mobile_payment_element", + "payment_element", + "payment_sheet", + "pricing_table" + ] }, "customer": { "description": "The ID of an existing customer for which to create the Customer Session.", @@ -82528,7 +91336,11 @@ "components", "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "components", + "customer" + ] } } }, @@ -82591,7 +91403,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -82724,6 +91542,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -82825,7 +91649,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -82857,11 +91689,17 @@ } }, "title": "balance_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reconciliation_mode" + ] } }, "title": "cash_balance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "settings" + ] }, "coupon": { "maxLength": 5000, @@ -82914,7 +91752,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -82949,10 +91791,20 @@ "include_inclusive_tax" ], "type": "string" + }, + "template": { + "description": "ID of the invoice rendering template to use for future invoices.", + "maxLength": 5000, + "type": "string" } }, "title": "customer_rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title", + "template" + ] }, { "enum": [ @@ -82965,7 +91817,18 @@ } }, "title": "customer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_to_forgive", + "amount_to_forgive_currency", + "custom_fields", + "days_until_due", + "default_payment_method", + "footer", + "rendering_options", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "metadata": { "anyOf": [ @@ -83054,7 +91917,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -83072,7 +91943,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -83115,7 +91991,11 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "validate_location" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -83223,7 +92103,11 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" }, @@ -83236,7 +92120,17 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "description", + "email", + "metadata", + "name", + "payment_method", + "phone", + "shipping" + ] } } }, @@ -83380,6 +92274,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -83615,7 +92517,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -83647,11 +92557,17 @@ } }, "title": "balance_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reconciliation_mode" + ] } }, "title": "cash_balance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "settings" + ] }, "coupon": { "maxLength": 5000, @@ -83709,7 +92625,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -83744,10 +92664,20 @@ "include_inclusive_tax" ], "type": "string" + }, + "template": { + "description": "ID of the invoice rendering template to use for future invoices.", + "maxLength": 5000, + "type": "string" } }, "title": "customer_rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title", + "template" + ] }, { "enum": [ @@ -83760,7 +92690,18 @@ } }, "title": "customer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_to_forgive", + "amount_to_forgive_currency", + "custom_fields", + "days_until_due", + "default_payment_method", + "footer", + "rendering_options", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "metadata": { "anyOf": [ @@ -83845,7 +92786,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -83863,7 +92812,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -83906,7 +92860,11 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "validate_location" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -83922,7 +92880,16 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "description", + "email", + "metadata", + "name", + "phone", + "shipping" + ] } } }, @@ -84069,6 +93036,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -84161,7 +93134,13 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "metadata" + ] } } }, @@ -84339,7 +93318,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "metadata" + ] } } }, @@ -84489,10 +93472,16 @@ } }, "title": "balance_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reconciliation_mode" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "settings" + ] } } }, @@ -84639,6 +93628,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -84836,7 +93831,10 @@ "country" ], "title": "eu_bank_account_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", @@ -84869,7 +93867,12 @@ "type" ], "title": "bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "requested_address_types", + "type" + ] }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -84896,7 +93899,12 @@ "currency", "funding_type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "currency", + "funding_type" + ] } } }, @@ -85105,6 +94113,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -85328,6 +94342,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -85405,7 +94425,11 @@ "required": [ "source" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "source" + ] } } }, @@ -85759,7 +94783,15 @@ } }, "title": "source_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "email": { "description": "Owner's email address.", @@ -85777,10 +94809,31 @@ } }, "title": "owner", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_name", + "account_holder_type", + "address_city", + "address_country", + "address_line1", + "address_line2", + "address_state", + "address_zip", + "exp_month", + "exp_year", + "metadata", + "name", + "owner" + ] } } }, @@ -85878,7 +94931,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amounts" + ] } } }, @@ -86025,6 +95081,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -86169,7 +95231,11 @@ "type", "value" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] } } }, @@ -86380,7 +95446,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -86502,6 +95574,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -86754,7 +95832,45 @@ } }, "title": "dispute_evidence_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "access_activity_log", + "billing_address", + "booking", + "cancellation_policy", + "cancellation_policy_disclosure", + "cancellation_rebuttal", + "credit_voucher", + "customer_communication", + "customer_email_address", + "customer_name", + "customer_purchase_ip", + "customer_signature", + "duplicate_charge_documentation", + "duplicate_charge_explanation", + "duplicate_charge_id", + "enhanced_evidence", + "event_details", + "government_order", + "narrative", + "prior_undisputed_payments", + "product_description", + "product_service_ad", + "receipt", + "refund_policy", + "refund_policy_disclosure", + "refund_refusal_explanation", + "service_date", + "service_documentation", + "shipping_address", + "shipping_carrier", + "shipping_date", + "shipping_documentation", + "shipping_tracking_number", + "terms_disclosure", + "uncategorized_file", + "uncategorized_text" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -86786,7 +95902,12 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "evidence", + "metadata", + "submit" + ] } } }, @@ -87000,6 +96121,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -87216,6 +96343,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -87283,7 +96416,12 @@ "lookup_key", "name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "lookup_key", + "metadata", + "name" + ] } } }, @@ -87447,7 +96585,11 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "name" + ] } } }, @@ -87522,7 +96664,13 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "issuing_card", + "nonce", + "verification_session" + ] } } }, @@ -87652,7 +96800,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -87799,6 +96953,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -87993,6 +97153,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -88113,7 +97279,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -88244,6 +97416,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -88295,7 +97473,7 @@ "type": "integer" }, "file": { - "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.", + "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.", "maxLength": 5000, "type": "string" }, @@ -88320,7 +97498,12 @@ "required": [ "file" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_at", + "file", + "metadata" + ] } } }, @@ -88498,7 +97681,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_at", + "metadata" + ] } } }, @@ -88561,7 +97748,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -88623,6 +97816,7 @@ "finance_report_run", "identity_document", "identity_document_downloadable", + "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", @@ -88701,6 +97895,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -88755,7 +97955,7 @@ "description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.", "properties": { "create": { - "description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.", + "description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.", "type": "boolean" }, "expires_at": { @@ -88785,7 +97985,12 @@ "create" ], "title": "file_link_creation_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "create", + "expires_at", + "metadata" + ] }, "purpose": { "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.", @@ -88797,6 +98002,7 @@ "customer_signature", "dispute_evidence", "identity_document", + "issuing_regulatory_reporting", "pci_document", "tax_document_user_upload", "terminal_reader_splashscreen" @@ -88809,7 +98015,11 @@ "file", "purpose" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "file", + "purpose" + ] } } }, @@ -88937,7 +98147,11 @@ } }, "title": "accountholder_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer" + ] }, "style": "deepObject" }, @@ -89055,6 +98269,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -89337,6 +98557,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -89413,7 +98639,10 @@ "required": [ "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features" + ] } } }, @@ -89498,7 +98727,10 @@ "required": [ "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features" + ] } } }, @@ -89583,7 +98815,10 @@ "required": [ "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features" + ] } } }, @@ -89671,7 +98906,12 @@ "type" ], "title": "accountholder_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer", + "type" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -89708,7 +98948,12 @@ } }, "title": "filters_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "countries", + "institution" + ] }, "permissions": { "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.", @@ -89748,7 +98993,14 @@ "account_holder", "permissions" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder", + "filters", + "permissions", + "prefetch", + "return_url" + ] } } }, @@ -89937,7 +99189,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -89964,7 +99222,10 @@ "after" ], "title": "transaction_refresh_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after" + ] }, "style": "deepObject" } @@ -90024,6 +99285,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -90142,7 +99409,13 @@ } }, "title": "created_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, "style": "deepObject" }, @@ -90247,6 +99520,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -90342,13 +99621,21 @@ "value" ], "title": "header_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" } }, "title": "request_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "body", + "headers" + ] }, "url": { "description": "The destination URL for the forwarded request. Must be supported by the config.", @@ -90361,7 +99648,13 @@ "replacements", "url" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method", + "replacements", + "request", + "url" + ] } } }, @@ -90503,7 +99796,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -90640,6 +99939,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -90771,7 +100076,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -90908,6 +100219,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -91006,7 +100323,13 @@ } }, "title": "document_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_types", + "require_id_number", + "require_live_capture", + "require_matching_selfie" + ] }, { "enum": [ @@ -91019,7 +100342,16 @@ } }, "title": "session_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document", + "duplicate", + "email", + "matching", + "phone", + "phone_otp", + "phone_records" + ] }, "provided_details": { "description": "Details provided about the user being verified. These details may be shown to the user.", @@ -91034,7 +100366,14 @@ } }, "title": "provided_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "name", + "phone" + ] }, "related_customer": { "description": "Token referencing a Customer resource.", @@ -91060,7 +100399,17 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "client_reference_id", + "metadata", + "options", + "provided_details", + "related_customer", + "return_url", + "type", + "verification_flow" + ] } } }, @@ -91244,7 +100593,13 @@ } }, "title": "document_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_types", + "require_id_number", + "require_live_capture", + "require_matching_selfie" + ] }, { "enum": [ @@ -91257,7 +100612,16 @@ } }, "title": "session_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document", + "duplicate", + "email", + "matching", + "phone", + "phone_otp", + "phone_records" + ] }, "provided_details": { "description": "Details provided about the user being verified. These details may be shown to the user.", @@ -91272,7 +100636,14 @@ } }, "title": "provided_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "name", + "phone" + ] }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", @@ -91284,7 +100655,13 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "options", + "provided_details", + "type" + ] } } }, @@ -91448,59 +100825,421 @@ } } }, - "/v1/invoiceitems": { + "/v1/invoice_rendering_templates": { "get": { - "description": "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

", - "operationId": "GetInvoiceitems", + "description": "

List all templates, ordered by creation date, with the most recently created template appearing first.

", + "operationId": "GetInvoiceRenderingTemplates", "parameters": [ - { - "description": "Only return invoice items that were created during the given date interval.", - "explode": true, - "in": "query", - "name": "created", - "required": false, - "schema": { - "anyOf": [ - { - "properties": { - "gt": { - "description": "Minimum value to filter by (exclusive)", - "type": "integer" - }, - "gte": { - "description": "Minimum value to filter by (inclusive)", - "type": "integer" - }, - "lt": { - "description": "Maximum value to filter by (exclusive)", - "type": "integer" - }, - "lte": { - "description": "Maximum value to filter by (inclusive)", - "type": "integer" - } - }, - "title": "range_query_specs", - "type": "object" - }, - { - "type": "integer" - } - ] - }, - "style": "deepObject" - }, - { - "description": "The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.", - "in": "query", - "name": "customer", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "archived" + ], + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "description": "Details about each object.", + "items": { + "$ref": "#/components/schemas/invoice_rendering_template" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "InvoiceRenderingTemplatesList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoice_rendering_templates/{template}": { + "get": { + "description": "

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

", + "operationId": "GetInvoiceRenderingTemplatesTemplate", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "template", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice_rendering_template" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoice_rendering_templates/{template}/archive": { + "post": { + "description": "

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

", + "operationId": "PostInvoiceRenderingTemplatesTemplateArchive", + "parameters": [ + { + "in": "path", + "name": "template", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice_rendering_template" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoice_rendering_templates/{template}/unarchive": { + "post": { + "description": "

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

", + "operationId": "PostInvoiceRenderingTemplatesTemplateUnarchive", + "parameters": [ + { + "in": "path", + "name": "template", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice_rendering_template" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoiceitems": { + "get": { + "description": "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

", + "operationId": "GetInvoiceitems", + "parameters": [ + { + "description": "Only return invoice items that were created during the given date interval.", + "explode": true, + "in": "query", + "name": "created", + "required": false, + "schema": { + "anyOf": [ + { + "properties": { + "gt": { + "description": "Minimum value to filter by (exclusive)", + "type": "integer" + }, + "gte": { + "description": "Minimum value to filter by (inclusive)", + "type": "integer" + }, + "lt": { + "description": "Maximum value to filter by (exclusive)", + "type": "integer" + }, + "lte": { + "description": "Maximum value to filter by (inclusive)", + "type": "integer" + } + }, + "title": "range_query_specs", + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] + }, + { + "type": "integer" + } + ] + }, + "style": "deepObject" + }, + { + "description": "The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.", + "in": "query", + "name": "customer", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", "in": "query", @@ -91624,6 +101363,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -91725,7 +101470,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -91787,7 +101535,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -91830,7 +101582,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -91885,7 +101642,16 @@ "required": [ "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "metadata", + "period", + "price" + ] } } }, @@ -92119,7 +101885,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -92176,7 +101945,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -92219,7 +101992,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -92276,7 +102054,14 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "metadata", + "period", + "price" + ] } } }, @@ -92353,7 +102138,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -92400,7 +102191,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -92540,6 +102337,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -92678,14 +102481,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.", @@ -92720,7 +102531,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -92787,7 +102602,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -92845,7 +102663,11 @@ "invoice" ], "title": "from_invoice", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "action", + "invoice" + ] }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", @@ -92867,7 +102689,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "anyOf": [ @@ -92933,7 +102759,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -92947,7 +102776,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -92974,7 +102807,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -93024,7 +102860,12 @@ "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -93037,7 +102878,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", @@ -93050,7 +102895,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "request_three_d_secure" + ] }, { "enum": [ @@ -93081,7 +102930,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", @@ -93089,7 +102941,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -93097,7 +102954,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -93129,7 +102990,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -93163,7 +103027,11 @@ } }, "title": "invoice_linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -93195,7 +103063,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -93209,7 +103082,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -93222,7 +103099,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -93276,7 +103163,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_mandate", + "payment_method_options", + "payment_method_types" + ] }, "pending_invoice_items_behavior": { "description": "How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.", @@ -93313,11 +103205,42 @@ } }, "title": "rendering_pdf_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "page_size" + ] + }, + "template": { + "description": "ID of the invoice rendering template to use for this invoice.", + "maxLength": 5000, + "type": "string" + }, + "template_version": { + "anyOf": [ + { + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The specific version of invoice rendering template to use for this invoice." } }, "title": "rendering_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "custom_text", + "invoice_title", + "pdf", + "summary_items_data", + "template", + "template_version" + ] }, "shipping_cost": { "description": "Settings for the cost of shipping for this invoice.", @@ -93357,7 +103280,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -93383,11 +103310,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -93426,7 +103361,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -93437,7 +103376,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -93471,11 +103415,21 @@ "display_name" ], "title": "method_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } }, "title": "shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate", + "shipping_rate_data" + ] }, "shipping_details": { "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.", @@ -93515,7 +103469,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Recipient name.", @@ -93543,7 +103505,12 @@ "name" ], "title": "recipient_shipping_with_optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, "statement_descriptor": { "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.", @@ -93571,10 +103538,22 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "auto_advance", + "collection_method", + "customer", + "description", + "metadata", + "subscription" + ] } } }, @@ -93679,14 +103658,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "coupon": { "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", @@ -93741,7 +103728,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -93791,7 +103786,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -93809,7 +103812,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -93839,7 +103847,10 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -93947,13 +103958,24 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" } }, "title": "customer_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "shipping", + "tax", + "tax_exempt", + "tax_ids" + ] }, "discounts": { "anyOf": [ @@ -93977,7 +103999,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -93999,7 +104024,7 @@ "type": "array" }, "invoice_items": { - "description": "List of invoice items to add or update in the upcoming invoice preview.", + "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "items": { "properties": { "amount": { @@ -94041,7 +104066,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94095,7 +104123,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -94138,7 +104170,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -94196,7 +104233,24 @@ } }, "title": "invoice_item_preview_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "discountable", + "discounts", + "invoiceitem", + "metadata", + "period", + "price", + "quantity", + "tax_behavior", + "tax_code", + "tax_rates", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -94220,7 +104274,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "on_behalf_of": { "anyOf": [ @@ -94289,7 +104347,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94334,7 +104395,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -94361,6 +104427,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -94398,14 +104468,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -94429,7 +104507,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -94517,7 +104599,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94591,11 +104676,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -94614,7 +104713,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -94647,7 +104749,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94711,7 +104816,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -94738,7 +104846,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -94764,7 +104878,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -94824,7 +104948,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -94851,7 +104979,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -94866,7 +105023,15 @@ } }, "title": "schedule_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amendments", + "billing_behavior", + "end_behavior", + "phases", + "prebilling", + "proration_behavior" + ] }, "subscription": { "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.", @@ -94951,7 +105116,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -94992,7 +105160,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -95071,7 +105242,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -95098,7 +105272,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -95124,7 +105304,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -95173,10 +105365,28 @@ } }, "title": "subscription_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "cancel_at", + "cancel_at_period_end", + "cancel_now", + "default_tax_rates", + "items", + "prebilling", + "proration_behavior", + "proration_date", + "resume_at", + "start_date", + "trial_end" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "subscription" + ] } } }, @@ -95320,6 +105530,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -95376,14 +105594,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "style": "deepObject" }, @@ -95463,7 +105689,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -95513,7 +105747,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -95531,7 +105773,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -95561,7 +105808,10 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -95669,13 +105919,24 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" } }, "title": "customer_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "shipping", + "tax", + "tax_exempt", + "tax_ids" + ] }, "style": "deepObject" }, @@ -95707,7 +105968,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -95737,7 +106001,7 @@ "style": "deepObject" }, { - "description": "List of invoice items to add or update in the upcoming invoice preview.", + "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "explode": true, "in": "query", "name": "invoice_items", @@ -95784,7 +106048,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -95838,7 +106105,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -95881,7 +106152,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -95939,7 +106215,24 @@ } }, "title": "invoice_item_preview_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "discountable", + "discounts", + "invoiceitem", + "metadata", + "period", + "price", + "quantity", + "tax_behavior", + "tax_code", + "tax_rates", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -95970,7 +106263,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "style": "deepObject" }, @@ -96065,7 +106362,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -96110,7 +106410,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -96137,6 +106442,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -96174,14 +106483,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -96205,7 +106522,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -96293,7 +106614,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -96367,11 +106691,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -96390,7 +106728,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -96423,7 +106764,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -96487,7 +106831,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -96514,7 +106861,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -96540,7 +106893,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -96600,7 +106963,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -96627,7 +106994,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -96642,7 +107038,15 @@ } }, "title": "schedule_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amendments", + "billing_behavior", + "end_behavior", + "phases", + "prebilling", + "proration_behavior" + ] }, "style": "deepObject" }, @@ -96831,7 +107235,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -96872,7 +107279,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -96951,7 +107361,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -96978,7 +107391,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -97004,7 +107423,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -97053,7 +107484,21 @@ } }, "title": "subscription_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "cancel_at", + "cancel_at_period_end", + "cancel_now", + "default_tax_rates", + "items", + "prebilling", + "proration_behavior", + "proration_date", + "resume_at", + "start_date", + "trial_end" + ] }, "style": "deepObject" }, @@ -97079,7 +107524,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -97120,7 +107568,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -97199,7 +107650,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -97226,7 +107680,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -97252,7 +107712,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -97417,14 +107889,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "style": "deepObject" }, @@ -97504,7 +107984,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -97554,7 +108042,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -97572,7 +108068,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -97602,7 +108103,10 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -97710,13 +108214,24 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" } }, "title": "customer_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "shipping", + "tax", + "tax_exempt", + "tax_ids" + ] }, "style": "deepObject" }, @@ -97748,7 +108263,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -97789,7 +108307,7 @@ "style": "deepObject" }, { - "description": "List of invoice items to add or update in the upcoming invoice preview.", + "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "explode": true, "in": "query", "name": "invoice_items", @@ -97836,7 +108354,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -97890,7 +108411,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -97933,7 +108458,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -97991,7 +108521,24 @@ } }, "title": "invoice_item_preview_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "discountable", + "discounts", + "invoiceitem", + "metadata", + "period", + "price", + "quantity", + "tax_behavior", + "tax_code", + "tax_rates", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -98022,7 +108569,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "style": "deepObject" }, @@ -98127,7 +108678,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -98172,7 +108726,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -98199,6 +108758,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -98236,14 +108799,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -98267,7 +108838,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -98355,7 +108930,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -98429,11 +109007,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -98452,7 +109044,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -98485,7 +109080,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -98549,7 +109147,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -98576,7 +109177,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -98602,7 +109209,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -98662,7 +109279,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -98689,7 +109310,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -98704,7 +109354,15 @@ } }, "title": "schedule_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amendments", + "billing_behavior", + "end_behavior", + "phases", + "prebilling", + "proration_behavior" + ] }, "style": "deepObject" }, @@ -98904,7 +109562,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -98945,7 +109606,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -99024,7 +109688,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -99051,7 +109718,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -99077,7 +109750,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -99126,7 +109811,21 @@ } }, "title": "subscription_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "cancel_at", + "cancel_at_period_end", + "cancel_now", + "default_tax_rates", + "items", + "prebilling", + "proration_behavior", + "proration_date", + "resume_at", + "start_date", + "trial_end" + ] }, "style": "deepObject" }, @@ -99152,7 +109851,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -99193,7 +109895,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -99272,7 +109977,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -99299,7 +110007,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -99325,7 +110039,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -99470,6 +110196,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -99751,14 +110483,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "collection_method": { "description": "Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.", @@ -99789,7 +110529,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -99871,7 +110615,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -99937,7 +110684,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "anyOf": [ @@ -100023,7 +110774,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -100037,7 +110791,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -100064,7 +110822,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -100114,7 +110875,12 @@ "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -100127,7 +110893,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "request_three_d_secure": { "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", @@ -100140,7 +110910,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "request_three_d_secure" + ] }, { "enum": [ @@ -100171,7 +110945,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", @@ -100179,7 +110956,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -100187,7 +110969,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -100219,7 +111005,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -100253,7 +111042,11 @@ } }, "title": "invoice_linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -100285,7 +111078,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -100299,7 +111097,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -100312,7 +111114,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -100366,7 +111178,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_mandate", + "payment_method_options", + "payment_method_types" + ] }, "rendering": { "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", @@ -100394,11 +111211,42 @@ } }, "title": "rendering_pdf_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "page_size" + ] + }, + "template": { + "description": "ID of the invoice rendering template to use for this invoice.", + "maxLength": 5000, + "type": "string" + }, + "template_version": { + "anyOf": [ + { + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The specific version of invoice rendering template to use for this invoice." } }, "title": "rendering_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "custom_text", + "invoice_title", + "pdf", + "summary_items_data", + "template", + "template_version" + ] }, "shipping_cost": { "anyOf": [ @@ -100439,7 +111287,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -100465,11 +111317,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -100508,7 +111368,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -100519,7 +111383,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -100553,11 +111422,21 @@ "display_name" ], "title": "method_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } }, "title": "shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate", + "shipping_rate_data" + ] }, { "enum": [ @@ -100607,7 +111486,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Recipient name.", @@ -100635,7 +111522,12 @@ "name" ], "title": "recipient_shipping_with_optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -100668,7 +111560,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, { "enum": [ @@ -100680,7 +111576,13 @@ "description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "auto_advance", + "collection_method", + "description", + "metadata" + ] } } }, @@ -100810,7 +111712,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -100864,7 +111769,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -100920,7 +111829,14 @@ "name" ], "title": "product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -100945,7 +111861,12 @@ "currency" ], "title": "one_time_price_data_with_product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", @@ -101022,7 +111943,17 @@ "percentage" ], "title": "tax_rate_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "percentage", + "state", + "tax_type" + ] }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", @@ -101035,7 +111966,12 @@ "taxable_amount" ], "title": "tax_amount_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate_data", + "taxable_amount" + ] }, "type": "array" }, @@ -101068,7 +112004,16 @@ } }, "title": "lines_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_item", + "metadata", + "period", + "price", + "quantity" + ] }, "type": "array" } @@ -101076,7 +112021,11 @@ "required": [ "lines" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice_metadata", + "lines" + ] } } }, @@ -101147,7 +112096,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "auto_advance" + ] } } }, @@ -101294,6 +112246,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -101412,7 +112370,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -101469,7 +112430,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -101525,7 +112490,14 @@ "name" ], "title": "product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -101550,7 +112522,12 @@ "currency" ], "title": "one_time_price_data_with_product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", @@ -101627,7 +112604,17 @@ "percentage" ], "title": "tax_rate_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "percentage", + "state", + "tax_type" + ] }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", @@ -101640,7 +112627,12 @@ "taxable_amount" ], "title": "tax_amount_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate_data", + "taxable_amount" + ] }, "type": "array" }, @@ -101672,7 +112664,15 @@ "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "metadata", + "period", + "price", + "quantity" + ] } } }, @@ -101961,7 +112961,11 @@ "id" ], "title": "lines_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "behavior", + "id" + ] }, "type": "array" } @@ -101969,7 +112973,11 @@ "required": [ "lines" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice_metadata", + "lines" + ] } } }, @@ -102166,7 +113174,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -102220,7 +113231,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -102276,7 +113291,14 @@ "name" ], "title": "product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -102301,7 +113323,12 @@ "currency" ], "title": "one_time_price_data_with_product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", @@ -102378,7 +113405,17 @@ "percentage" ], "title": "tax_rate_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "percentage", + "state", + "tax_type" + ] }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", @@ -102391,7 +113428,12 @@ "taxable_amount" ], "title": "tax_amount_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate_data", + "taxable_amount" + ] }, "type": "array" }, @@ -102427,7 +113469,16 @@ "id" ], "title": "lines_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "id", + "metadata", + "period", + "price", + "quantity" + ] }, "type": "array" } @@ -102435,7 +113486,11 @@ "required": [ "lines" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice_metadata", + "lines" + ] } } }, @@ -102587,7 +113642,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -102713,6 +113774,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -102856,7 +113923,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -102949,7 +114019,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "metadata" + ] } } }, @@ -103038,7 +114112,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -103101,7 +114178,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -103262,6 +114345,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -103363,14 +114452,25 @@ "postal_code" ], "title": "required_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] } }, "required": [ "address" ], "title": "billing_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address" + ] }, "company": { "description": "Additional information about a `company` cardholder.", @@ -103382,7 +114482,10 @@ } }, "title": "company_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "email": { "description": "The cardholder's email address.", @@ -103431,11 +114534,19 @@ } }, "title": "terms_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "card_issuing_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "user_terms_acceptance" + ] }, "dob": { "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.", @@ -103459,7 +114570,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "first_name": { "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", @@ -103487,15 +114603,30 @@ } }, "title": "person_verification_document_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "individual_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "dob", + "first_name", + "last_name", + "user_terms_acceptance", + "verification" + ] }, "metadata": { "additionalProperties": { @@ -104486,7 +115617,12 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" }, @@ -104496,7 +115632,17 @@ } }, "title": "authorization_controls_param_v2", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_network_ids", + "spending_limits", + "spending_limits_currency" + ] }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.", @@ -104520,7 +115666,14 @@ "billing", "name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing", + "email", + "metadata", + "name", + "phone_number" + ] } } }, @@ -104712,14 +115865,25 @@ "postal_code" ], "title": "required_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] } }, "required": [ "address" ], "title": "billing_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address" + ] }, "company": { "description": "Additional information about a `company` cardholder.", @@ -104731,7 +115895,10 @@ } }, "title": "company_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "email": { "description": "The cardholder's email address.", @@ -104780,11 +115947,19 @@ } }, "title": "terms_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "card_issuing_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "user_terms_acceptance" + ] }, "dob": { "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.", @@ -104808,7 +115983,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "first_name": { "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.", @@ -104836,15 +116016,30 @@ } }, "title": "person_verification_document_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "individual_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "dob", + "first_name", + "last_name", + "user_terms_acceptance", + "verification" + ] }, "metadata": { "additionalProperties": { @@ -105831,7 +117026,12 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" }, @@ -105841,7 +117041,17 @@ } }, "title": "authorization_controls_param_v2", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_network_ids", + "spending_limits", + "spending_limits_currency" + ] }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards.", @@ -105852,7 +117062,13 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing", + "email", + "metadata", + "phone_number" + ] } } }, @@ -105926,7 +117142,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -106108,6 +117330,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -106203,7 +117431,10 @@ } }, "title": "encrypted_pin_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "encrypted_number" + ] }, "replacement_for": { "description": "The card this is meant to be a replacement for (if any).", @@ -106280,7 +117511,15 @@ "postal_code" ], "title": "required_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_validation": { "description": "Address validation settings.", @@ -106299,7 +117538,10 @@ "mode" ], "title": "address_validation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mode" + ] }, "customs": { "description": "Customs information for the shipment.", @@ -106311,7 +117553,10 @@ } }, "title": "customs_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eori_number" + ] }, "name": { "description": "The name printed on the shipping label when shipping the card.", @@ -106350,7 +117595,18 @@ "name" ], "title": "shipping_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_validation", + "customs", + "name", + "phone_number", + "require_signature", + "service", + "speed", + "type" + ] }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", @@ -107312,13 +118568,30 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" } }, "title": "authorization_controls_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_currencies", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_currencies", + "blocked_merchant_network_ids", + "max_approvals", + "spending_limits" + ] }, "status": { "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.", @@ -107341,7 +118614,14 @@ "currency", "type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cardholder", + "currency", + "metadata", + "status", + "type" + ] } } }, @@ -107529,7 +118809,10 @@ } }, "title": "encrypted_pin_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "encrypted_number" + ] }, "shipping": { "description": "Updated shipping information for the card.", @@ -107575,7 +118858,15 @@ "postal_code" ], "title": "required_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_validation": { "description": "Address validation settings.", @@ -107594,7 +118885,10 @@ "mode" ], "title": "address_validation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mode" + ] }, "customs": { "description": "Customs information for the shipment.", @@ -107606,7 +118900,10 @@ } }, "title": "customs_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eori_number" + ] }, "name": { "description": "The name printed on the shipping label when shipping the card.", @@ -107645,7 +118942,18 @@ "name" ], "title": "shipping_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_validation", + "customs", + "name", + "phone_number", + "require_signature", + "service", + "speed", + "type" + ] }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", @@ -108607,13 +119915,30 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" } }, "title": "authorization_controls_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_currencies", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_currencies", + "blocked_merchant_network_ids", + "max_approvals", + "spending_limits" + ] }, "status": { "description": "Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.", @@ -108626,7 +119951,12 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason", + "metadata", + "status" + ] } } }, @@ -108689,7 +120019,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -108828,6 +120164,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -109022,7 +120364,19 @@ } }, "title": "canceled", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_policy_provided", + "cancellation_reason", + "expected_at", + "explanation", + "product_description", + "product_type", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -109115,7 +120469,15 @@ } }, "title": "duplicate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "card_statement", + "cash_receipt", + "check_image", + "explanation", + "original_transaction" + ] }, { "enum": [ @@ -109161,7 +120523,11 @@ } }, "title": "fraudulent", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -109261,7 +120627,15 @@ } }, "title": "merchandise_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "received_at", + "return_description", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -109307,7 +120681,11 @@ } }, "title": "no_valid_authorization", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -109392,7 +120770,14 @@ } }, "title": "not_received", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "expected_at", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -109462,7 +120847,13 @@ } }, "title": "other", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -109568,7 +120959,14 @@ } }, "title": "service_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_reason", + "explanation", + "received_at" + ] }, { "enum": [ @@ -109581,7 +120979,18 @@ } }, "title": "evidence_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "no_valid_authorization", + "not_received", + "other", + "reason", + "service_not_as_described" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -109616,10 +121025,18 @@ "received_debit" ], "title": "treasury_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "received_debit" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "evidence", + "metadata", + "transaction" + ] } } }, @@ -109900,7 +121317,19 @@ } }, "title": "canceled", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_policy_provided", + "cancellation_reason", + "expected_at", + "explanation", + "product_description", + "product_type", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -109993,7 +121422,15 @@ } }, "title": "duplicate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "card_statement", + "cash_receipt", + "check_image", + "explanation", + "original_transaction" + ] }, { "enum": [ @@ -110039,7 +121476,11 @@ } }, "title": "fraudulent", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -110139,7 +121580,15 @@ } }, "title": "merchandise_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "received_at", + "return_description", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -110185,7 +121634,11 @@ } }, "title": "no_valid_authorization", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -110270,7 +121723,14 @@ } }, "title": "not_received", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "expected_at", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -110340,7 +121800,13 @@ } }, "title": "other", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -110446,7 +121912,14 @@ } }, "title": "service_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_reason", + "explanation", + "received_at" + ] }, { "enum": [ @@ -110459,7 +121932,18 @@ } }, "title": "evidence_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "no_valid_authorization", + "not_received", + "other", + "reason", + "service_not_as_described" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -110487,7 +121971,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "evidence", + "metadata" + ] } } }, @@ -110575,7 +122063,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -110679,7 +122170,11 @@ } }, "title": "preferences_list_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "is_default", + "is_platform_default" + ] }, "style": "deepObject" }, @@ -110765,6 +122260,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -110879,7 +122380,13 @@ } }, "title": "carrier_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "footer_body", + "footer_title", + "header_body", + "header_title" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -110923,7 +122430,10 @@ "is_default" ], "title": "preferences_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "is_default" + ] }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", @@ -110933,7 +122443,17 @@ "required": [ "physical_bundle" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_logo", + "carrier_text", + "lookup_key", + "metadata", + "name", + "physical_bundle", + "preferences", + "transfer_lookup_key" + ] } } }, @@ -111161,7 +122681,13 @@ } }, "title": "carrier_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "footer_body", + "footer_title", + "header_body", + "header_title" + ] }, { "enum": [ @@ -111234,14 +122760,27 @@ "is_default" ], "title": "preferences_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "is_default" + ] }, "transfer_lookup_key": { "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_logo", + "carrier_text", + "lookup_key", + "metadata", + "name", + "physical_bundle", + "preferences", + "transfer_lookup_key" + ] } } }, @@ -111407,6 +122946,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -111538,7 +123083,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -111664,6 +123215,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -111798,7 +123355,10 @@ "required": [ "status" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "status" + ] } } }, @@ -111883,7 +123443,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -112008,6 +123574,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -112151,7 +123723,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -112281,7 +123856,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -112403,6 +123984,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -112504,7 +124091,11 @@ "enabled" ], "title": "automatic_payment_methods_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redirects", + "enabled" + ] }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", @@ -112599,7 +124190,11 @@ "user_agent" ], "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", @@ -112615,14 +124210,23 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" + ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ] }, { "enum": [ @@ -112698,7 +124302,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -112752,7 +124361,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -112769,7 +124382,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -112816,7 +124433,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -112873,7 +124498,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -112894,7 +124525,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -112948,7 +124582,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -112997,7 +124634,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -113039,13 +124680,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -113072,11 +124722,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -113153,7 +124811,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -113171,7 +124832,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -113189,7 +124853,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -113210,7 +124878,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -113232,7 +124903,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -113325,7 +124999,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -113344,7 +125025,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", @@ -113394,7 +125080,13 @@ } }, "title": "payment_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -113418,7 +125110,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -113455,7 +125152,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "purchase_details", + "setup_future_usage" + ] }, { "enum": [ @@ -113493,7 +125196,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -113519,7 +125227,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -113553,7 +125264,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "charge_metadata", + "charge_permission_id", + "setup_future_usage" + ] }, { "enum": [ @@ -113580,7 +125297,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -113599,7 +125319,10 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -113613,7 +125336,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date" + ] }, { "enum": [ @@ -113649,7 +125377,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -113680,7 +125412,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code", + "mandate_options", + "setup_future_usage" + ] }, { "enum": [ @@ -113711,7 +125448,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -113774,7 +125515,12 @@ "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -113787,7 +125533,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", @@ -113858,7 +125608,18 @@ "start_date" ], "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "moto": { "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", @@ -114043,11 +125804,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", @@ -114076,11 +125845,56 @@ "version" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_indicator", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "payment_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_partial_amount", + "buy_now_pay_later_options", + "capture_method", + "cvc_token", + "installments", + "mandate_options", + "mcc", + "mit_exemption", + "moto", + "network", + "network_options", + "network_token", + "off_session_usage", + "recipient_details", + "request_decremental_authorization", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_multicapture", + "request_overcapture", + "request_partial_authorization", + "request_three_d_secure", + "require_cvc_recollection", + "sender_details", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji", + "statement_details", + "stored_credential_transaction_type", + "stored_credential_usage", + "three_d_secure", + "transaction_purpose" + ] }, { "enum": [ @@ -114116,11 +125930,24 @@ } }, "title": "routing_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested_priority" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "buy_now_pay_later_options", + "capture_method", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_partial_authorization", + "routing" + ] }, { "enum": [ @@ -114155,7 +125982,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "restricted_transaction_categories", + "setup_future_usage" + ] }, { "enum": [ @@ -114186,7 +126018,10 @@ "country" ], "title": "eu_bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", @@ -114222,7 +126057,14 @@ "type" ], "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_account", + "id_bank_transfer", + "requested_address_types", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -114240,7 +126082,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" + ] }, { "enum": [ @@ -114264,7 +126111,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114288,7 +126138,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114312,7 +126165,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114336,7 +126192,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114362,7 +126221,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114464,7 +126326,15 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "line_items", + "payment_details", + "payment_method_category", + "preferred_locale", + "setup_future_usage" + ] }, { "enum": [ @@ -114547,7 +126417,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "confirmation_number", + "expires_after_days", + "expires_at", + "fee_amount", + "product_description", + "setup_future_usage", + "tax_amount" + ] }, { "enum": [ @@ -114586,7 +126465,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "persistent_token", + "request_multicapture", + "setup_future_usage" + ] }, { "enum": [ @@ -114618,7 +126503,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -114642,7 +126532,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114670,7 +126563,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -114698,7 +126595,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "setup_future_usage", + "tos_shown_and_accepted" + ] }, { "enum": [ @@ -114722,7 +126624,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114794,7 +126699,18 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_delayed_notification", + "capture_method", + "line_items", + "preferred_locale", + "reference", + "reference_id", + "risk_correlation_id", + "setup_future_usage", + "subsellers" + ] }, { "enum": [ @@ -114827,7 +126743,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_seconds", + "expires_at", + "setup_future_usage" + ] }, { "enum": [ @@ -114851,7 +126772,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114885,7 +126809,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, { "enum": [ @@ -114904,7 +126832,11 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -114918,7 +126850,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date", + "verification_method" + ] }, { "enum": [ @@ -114958,7 +126896,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -114997,7 +126939,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorization_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -115021,7 +126968,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -115056,7 +127006,11 @@ } }, "title": "linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -115093,7 +127047,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -115109,7 +127070,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -115127,7 +127091,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", @@ -115160,7 +127127,15 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "preferred_settlement_speed", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -115202,7 +127177,12 @@ "client" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] }, { "enum": [ @@ -115226,7 +127206,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -115239,7 +127222,71 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "alma", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "boleto_pilot", + "card", + "card_present", + "cashapp", + "customer_balance", + "demo_pay", + "dummy_auth_push", + "dummy_passthrough_card", + "eps", + "fpx", + "giropay", + "gopay", + "grabpay", + "id_bank_transfer", + "ideal", + "interac_present", + "kakao_pay", + "klarna", + "knet", + "konbini", + "kr_card", + "kr_market", + "link", + "mb_way", + "mobilepay", + "multibanco", + "naver_pay", + "ng_card", + "ng_market", + "oxxo", + "p24", + "pay_by_bank", + "payco", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "qris", + "rechnung", + "revolut_pay", + "samsung_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "upi", + "us_bank_account", + "vipps", + "wechat_pay", + "zip" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to [\"card\"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", @@ -115259,7 +127306,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "receipt_email": { "description": "Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).", @@ -115315,7 +127366,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -115343,7 +127402,14 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "statement_descriptor": { "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.", @@ -115371,7 +127437,11 @@ "destination" ], "title": "transfer_data_creation_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).", @@ -115386,7 +127456,23 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "automatic_payment_methods", + "confirm", + "currency", + "customer", + "description", + "metadata", + "off_session", + "payment_method", + "receipt_email", + "setup_future_usage", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -115530,6 +127616,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -115790,7 +127884,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -115844,7 +127943,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -115861,7 +127964,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -115908,7 +128015,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -115965,7 +128080,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -115986,7 +128107,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -116040,7 +128164,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -116089,7 +128216,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -116131,13 +128262,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -116164,11 +128304,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -116245,7 +128393,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -116263,7 +128414,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -116281,7 +128435,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -116302,7 +128460,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -116324,7 +128485,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -116417,7 +128581,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -116436,7 +128607,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment-method-specific configuration for this PaymentIntent.", @@ -116486,7 +128662,13 @@ } }, "title": "payment_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -116510,7 +128692,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -116547,7 +128734,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "purchase_details", + "setup_future_usage" + ] }, { "enum": [ @@ -116585,7 +128778,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -116611,7 +128809,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -116645,7 +128846,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "charge_metadata", + "charge_permission_id", + "setup_future_usage" + ] }, { "enum": [ @@ -116672,7 +128879,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -116691,7 +128901,10 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -116705,7 +128918,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date" + ] }, { "enum": [ @@ -116741,7 +128959,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -116772,7 +128994,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code", + "mandate_options", + "setup_future_usage" + ] }, { "enum": [ @@ -116803,7 +129030,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -116866,7 +129097,12 @@ "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -116879,7 +129115,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", @@ -116950,7 +129190,18 @@ "start_date" ], "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "moto": { "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", @@ -117135,11 +129386,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", @@ -117168,11 +129427,56 @@ "version" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_indicator", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "payment_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_partial_amount", + "buy_now_pay_later_options", + "capture_method", + "cvc_token", + "installments", + "mandate_options", + "mcc", + "mit_exemption", + "moto", + "network", + "network_options", + "network_token", + "off_session_usage", + "recipient_details", + "request_decremental_authorization", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_multicapture", + "request_overcapture", + "request_partial_authorization", + "request_three_d_secure", + "require_cvc_recollection", + "sender_details", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji", + "statement_details", + "stored_credential_transaction_type", + "stored_credential_usage", + "three_d_secure", + "transaction_purpose" + ] }, { "enum": [ @@ -117208,11 +129512,24 @@ } }, "title": "routing_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested_priority" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "buy_now_pay_later_options", + "capture_method", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_partial_authorization", + "routing" + ] }, { "enum": [ @@ -117247,7 +129564,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "restricted_transaction_categories", + "setup_future_usage" + ] }, { "enum": [ @@ -117278,7 +129600,10 @@ "country" ], "title": "eu_bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", @@ -117314,7 +129639,14 @@ "type" ], "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_account", + "id_bank_transfer", + "requested_address_types", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -117332,7 +129664,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" + ] }, { "enum": [ @@ -117356,7 +129693,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117380,7 +129720,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117404,7 +129747,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117428,7 +129774,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117454,7 +129803,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117556,7 +129908,15 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "line_items", + "payment_details", + "payment_method_category", + "preferred_locale", + "setup_future_usage" + ] }, { "enum": [ @@ -117639,7 +129999,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "confirmation_number", + "expires_after_days", + "expires_at", + "fee_amount", + "product_description", + "setup_future_usage", + "tax_amount" + ] }, { "enum": [ @@ -117678,7 +130047,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "persistent_token", + "request_multicapture", + "setup_future_usage" + ] }, { "enum": [ @@ -117710,7 +130085,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -117734,7 +130114,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117762,7 +130145,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -117790,7 +130177,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "setup_future_usage", + "tos_shown_and_accepted" + ] }, { "enum": [ @@ -117814,7 +130206,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117886,7 +130281,18 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_delayed_notification", + "capture_method", + "line_items", + "preferred_locale", + "reference", + "reference_id", + "risk_correlation_id", + "setup_future_usage", + "subsellers" + ] }, { "enum": [ @@ -117919,7 +130325,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_seconds", + "expires_at", + "setup_future_usage" + ] }, { "enum": [ @@ -117943,7 +130354,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -117977,7 +130391,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, { "enum": [ @@ -117996,7 +130414,11 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -118010,7 +130432,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date", + "verification_method" + ] }, { "enum": [ @@ -118050,7 +130478,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -118089,7 +130521,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorization_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -118113,7 +130550,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -118148,7 +130588,11 @@ } }, "title": "linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -118185,7 +130629,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -118201,7 +130652,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -118219,7 +130673,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", @@ -118252,7 +130709,15 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "preferred_settlement_speed", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -118294,7 +130759,12 @@ "client" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] }, { "enum": [ @@ -118318,7 +130788,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -118331,7 +130804,71 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "alma", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "boleto_pilot", + "card", + "card_present", + "cashapp", + "customer_balance", + "demo_pay", + "dummy_auth_push", + "dummy_passthrough_card", + "eps", + "fpx", + "giropay", + "gopay", + "grabpay", + "id_bank_transfer", + "ideal", + "interac_present", + "kakao_pay", + "klarna", + "knet", + "konbini", + "kr_card", + "kr_market", + "link", + "mb_way", + "mobilepay", + "multibanco", + "naver_pay", + "ng_card", + "ng_market", + "oxxo", + "p24", + "pay_by_bank", + "payco", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "qris", + "rechnung", + "revolut_pay", + "samsung_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "upi", + "us_bank_account", + "vipps", + "wechat_pay", + "zip" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", @@ -118403,7 +130940,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -118431,7 +130976,14 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, { "enum": [ @@ -118461,14 +131013,30 @@ } }, "title": "transfer_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount" + ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "metadata", + "payment_method", + "receipt_email", + "setup_future_usage", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -118543,7 +131111,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] } } }, @@ -118622,7 +131194,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason" + ] } } }, @@ -118744,10 +131319,17 @@ } }, "title": "transfer_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_to_capture", + "metadata" + ] } } }, @@ -118779,7 +131361,7 @@ }, "/v1/payment_intents/{intent}/confirm": { "post": { - "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.

", + "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.\nThere is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.

", "operationId": "PostPaymentIntentsIntentConfirm", "parameters": [ { @@ -118904,7 +131486,11 @@ "user_agent" ], "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", @@ -118920,14 +131506,23 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" + ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ] }, { "enum": [ @@ -118955,7 +131550,11 @@ } }, "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate.", @@ -118971,7 +131570,11 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "online", + "type" + ] } }, "required": [ @@ -118979,6 +131582,9 @@ ], "title": "client_key_param", "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ], "x-stripeParam": { "class_name": "MandateDataPublishableKey" } @@ -119034,7 +131640,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -119088,7 +131699,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -119105,7 +131720,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -119152,7 +131771,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -119209,7 +131836,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -119230,7 +131863,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -119284,7 +131920,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -119333,7 +131972,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -119375,13 +132018,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -119408,11 +132060,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -119489,7 +132149,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -119507,7 +132170,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -119525,7 +132191,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -119546,7 +132216,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -119568,7 +132241,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -119661,7 +132337,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -119680,7 +132363,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", @@ -119730,7 +132418,13 @@ } }, "title": "payment_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -119754,7 +132448,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -119791,7 +132490,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "purchase_details", + "setup_future_usage" + ] }, { "enum": [ @@ -119829,7 +132534,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -119855,7 +132565,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -119889,7 +132602,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "charge_metadata", + "charge_permission_id", + "setup_future_usage" + ] }, { "enum": [ @@ -119916,7 +132635,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -119935,7 +132657,10 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -119949,7 +132674,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date" + ] }, { "enum": [ @@ -119985,7 +132715,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -120016,7 +132750,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code", + "mandate_options", + "setup_future_usage" + ] }, { "enum": [ @@ -120047,7 +132786,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -120110,7 +132853,12 @@ "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -120123,7 +132871,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", @@ -120194,7 +132946,18 @@ "start_date" ], "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "moto": { "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", @@ -120379,11 +133142,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", @@ -120412,11 +133183,56 @@ "version" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_indicator", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "payment_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_partial_amount", + "buy_now_pay_later_options", + "capture_method", + "cvc_token", + "installments", + "mandate_options", + "mcc", + "mit_exemption", + "moto", + "network", + "network_options", + "network_token", + "off_session_usage", + "recipient_details", + "request_decremental_authorization", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_multicapture", + "request_overcapture", + "request_partial_authorization", + "request_three_d_secure", + "require_cvc_recollection", + "sender_details", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji", + "statement_details", + "stored_credential_transaction_type", + "stored_credential_usage", + "three_d_secure", + "transaction_purpose" + ] }, { "enum": [ @@ -120452,11 +133268,24 @@ } }, "title": "routing_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested_priority" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "buy_now_pay_later_options", + "capture_method", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_partial_authorization", + "routing" + ] }, { "enum": [ @@ -120491,7 +133320,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "restricted_transaction_categories", + "setup_future_usage" + ] }, { "enum": [ @@ -120522,7 +133356,10 @@ "country" ], "title": "eu_bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "requested_address_types": { "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", @@ -120558,7 +133395,14 @@ "type" ], "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_account", + "id_bank_transfer", + "requested_address_types", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -120576,7 +133420,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" + ] }, { "enum": [ @@ -120600,7 +133449,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -120624,7 +133476,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -120648,7 +133503,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -120672,7 +133530,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -120698,7 +133559,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -120800,7 +133664,15 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "line_items", + "payment_details", + "payment_method_category", + "preferred_locale", + "setup_future_usage" + ] }, { "enum": [ @@ -120883,7 +133755,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "confirmation_number", + "expires_after_days", + "expires_at", + "fee_amount", + "product_description", + "setup_future_usage", + "tax_amount" + ] }, { "enum": [ @@ -120922,7 +133803,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "persistent_token", + "request_multicapture", + "setup_future_usage" + ] }, { "enum": [ @@ -120954,7 +133841,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -120978,7 +133870,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -121006,7 +133901,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -121034,7 +133933,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "setup_future_usage", + "tos_shown_and_accepted" + ] }, { "enum": [ @@ -121058,7 +133962,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -121130,7 +134037,18 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_delayed_notification", + "capture_method", + "line_items", + "preferred_locale", + "reference", + "reference_id", + "risk_correlation_id", + "setup_future_usage", + "subsellers" + ] }, { "enum": [ @@ -121163,7 +134081,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_seconds", + "expires_at", + "setup_future_usage" + ] }, { "enum": [ @@ -121187,7 +134110,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -121221,7 +134147,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, { "enum": [ @@ -121240,7 +134170,11 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -121254,7 +134188,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date", + "verification_method" + ] }, { "enum": [ @@ -121294,7 +134234,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -121333,7 +134277,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorization_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -121357,7 +134306,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -121392,7 +134344,11 @@ } }, "title": "linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -121429,7 +134385,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -121445,7 +134408,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -121463,7 +134429,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", @@ -121496,7 +134465,15 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "preferred_settlement_speed", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -121538,7 +134515,12 @@ "client" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] }, { "enum": [ @@ -121562,7 +134544,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -121575,7 +134560,71 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "alma", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "boleto_pilot", + "card", + "card_present", + "cashapp", + "customer_balance", + "demo_pay", + "dummy_auth_push", + "dummy_passthrough_card", + "eps", + "fpx", + "giropay", + "gopay", + "grabpay", + "id_bank_transfer", + "ideal", + "interac_present", + "kakao_pay", + "klarna", + "knet", + "konbini", + "kr_card", + "kr_market", + "link", + "mb_way", + "mobilepay", + "multibanco", + "naver_pay", + "ng_card", + "ng_market", + "oxxo", + "p24", + "pay_by_bank", + "payco", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "qris", + "rechnung", + "revolut_pay", + "samsung_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "upi", + "us_bank_account", + "vipps", + "wechat_pay", + "zip" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", @@ -121595,7 +134644,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "receipt_email": { "anyOf": [ @@ -121663,7 +134716,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -121691,7 +134752,14 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, { "enum": [ @@ -121707,7 +134775,13 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method", + "receipt_email", + "setup_future_usage", + "shipping" + ] } } }, @@ -121815,13 +134889,22 @@ } }, "title": "transfer_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount" + ] } }, "required": [ "amount" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "metadata", + "statement_descriptor" + ] } } }, @@ -121904,7 +134987,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amounts", + "descriptor_code" + ] } } }, @@ -122051,6 +135138,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -122165,7 +135258,10 @@ } }, "title": "after_completion_confirmation_page_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_message" + ] }, "redirect": { "description": "Configuration when `type=redirect`.", @@ -122180,7 +135276,10 @@ "url" ], "title": "after_completion_redirect_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "url" + ] }, "type": { "description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.", @@ -122195,7 +135294,12 @@ "type" ], "title": "after_completion_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "hosted_confirmation", + "redirect", + "type" + ] }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", @@ -122236,14 +135340,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", @@ -122272,7 +135384,10 @@ "position" ], "title": "payment_method_reuse_agreement_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "position" + ] }, "promotions": { "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.", @@ -122292,7 +135407,12 @@ } }, "title": "consent_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_reuse_agreement", + "promotions", + "terms_of_service" + ] }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price.", @@ -122325,7 +135445,11 @@ "value" ], "title": "custom_field_option_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "label", + "value" + ] }, "type": "array" } @@ -122334,7 +135458,11 @@ "options" ], "title": "custom_field_dropdown_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "options" + ] }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", @@ -122362,7 +135490,11 @@ "type" ], "title": "custom_field_label_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom", + "type" + ] }, "numeric": { "description": "Configuration for `type=numeric` fields.", @@ -122377,7 +135509,12 @@ } }, "title": "custom_field_numeric_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", @@ -122396,7 +135533,12 @@ } }, "title": "custom_field_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "type": { "description": "The type of the field.", @@ -122414,7 +135556,16 @@ "type" ], "title": "custom_field_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dropdown", + "key", + "label", + "numeric", + "optional", + "text", + "type" + ] }, "type": "array" }, @@ -122435,7 +135586,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -122460,7 +135614,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -122485,7 +135642,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -122510,7 +135670,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -122523,7 +135686,13 @@ } }, "title": "custom_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after_submit", + "shipping_address", + "submit", + "terms_of_service_acceptance" + ] }, "customer_creation": { "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).", @@ -122595,7 +135764,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -122638,7 +135811,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "anyOf": [ @@ -122672,7 +135849,11 @@ } }, "title": "rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title" + ] }, { "enum": [ @@ -122685,14 +135866,27 @@ } }, "title": "invoice_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "metadata", + "rendering_options" + ] } }, "required": [ "enabled" ], "title": "invoice_creation_create_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "invoice_data" + ] }, "line_items": { "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", @@ -122718,7 +135912,12 @@ "enabled" ], "title": "adjustable_quantity_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "maximum", + "minimum" + ] }, "price": { "description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.", @@ -122735,7 +135934,12 @@ "quantity" ], "title": "line_items_create_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "adjustable_quantity", + "price", + "quantity" + ] }, "type": "array" }, @@ -122799,7 +136003,16 @@ } }, "title": "payment_intent_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "description", + "metadata", + "setup_future_usage", + "statement_descriptor", + "statement_descriptor_suffix", + "transfer_group" + ] }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", @@ -122864,7 +136077,10 @@ "enabled" ], "title": "phone_number_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "restrictions": { "description": "Settings that restrict the usage of a payment link.", @@ -122881,14 +136097,20 @@ "limit" ], "title": "completed_sessions_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "limit" + ] } }, "required": [ "completed_sessions" ], "title": "restrictions_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "completed_sessions" + ] }, "shipping_address_collection": { "description": "Configuration for collecting the customer's shipping address.", @@ -123144,7 +136366,10 @@ "allowed_countries" ], "title": "shipping_address_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_countries" + ] }, "shipping_options": { "description": "The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.", @@ -123157,7 +136382,10 @@ } }, "title": "shipping_option_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate" + ] }, "type": "array" }, @@ -123202,11 +136430,18 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "subscription_data_invoice_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "issuer" + ] }, "metadata": { "additionalProperties": { @@ -123239,18 +136474,31 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] } }, "title": "subscription_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "invoice_settings", + "metadata", + "trial_period_days", + "trial_settings" + ] }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", @@ -123264,7 +136512,11 @@ "enabled" ], "title": "tax_id_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "required" + ] }, "transfer_data": { "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.", @@ -123282,13 +136534,21 @@ "destination" ], "title": "transfer_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] } }, "required": [ "line_items" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "line_items", + "metadata" + ] } } }, @@ -123485,7 +136745,10 @@ } }, "title": "after_completion_confirmation_page_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_message" + ] }, "redirect": { "description": "Configuration when `type=redirect`.", @@ -123500,7 +136763,10 @@ "url" ], "title": "after_completion_redirect_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "url" + ] }, "type": { "description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.", @@ -123515,7 +136781,12 @@ "type" ], "title": "after_completion_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "hosted_confirmation", + "redirect", + "type" + ] }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", @@ -123548,14 +136819,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_address_collection": { "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", @@ -123593,7 +136872,11 @@ "value" ], "title": "custom_field_option_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "label", + "value" + ] }, "type": "array" } @@ -123602,7 +136885,11 @@ "options" ], "title": "custom_field_dropdown_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "options" + ] }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", @@ -123630,7 +136917,11 @@ "type" ], "title": "custom_field_label_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom", + "type" + ] }, "numeric": { "description": "Configuration for `type=numeric` fields.", @@ -123645,7 +136936,12 @@ } }, "title": "custom_field_numeric_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", @@ -123664,7 +136960,12 @@ } }, "title": "custom_field_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "type": { "description": "The type of the field.", @@ -123682,7 +136983,16 @@ "type" ], "title": "custom_field_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dropdown", + "key", + "label", + "numeric", + "optional", + "text", + "type" + ] }, "type": "array" }, @@ -123712,7 +137022,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -123737,7 +137050,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -123762,7 +137078,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -123787,7 +137106,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -123800,7 +137122,13 @@ } }, "title": "custom_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after_submit", + "shipping_address", + "submit", + "terms_of_service_acceptance" + ] }, "customer_creation": { "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).", @@ -123882,7 +137210,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -123925,7 +137257,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "anyOf": [ @@ -123959,7 +137295,11 @@ } }, "title": "rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title" + ] }, { "enum": [ @@ -123972,14 +137312,27 @@ } }, "title": "invoice_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "metadata", + "rendering_options" + ] } }, "required": [ "enabled" ], "title": "invoice_creation_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "invoice_data" + ] }, "line_items": { "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", @@ -124005,7 +137358,12 @@ "enabled" ], "title": "adjustable_quantity_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "maximum", + "minimum" + ] }, "id": { "description": "The ID of an existing line item on the payment link.", @@ -124021,7 +137379,13 @@ "id" ], "title": "line_items_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "adjustable_quantity", + "id", + "price", + "quantity" + ] }, "type": "array" }, @@ -124114,7 +137478,15 @@ } }, "title": "payment_intent_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "metadata", + "setup_future_usage", + "statement_descriptor", + "statement_descriptor_suffix", + "transfer_group" + ] }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", @@ -124193,14 +137565,20 @@ "limit" ], "title": "completed_sessions_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "limit" + ] } }, "required": [ "completed_sessions" ], "title": "restrictions_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "completed_sessions" + ] }, { "enum": [ @@ -124466,7 +137844,10 @@ "allowed_countries" ], "title": "shipping_address_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_countries" + ] }, { "enum": [ @@ -124503,11 +137884,18 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "subscription_data_invoice_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "issuer" + ] }, "metadata": { "anyOf": [ @@ -124547,14 +137935,20 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] }, { "enum": [ @@ -124567,7 +137961,13 @@ } }, "title": "subscription_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice_settings", + "metadata", + "trial_period_days", + "trial_settings" + ] }, "tax_id_collection": { "description": "Controls tax ID collection during checkout.", @@ -124581,10 +137981,19 @@ "enabled" ], "title": "tax_id_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "required" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "line_items", + "metadata" + ] } } }, @@ -124731,6 +138140,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -124879,6 +138294,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -125093,11 +138514,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "affirm": { "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.", @@ -125116,11 +138543,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "afterpay_clearpay": { "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", @@ -125139,11 +138572,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "alipay": { "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", @@ -125162,11 +138601,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", @@ -125185,11 +138630,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", @@ -125208,11 +138659,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "apple_pay_later": { "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", @@ -125231,11 +138688,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "au_becs_debit": { "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", @@ -125254,11 +138717,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "bacs_debit": { "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", @@ -125277,11 +138746,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "bancontact": { "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", @@ -125300,11 +138775,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "blik": { "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", @@ -125323,11 +138804,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "boleto": { "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", @@ -125346,11 +138833,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "card": { "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", @@ -125369,11 +138862,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "cartes_bancaires": { "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", @@ -125392,11 +138891,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "cashapp": { "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", @@ -125415,11 +138920,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "customer_balance": { "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", @@ -125438,11 +138949,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "eps": { "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", @@ -125461,11 +138978,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -125492,11 +139015,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "giropay": { "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", @@ -125515,11 +139044,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "google_pay": { "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", @@ -125538,11 +139073,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "grabpay": { "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", @@ -125561,11 +139102,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "ideal": { "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", @@ -125584,11 +139131,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "jcb": { "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", @@ -125607,11 +139160,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "klarna": { "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", @@ -125630,11 +139189,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "konbini": { "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", @@ -125653,11 +139218,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "link": { "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", @@ -125676,11 +139247,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "mobilepay": { "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", @@ -125699,11 +139276,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "multibanco": { "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", @@ -125722,11 +139305,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "name": { "description": "Configuration name.", @@ -125750,11 +139339,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "p24": { "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.", @@ -125773,11 +139368,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "parent": { "description": "Configuration's parent configuration. Specify to create a child configuration.", @@ -125801,11 +139402,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "paypal": { "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.", @@ -125824,11 +139431,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "promptpay": { "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.", @@ -125847,11 +139460,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "revolut_pay": { "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", @@ -125870,11 +139489,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "sepa_debit": { "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", @@ -125893,11 +139518,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "sofort": { "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", @@ -125916,11 +139547,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "swish": { "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", @@ -125939,11 +139576,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "twint": { "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", @@ -125962,11 +139605,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.", @@ -125985,11 +139634,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "wechat_pay": { "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.", @@ -126008,11 +139663,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "zip": { "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", @@ -126031,14 +139692,24 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "parent" + ] } } }, @@ -126343,11 +140014,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "active": { "description": "Whether the configuration can be used for new payments.", @@ -126370,11 +140047,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "afterpay_clearpay": { "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", @@ -126393,11 +140076,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "alipay": { "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", @@ -126416,11 +140105,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", @@ -126439,11 +140134,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", @@ -126462,11 +140163,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "apple_pay_later": { "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", @@ -126485,11 +140192,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "au_becs_debit": { "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", @@ -126508,11 +140221,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "bacs_debit": { "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", @@ -126531,11 +140250,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "bancontact": { "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", @@ -126554,11 +140279,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "blik": { "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", @@ -126577,11 +140308,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "boleto": { "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", @@ -126600,11 +140337,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "card": { "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", @@ -126623,11 +140366,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "cartes_bancaires": { "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", @@ -126646,11 +140395,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "cashapp": { "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", @@ -126669,11 +140424,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "customer_balance": { "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", @@ -126692,11 +140453,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "eps": { "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", @@ -126715,11 +140482,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -126746,11 +140519,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "giropay": { "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", @@ -126769,11 +140548,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "google_pay": { "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", @@ -126792,11 +140577,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "grabpay": { "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", @@ -126815,11 +140606,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "ideal": { "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", @@ -126838,11 +140635,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "jcb": { "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", @@ -126861,11 +140664,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "klarna": { "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", @@ -126884,11 +140693,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "konbini": { "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", @@ -126907,11 +140722,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "link": { "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", @@ -126930,11 +140751,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "mobilepay": { "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", @@ -126953,11 +140780,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "multibanco": { "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", @@ -126976,11 +140809,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "name": { "description": "Configuration name.", @@ -127004,11 +140843,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "p24": { "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.", @@ -127027,11 +140872,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "paynow": { "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.", @@ -127050,11 +140901,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "paypal": { "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.", @@ -127073,11 +140930,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "promptpay": { "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.", @@ -127096,11 +140959,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "revolut_pay": { "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", @@ -127119,11 +140988,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "sepa_debit": { "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", @@ -127142,11 +141017,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "sofort": { "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", @@ -127165,11 +141046,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "swish": { "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", @@ -127188,11 +141075,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "twint": { "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", @@ -127211,11 +141104,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.", @@ -127234,11 +141133,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "wechat_pay": { "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.", @@ -127257,11 +141162,17 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] }, "zip": { "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", @@ -127280,14 +141191,24 @@ } }, "title": "display_preference_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preference" + ] } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_preference" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "name" + ] } } }, @@ -127445,6 +141366,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -127499,7 +141426,11 @@ "required": [ "domain_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "domain_name", + "enabled" + ] } } }, @@ -127636,7 +141567,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] } } }, @@ -127899,6 +141833,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -128121,7 +142061,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -128175,7 +142120,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -128192,7 +142141,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -128239,7 +142192,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -128296,7 +142257,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -128317,7 +142284,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "card": { "anyOf": [ @@ -128350,7 +142320,10 @@ } }, "title": "networks_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred" + ] }, "number": { "description": "The card number, as a string without any separators.", @@ -128365,6 +142338,14 @@ ], "title": "card_details_params", "type": "object", + "x-stripeMostCommon": [ + "cvc", + "exp_month", + "exp_year", + "funding_options", + "networks", + "number" + ], "x-stripeParam": { "class_name": "CardDetails" } @@ -128382,6 +142363,9 @@ ], "title": "token_params", "type": "object", + "x-stripeMostCommon": [ + "token" + ], "x-stripeParam": { "class_name": "Token" } @@ -128447,7 +142431,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -128504,7 +142491,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -128546,13 +142537,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -128579,11 +142579,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -128660,7 +142668,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "payment_method": { "description": "The PaymentMethod to share.", @@ -128683,7 +142694,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -128701,7 +142715,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -128722,7 +142740,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -128744,7 +142765,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -128838,7 +142862,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -128853,7 +142884,14 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "customer", + "metadata", + "payment_method", + "type" + ] } } }, @@ -129045,7 +143083,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -129102,7 +143148,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "card": { "description": "If this is a `card` PaymentMethod, this hash contains the user's card details.", @@ -129130,11 +143182,19 @@ } }, "title": "networks_update_api_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred" + ] } }, "title": "update_api_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "exp_month", + "exp_year", + "networks" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -129188,10 +143248,18 @@ } }, "title": "update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_type" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata" + ] } } }, @@ -129266,7 +143334,10 @@ "required": [ "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer" + ] } } }, @@ -129396,7 +143467,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -129433,7 +143510,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -129565,6 +143648,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -129666,7 +143755,14 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "metadata", + "statement_descriptor" + ] } } }, @@ -129820,7 +143916,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -129965,7 +144064,10 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -130038,7 +144140,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -130161,6 +144269,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -130346,7 +144460,17 @@ "name" ], "title": "inline_product_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "id", + "images", + "metadata", + "name", + "statement_descriptor", + "tax_code", + "unit_label" + ] }, { "description": "The ID of the product whose pricing the created plan will represent.", @@ -130397,7 +144521,14 @@ "up_to" ], "title": "tier", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "flat_amount", + "flat_amount_decimal", + "unit_amount", + "unit_amount_decimal", + "up_to" + ] }, "type": "array" }, @@ -130430,7 +144561,11 @@ "round" ], "title": "transform_usage_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "divide_by", + "round" + ] }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", @@ -130449,7 +144584,16 @@ "currency", "interval" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "amount", + "currency", + "interval", + "metadata", + "nickname", + "product" + ] } } }, @@ -130672,7 +144816,12 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "metadata", + "nickname" + ] } } }, @@ -130745,7 +144894,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -130859,7 +145014,12 @@ } }, "title": "all_prices_recurring_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval", + "meter", + "usage_type" + ] }, "style": "deepObject" }, @@ -130944,6 +145104,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -131048,7 +145214,11 @@ "enabled" ], "title": "custom_unit_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "preset" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -131101,7 +145271,14 @@ "up_to" ], "title": "tier", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "flat_amount", + "flat_amount_decimal", + "unit_amount", + "unit_amount_decimal", + "up_to" + ] }, "type": "array" }, @@ -131116,7 +145293,10 @@ } }, "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit_amount" + ] }, "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -131145,7 +145325,11 @@ "enabled" ], "title": "custom_unit_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "preset" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -131222,7 +145406,17 @@ "name" ], "title": "inline_product_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "id", + "images", + "metadata", + "name", + "statement_descriptor", + "tax_code", + "unit_label" + ] }, "recurring": { "description": "The recurring components of a price such as `interval` and `usage_type`.", @@ -131273,7 +145467,14 @@ "interval" ], "title": "recurring", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aggregate_usage", + "interval", + "meter", + "trial_period_days", + "usage_type" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -131326,7 +145527,14 @@ "up_to" ], "title": "tier", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "flat_amount", + "flat_amount_decimal", + "unit_amount", + "unit_amount_decimal", + "up_to" + ] }, "type": "array" }, @@ -131363,7 +145571,11 @@ "round" ], "title": "transform_usage_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "divide_by", + "round" + ] }, "unit_amount": { "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.", @@ -131378,7 +145590,16 @@ "required": [ "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "currency", + "metadata", + "nickname", + "product", + "recurring", + "unit_amount" + ] } } }, @@ -131522,6 +145743,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -131676,7 +145905,11 @@ "enabled" ], "title": "custom_unit_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "preset" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -131729,7 +145962,14 @@ "up_to" ], "title": "tier", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "flat_amount", + "flat_amount_decimal", + "unit_amount", + "unit_amount_decimal", + "up_to" + ] }, "type": "array" }, @@ -131744,7 +145984,10 @@ } }, "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit_amount" + ] }, "type": "object" }, @@ -131806,7 +146049,12 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "metadata", + "nickname" + ] } } }, @@ -131879,7 +146127,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -132041,6 +146295,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -132132,7 +146392,11 @@ "enabled" ], "title": "custom_unit_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "preset" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -132185,7 +146449,14 @@ "up_to" ], "title": "tier", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "flat_amount", + "flat_amount_decimal", + "unit_amount", + "unit_amount_decimal", + "up_to" + ] }, "type": "array" }, @@ -132200,7 +146471,10 @@ } }, "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit_amount" + ] }, "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -132227,7 +146501,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -132252,7 +146529,13 @@ "currency" ], "title": "price_data_without_product", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "currency_options", + "recurring", + "unit_amount" + ] }, "description": { "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", @@ -132293,7 +146576,10 @@ "name" ], "title": "features", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name" + ] }, "type": "array" }, @@ -132336,7 +146622,13 @@ "width" ], "title": "package_dimensions_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "height", + "length", + "weight", + "width" + ] }, "shippable": { "description": "Whether this product is shipped (i.e., physical goods).", @@ -132373,7 +146665,14 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "description", + "id", + "metadata", + "name" + ] } } }, @@ -132517,6 +146816,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -132777,7 +147084,10 @@ "name" ], "title": "features", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name" + ] }, "type": "array" }, @@ -132840,7 +147150,13 @@ "width" ], "title": "package_dimensions_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "height", + "length", + "weight", + "width" + ] }, { "enum": [ @@ -132904,7 +147220,14 @@ "description": "A URL of a publicly-accessible webpage for this product." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "default_price", + "description", + "metadata", + "name" + ] } } }, @@ -133050,6 +147373,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -133112,7 +147441,10 @@ "required": [ "entitlement_feature" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "entitlement_feature" + ] } } }, @@ -133348,7 +147680,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -133470,6 +147808,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -133566,7 +147910,10 @@ } }, "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "minimum_amount" + ] }, "description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -133585,13 +147932,24 @@ } }, "title": "restrictions_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency_options", + "first_time_transaction", + "minimum_amount", + "minimum_amount_currency" + ] } }, "required": [ "coupon" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code", + "coupon", + "metadata" + ] } } }, @@ -133764,17 +148122,26 @@ } }, "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "minimum_amount" + ] }, "description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "title": "restrictions_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency_options" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -133950,6 +148317,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -134098,14 +148471,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", @@ -134175,7 +148556,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -134186,7 +148570,7 @@ "type": "string" } ], - "description": "The discounts applied to the quote. You can only set up to one discount." + "description": "The discounts applied to the quote." }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -134233,7 +148617,11 @@ "quote" ], "title": "from_quote_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "is_revision", + "quote" + ] }, "header": { "anyOf": [ @@ -134277,11 +148665,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "quote_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer" + ] }, "line_items": { "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", @@ -134309,7 +148708,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -134361,7 +148763,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -134387,7 +148792,12 @@ "product" ], "title": "price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "The quantity of the line item.", @@ -134413,7 +148823,11 @@ } }, "title": "line_item_create_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ] }, "type": "array" }, @@ -134491,7 +148905,20 @@ } }, "title": "subscription_data_create_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bill_on_acceptance", + "billing_behavior", + "billing_cycle_anchor", + "description", + "effective_date", + "end_behavior", + "from_subscription", + "metadata", + "prebilling", + "proration_behavior", + "trial_period_days" + ] }, "test_clock": { "description": "ID of the test clock to attach to the quote.", @@ -134519,7 +148946,12 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_percent", + "destination" + ] }, { "enum": [ @@ -134531,7 +148963,11 @@ "description": "The data with which to automatically create a Transfer for each of the invoices." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "line_items", + "metadata" + ] } } }, @@ -134766,14 +149202,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", @@ -134843,7 +149287,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -134854,7 +149301,7 @@ "type": "string" } ], - "description": "The discounts applied to the quote. You can only set up to one discount." + "description": "The discounts applied to the quote." }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -134926,11 +149373,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "quote_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer" + ] }, "line_items": { "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", @@ -134958,7 +149416,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -135015,7 +149476,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -135041,7 +149505,12 @@ "product" ], "title": "price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "The quantity of the line item.", @@ -135067,7 +149536,12 @@ } }, "title": "line_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "id", + "price", + "quantity" + ] }, "type": "array" }, @@ -135155,7 +149629,19 @@ } }, "title": "subscription_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bill_on_acceptance", + "billing_behavior", + "billing_cycle_anchor", + "description", + "effective_date", + "end_behavior", + "metadata", + "prebilling", + "proration_behavior", + "trial_period_days" + ] }, "transfer_data": { "anyOf": [ @@ -135178,7 +149664,12 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_percent", + "destination" + ] }, { "enum": [ @@ -135190,7 +149681,11 @@ "description": "The data with which to automatically create a Transfer for each of the invoices." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "line_items", + "metadata" + ] } } }, @@ -135471,6 +149966,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -135679,6 +150180,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -135815,7 +150322,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -135937,6 +150450,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -136057,7 +150576,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -136190,6 +150715,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -136246,7 +150777,11 @@ "value", "value_list" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "value", + "value_list" + ] } } }, @@ -136450,7 +150985,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -136561,6 +151102,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -136645,7 +151192,13 @@ "alias", "name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "alias", + "item_type", + "metadata", + "name" + ] } } }, @@ -136850,7 +151403,12 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "alias", + "metadata", + "name" + ] } } }, @@ -136923,7 +151481,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -137043,6 +151607,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -137157,7 +151727,18 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "charge", + "currency", + "customer", + "instructions_email", + "metadata", + "origin", + "payment_intent", + "reason" + ] } } }, @@ -137309,7 +151890,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -137438,7 +152022,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -137549,6 +152139,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -138279,7 +152875,160 @@ } }, "title": "run_parameter_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "age_bucket", + "all", + "amount", + "amount_filter", + "apple_subscriber", + "application_id", + "authentication_outcome_detailed", + "billing_analytics_metric", + "calculation_type", + "capability_type", + "card_bin", + "card_brand", + "card_brands", + "card_country", + "card_fingerprint", + "card_funding", + "card_number", + "card_type", + "card_types", + "cau_correction_factor", + "charge", + "chart_detail_page_id", + "cof", + "columns", + "compare_to_end", + "compare_to_start", + "connect_charge_type", + "connected_account", + "contract", + "conversion_currency", + "countries", + "country", + "currency", + "cursor", + "customer", + "customers", + "dataset_id", + "date_format", + "days_to_use", + "decimal_separator", + "digital_wallet", + "direction", + "download", + "entity_type", + "exchange_rate", + "exchange_rates", + "experiment_id", + "fee_category", + "filter_column", + "filter_columns", + "filter_currency", + "filter_value", + "filter_values", + "filters", + "first_day_of_week_offset", + "gateway_conversation_avs_outcome", + "gateway_conversation_cvc_outcome", + "google_order", + "group_by", + "group_by_key", + "group_id", + "group_type", + "grouped_column", + "grouped_columns", + "grouped_metadata_column", + "include_blocked_payments", + "include_connect_charges", + "interval_end", + "interval_start", + "invoice", + "invoice_line_item", + "ip_address", + "ip_country", + "is_eu_vat_moss", + "is_latam", + "is_link_in_pmm_supported", + "is_top_fraudy_attributes", + "is_unbilled", + "jurisdiction_key", + "limit", + "list_item", + "list_items", + "livemode", + "match_mode", + "match_status", + "max_churn", + "meter_id", + "min_trim_size", + "nci_filter_for", + "nci_mcc", + "numeric_filters", + "offset", + "payment_link_id", + "payment_method_type", + "payment_method_types", + "payment_methods", + "payout", + "payout_date_end", + "payout_date_start", + "payout_status", + "payout_type", + "platform", + "platform_id", + "product", + "product_feature_description", + "radar_bad_outcome_configuration", + "radar_fraud_outcomes", + "radar_good_outcomes", + "rate", + "recognition_end", + "recognition_start", + "recon_party_name", + "recon_space", + "recon_space_type", + "reconciliation_status", + "reference_id", + "reporting_category", + "reporting_string_filters", + "retries_correction_factor", + "rev_rec_month_summary_line_item", + "risk_score", + "rule_action", + "rule_attribute", + "rule_attribute_case_insensitive", + "rule_attribute_name_value", + "rule_id", + "rule_predicate_sql", + "secondary_cursor", + "seconds_since_card_first_seen", + "segment_id", + "sort_order", + "sorted_column", + "states", + "string_filters", + "tax_form_id", + "tax_type", + "taxable", + "timezone", + "total_charges_per_card_number_daily", + "total_fraud_volume", + "total_legitimate_volume", + "tracking_load_type", + "transaction_age_max", + "transaction_age_min", + "transaction_initiators", + "transaction_type", + "unit", + "ur", + "use_dispute_creation_date", + "used_network_tokens", + "view_type" + ] }, "report_type": { "description": "The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `\"balance.summary.1\"`.", @@ -138289,7 +153038,11 @@ "required": [ "report_type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "parameters", + "report_type" + ] } } }, @@ -138461,6 +153214,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -138580,7 +153339,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -138690,6 +153455,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -138877,7 +153648,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -138999,6 +153776,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -139061,7 +153844,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -139194,6 +153983,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -139283,7 +154078,11 @@ "enabled" ], "title": "automatic_payment_methods_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redirects", + "enabled" + ] }, "confirm": { "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.", @@ -139359,7 +154158,11 @@ "user_agent" ], "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", @@ -139375,14 +154178,23 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" + ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ] }, { "enum": [ @@ -139442,7 +154254,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -139496,7 +154313,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -139513,7 +154334,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -139560,7 +154385,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -139617,7 +154450,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -139638,7 +154477,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -139692,7 +154534,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -139741,7 +154586,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -139783,13 +154632,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -139816,11 +154674,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -139897,7 +154763,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -139915,7 +154784,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -139933,7 +154805,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -139954,7 +154830,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -139976,7 +154855,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -140069,7 +154951,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -140088,7 +154977,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", @@ -140156,7 +155050,14 @@ } }, "title": "setup_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -140170,13 +155071,21 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "verification_method" + ] }, "amazon_pay": { "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "charge_permission_id" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", @@ -140185,11 +155094,17 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options" + ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", @@ -140268,7 +155183,19 @@ "start_date" ], "title": "setup_intent_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "currency", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "moto": { "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", @@ -140369,11 +155296,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", @@ -140397,11 +155332,32 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_preferred", + "gateway", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "setup_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "moto", + "network", + "network_token", + "request_name_verification", + "request_three_d_secure", + "three_d_secure", + "verify_card_account" + ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", @@ -140419,7 +155375,10 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "persistent_token" + ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", @@ -140431,7 +155390,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_agreement_id", + "currency", + "subsellers" + ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", @@ -140440,11 +155404,19 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, "us_bank_account": { "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", @@ -140469,7 +155441,11 @@ } }, "title": "linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -140506,7 +155482,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -140522,7 +155505,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -140540,7 +155526,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -140554,11 +155543,35 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "verification_method" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "alipay", + "amazon_pay", + "bacs_debit", + "blik", + "card", + "card_present", + "demo_pay", + "dummy_auth_push", + "klarna", + "link", + "paypal", + "payto", + "sepa_debit", + "upi", + "us_bank_account" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to [\"card\"].", @@ -140589,7 +155602,11 @@ "currency" ], "title": "setup_intent_single_use_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] }, "usage": { "description": "Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.", @@ -140604,7 +155621,16 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "automatic_payment_methods", + "confirm", + "customer", + "description", + "metadata", + "payment_method", + "usage" + ] } } }, @@ -140847,7 +155873,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -140901,7 +155932,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -140918,7 +155953,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -140965,7 +156004,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -141022,7 +156069,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -141043,7 +156096,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -141097,7 +156153,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -141146,7 +156205,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -141188,13 +156251,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -141221,11 +156293,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -141302,7 +156382,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -141320,7 +156403,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -141338,7 +156424,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -141359,7 +156449,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -141381,7 +156474,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -141474,7 +156570,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -141493,7 +156596,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", @@ -141561,7 +156669,14 @@ } }, "title": "setup_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -141575,13 +156690,21 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "verification_method" + ] }, "amazon_pay": { "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "charge_permission_id" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", @@ -141590,11 +156713,17 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options" + ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", @@ -141673,7 +156802,19 @@ "start_date" ], "title": "setup_intent_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "currency", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "moto": { "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", @@ -141774,11 +156915,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", @@ -141802,11 +156951,32 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_preferred", + "gateway", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "setup_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "moto", + "network", + "network_token", + "request_name_verification", + "request_three_d_secure", + "three_d_secure", + "verify_card_account" + ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", @@ -141824,7 +156994,10 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "persistent_token" + ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", @@ -141836,7 +157009,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_agreement_id", + "currency", + "subsellers" + ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", @@ -141845,11 +157023,19 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, "us_bank_account": { "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", @@ -141874,7 +157060,11 @@ } }, "title": "linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -141911,7 +157101,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -141927,7 +157124,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -141945,7 +157145,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -141959,11 +157162,35 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "verification_method" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "alipay", + "amazon_pay", + "bacs_debit", + "blik", + "card", + "card_present", + "demo_pay", + "dummy_auth_push", + "klarna", + "link", + "paypal", + "payto", + "sepa_debit", + "upi", + "us_bank_account" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to [\"card\"].", @@ -141974,7 +157201,13 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "description", + "metadata", + "payment_method" + ] } } }, @@ -142051,7 +157284,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason" + ] } } }, @@ -142170,7 +157406,11 @@ "user_agent" ], "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", @@ -142186,14 +157426,23 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" + ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ] }, { "enum": [ @@ -142221,7 +157470,11 @@ } }, "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate.", @@ -142237,7 +157490,11 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "online", + "type" + ] } }, "required": [ @@ -142245,6 +157502,9 @@ ], "title": "client_key_param", "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ], "x-stripeParam": { "class_name": "MandateDataPublishableKey" } @@ -142284,7 +157544,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -142338,7 +157603,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -142355,7 +157624,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -142402,7 +157675,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -142459,7 +157740,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -142480,7 +157767,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -142534,7 +157824,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -142583,7 +157876,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -142625,13 +157922,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -142658,11 +157964,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -142739,7 +158053,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -142757,7 +158074,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -142775,7 +158095,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -142796,7 +158120,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -142818,7 +158145,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -142911,7 +158241,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -142930,7 +158267,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", @@ -142998,7 +158340,14 @@ } }, "title": "setup_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -143012,13 +158361,21 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "verification_method" + ] }, "amazon_pay": { "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", "properties": {}, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "charge_permission_id" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", @@ -143027,11 +158384,17 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options" + ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", @@ -143110,7 +158473,19 @@ "start_date" ], "title": "setup_intent_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "currency", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "moto": { "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", @@ -143211,11 +158586,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "requestor_challenge_indicator": { "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.", @@ -143239,11 +158622,32 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_preferred", + "gateway", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "setup_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "moto", + "network", + "network_token", + "request_name_verification", + "request_three_d_secure", + "three_d_secure", + "verify_card_account" + ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", @@ -143261,7 +158665,10 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "persistent_token" + ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", @@ -143273,7 +158680,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_agreement_id", + "currency", + "subsellers" + ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", @@ -143282,11 +158694,19 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, "us_bank_account": { "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", @@ -143311,7 +158731,11 @@ } }, "title": "linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -143348,7 +158772,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -143364,7 +158795,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -143382,7 +158816,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -143396,11 +158833,35 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "verification_method" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "alipay", + "amazon_pay", + "bacs_debit", + "blik", + "card", + "card_present", + "demo_pay", + "dummy_auth_push", + "klarna", + "link", + "paypal", + "payto", + "sepa_debit", + "upi", + "us_bank_account" + ] }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.", @@ -143411,7 +158872,10 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method" + ] } } }, @@ -143494,7 +158958,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amounts", + "descriptor_code" + ] } } }, @@ -143567,7 +159035,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -143688,6 +159162,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -143760,7 +159240,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -143786,11 +159270,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -143837,7 +159329,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" @@ -143848,7 +159344,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -143881,7 +159382,13 @@ "required": [ "display_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } } }, @@ -144046,14 +159553,21 @@ } }, "title": "currency_option_update", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", "type": "object" } }, "title": "fixed_amount_update", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency_options" + ] }, "metadata": { "anyOf": [ @@ -144082,7 +159596,12 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "fixed_amount", + "metadata" + ] } } }, @@ -144219,6 +159738,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -144405,7 +159930,10 @@ "contact_email" ], "title": "mandate_offline_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "contact_email" + ] }, "online": { "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", @@ -144426,7 +159954,12 @@ } }, "title": "mandate_online_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "status": { "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", @@ -144458,7 +159991,16 @@ "status" ], "title": "mandate_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "offline", + "online", + "status", + "type", + "user_agent" + ] }, "amount": { "anyOf": [ @@ -144502,7 +160044,14 @@ } }, "title": "mandate_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acceptance", + "amount", + "currency", + "interval", + "notification_method" + ] }, "metadata": { "additionalProperties": { @@ -144553,7 +160102,15 @@ } }, "title": "source_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "email": { "description": "Owner's email address.", @@ -144571,7 +160128,13 @@ } }, "title": "owner", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "receiver": { "description": "Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).", @@ -144588,7 +160151,10 @@ } }, "title": "receiver_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "refund_attributes_method" + ] }, "redirect": { "description": "Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).", @@ -144602,7 +160168,10 @@ "return_url" ], "title": "redirect_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "return_url" + ] }, "source_order": { "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.", @@ -144642,7 +160211,15 @@ } }, "title": "order_item_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "parent", + "quantity", + "type" + ] }, "type": "array" }, @@ -144687,7 +160264,15 @@ "line1" ], "title": "address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -144714,11 +160299,22 @@ "address" ], "title": "order_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] } }, "title": "shallow_order_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "items", + "shipping" + ] }, "statement_descriptor": { "description": "An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.", @@ -144744,7 +160340,18 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "metadata", + "original_source", + "owner", + "redirect", + "statement_descriptor", + "type" + ] } } }, @@ -144934,7 +160541,10 @@ "contact_email" ], "title": "mandate_offline_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "contact_email" + ] }, "online": { "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", @@ -144955,7 +160565,12 @@ } }, "title": "mandate_online_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "status": { "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", @@ -144987,7 +160602,16 @@ "status" ], "title": "mandate_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "offline", + "online", + "status", + "type", + "user_agent" + ] }, "amount": { "anyOf": [ @@ -145031,7 +160655,14 @@ } }, "title": "mandate_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acceptance", + "amount", + "currency", + "interval", + "notification_method" + ] }, "metadata": { "anyOf": [ @@ -145088,7 +160719,15 @@ } }, "title": "source_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "email": { "description": "Owner's email address.", @@ -145106,7 +160745,13 @@ } }, "title": "owner", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "source_order": { "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.", @@ -145146,7 +160791,15 @@ } }, "title": "order_item_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "parent", + "quantity", + "type" + ] }, "type": "array" }, @@ -145191,7 +160844,15 @@ "line1" ], "title": "address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -145218,14 +160879,30 @@ "address" ], "title": "order_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] } }, "title": "order_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "items", + "shipping" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "metadata", + "owner" + ] } } }, @@ -145371,6 +161048,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -145442,7 +161125,10 @@ "required": [ "values" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "values" + ] } } }, @@ -145588,6 +161274,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -145654,7 +161346,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -145687,7 +161382,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -145769,7 +161467,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -145796,7 +161497,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", @@ -145843,7 +161550,15 @@ "required": [ "subscription" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "payment_behavior", + "price", + "proration_behavior", + "quantity", + "subscription" + ] } } }, @@ -145915,7 +161630,10 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "proration_behavior" + ] } } }, @@ -146070,7 +161788,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -146103,7 +161824,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -146199,7 +161923,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -146226,7 +161953,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "proration_behavior": { "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", @@ -146265,7 +161998,14 @@ "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "payment_behavior", + "price", + "proration_behavior", + "quantity" + ] } } }, @@ -146410,6 +162150,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -146500,7 +162246,12 @@ "required": [ "quantity" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "action", + "quantity", + "timestamp" + ] } } }, @@ -146563,7 +162314,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -146600,7 +162357,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -146637,7 +162400,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -146721,7 +162490,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -146806,6 +162581,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -146894,14 +162675,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -146925,7 +162714,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -147009,11 +162802,26 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "subscription_schedule_default_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "on_behalf_of": { "anyOf": [ @@ -147046,7 +162854,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, { "enum": [ @@ -147059,7 +162871,19 @@ } }, "title": "default_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "default_payment_method", + "description", + "invoice_settings", + "on_behalf_of", + "transfer_data" + ] }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", @@ -147130,7 +162954,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -147175,7 +163002,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -147202,6 +163034,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -147239,14 +163075,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -147270,7 +163114,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -147358,7 +163206,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -147421,11 +163272,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -147444,7 +163309,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -147477,7 +163345,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -147541,7 +163412,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -147568,7 +163442,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -147594,7 +163474,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -147638,7 +163528,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -147654,7 +163548,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "cancel_at_period_end", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -147675,7 +163598,13 @@ "description": "When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "metadata", + "phases", + "start_date" + ] } } }, @@ -147845,14 +163774,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -147876,7 +163813,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -147960,11 +163901,26 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "subscription_schedule_default_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "on_behalf_of": { "anyOf": [ @@ -147997,7 +163953,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, { "enum": [ @@ -148010,7 +163970,19 @@ } }, "title": "default_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "default_payment_method", + "description", + "invoice_settings", + "on_behalf_of", + "transfer_data" + ] }, "end_behavior": { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.", @@ -148076,7 +164048,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -148121,7 +164096,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -148148,6 +164128,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -148185,14 +164169,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -148216,7 +164208,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -148304,7 +164300,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -148378,11 +164377,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -148401,7 +164414,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -148434,7 +164450,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -148498,7 +164517,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -148525,7 +164547,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -148551,7 +164579,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -148611,7 +164649,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -148638,7 +164680,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -148652,7 +164723,12 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "phases", + "proration_behavior" + ] } } }, @@ -148727,7 +164803,10 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice_now" + ] } } }, @@ -148850,7 +164929,10 @@ "enabled" ], "title": "automatic_tax_filter_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "style": "deepObject" }, @@ -148896,7 +164978,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -148906,6 +164994,7 @@ "style": "deepObject" }, { + "description": "Only return subscriptions whose current_period_end falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_end", @@ -148932,7 +165021,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -148942,6 +165037,7 @@ "style": "deepObject" }, { + "description": "Only return subscriptions whose current_period_start falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_start", @@ -148968,7 +165064,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -149145,6 +165247,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -149267,7 +165375,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -149312,7 +165423,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -149339,6 +165455,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -149386,14 +165506,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "backdate_start_date": { "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", @@ -149434,7 +165562,14 @@ "day_of_month" ], "title": "billing_cycle_anchor_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day_of_month", + "hour", + "minute", + "month", + "second" + ] }, "billing_thresholds": { "anyOf": [ @@ -149450,7 +165585,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -149551,7 +165690,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -149613,11 +165755,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", @@ -149636,7 +165792,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -149669,7 +165828,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -149733,7 +165895,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -149760,7 +165925,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -149786,7 +165957,17 @@ } }, "title": "subscription_item_create_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -149858,7 +166039,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -149872,7 +166056,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -149899,7 +166087,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -149936,7 +166127,12 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description" + ] }, "network": { "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", @@ -149969,7 +166165,13 @@ } }, "title": "subscription_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "mit_exemption", + "network", + "request_three_d_secure" + ] }, { "enum": [ @@ -150000,7 +166202,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", @@ -150008,7 +166213,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -150016,7 +166226,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -150048,7 +166262,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -150082,7 +166299,11 @@ } }, "title": "invoice_linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -150114,7 +166335,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -150128,7 +166354,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -150141,7 +166371,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -150203,7 +166443,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_options", + "payment_method_types", + "save_default_payment_method" + ] }, "pending_invoice_item_interval": { "anyOf": [ @@ -150228,7 +166473,11 @@ "interval" ], "title": "pending_invoice_item_interval_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval", + "interval_count" + ] }, { "enum": [ @@ -150269,7 +166518,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial_end": { "anyOf": [ @@ -150315,20 +166568,36 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] } }, "required": [ "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancel_at_period_end", + "currency", + "customer", + "default_payment_method", + "description", + "items", + "metadata", + "payment_behavior" + ] } } }, @@ -150472,6 +166741,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -150558,7 +166835,12 @@ } }, "title": "cancellation_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "comment", + "feedback", + "feedback_option" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -150804,7 +167086,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -150849,7 +167134,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -150876,6 +167166,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -150923,14 +167217,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -150956,7 +167258,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -151021,7 +167327,12 @@ } }, "title": "cancellation_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "comment", + "feedback", + "feedback_option" + ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", @@ -151115,7 +167426,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -151177,11 +167491,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", @@ -151200,7 +167528,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -151241,7 +167572,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -151320,7 +167654,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "tax_behavior": { "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", @@ -151347,7 +167684,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -151373,7 +167716,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -151435,7 +167790,11 @@ "behavior" ], "title": "pause_collection_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "behavior", + "resumes_at" + ] }, { "enum": [ @@ -151479,7 +167838,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -151493,7 +167855,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -151520,7 +167886,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -151557,7 +167926,12 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description" + ] }, "network": { "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", @@ -151590,7 +167964,13 @@ } }, "title": "subscription_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "mit_exemption", + "network", + "request_three_d_secure" + ] }, { "enum": [ @@ -151621,7 +168001,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "type": { "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", @@ -151629,7 +168012,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "funding_type": { "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", @@ -151637,7 +168025,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -151669,7 +168061,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -151703,7 +168098,11 @@ } }, "title": "invoice_linked_account_options_filters_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", @@ -151735,7 +168134,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -151749,7 +168153,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -151762,7 +168170,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -151824,7 +168242,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_options", + "payment_method_types", + "save_default_payment_method" + ] }, "pending_invoice_item_interval": { "anyOf": [ @@ -151849,7 +168272,11 @@ "interval" ], "title": "pending_invoice_item_interval_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval", + "interval_count" + ] }, { "enum": [ @@ -151896,7 +168323,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, { "enum": [ @@ -151947,17 +168378,32 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancel_at_period_end", + "default_payment_method", + "description", + "items", + "metadata", + "payment_behavior", + "proration_behavior" + ] } } }, @@ -152100,7 +168546,11 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "proration_behavior" + ] } } }, @@ -152262,7 +168712,15 @@ "country" ], "title": "postal_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_source": { "description": "The type of customer address provided.", @@ -152372,7 +168830,11 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" }, @@ -152387,7 +168849,14 @@ } }, "title": "customer_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_source", + "ip_address", + "tax_ids", + "taxability_override" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -152436,7 +168905,15 @@ "amount" ], "title": "calculation_line_item", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "product", + "quantity", + "reference", + "tax_behavior", + "tax_code" + ] }, "type": "array" }, @@ -152531,14 +169008,25 @@ "country" ], "title": "merchant_postal_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] } }, "required": [ "address" ], "title": "ship_from_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address" + ] }, "shipping_cost": { "description": "Shipping cost details to be used for the calculation.", @@ -152561,12 +169049,18 @@ "type": "string" }, "tax_code": { - "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](/settings/tax) is used.", + "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.", "type": "string" } }, "title": "shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "shipping_rate", + "tax_behavior", + "tax_code" + ] }, "tax_date": { "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.", @@ -152577,7 +169071,13 @@ "currency", "line_items" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "customer_details", + "line_items", + "shipping_cost" + ] } } }, @@ -152793,6 +169293,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -152935,6 +169441,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -153015,7 +169527,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "at": { "description": "Options for the registration in AT.", @@ -153036,7 +169551,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153053,7 +169571,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "au": { "description": "Options for the registration in AU.", @@ -153070,7 +169592,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "be": { "description": "Options for the registration in BE.", @@ -153091,7 +169616,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153108,7 +169636,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "bg": { "description": "Options for the registration in BG.", @@ -153129,7 +169661,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153146,7 +169681,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "bh": { "description": "Options for the registration in BH.", @@ -153163,7 +169702,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ca": { "description": "Options for the registration in CA.", @@ -153181,7 +169723,10 @@ "province" ], "title": "province_standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "province" + ] }, "type": { "description": "Type of registration to be created in Canada.", @@ -153197,7 +169742,11 @@ "type" ], "title": "canada", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "province_standard", + "type" + ] }, "ch": { "description": "Options for the registration in CH.", @@ -153214,7 +169763,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "cl": { "description": "Options for the registration in CL.", @@ -153231,7 +169783,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "co": { "description": "Options for the registration in CO.", @@ -153248,7 +169803,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "cy": { "description": "Options for the registration in CY.", @@ -153269,7 +169827,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153286,7 +169847,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "cz": { "description": "Options for the registration in CZ.", @@ -153307,7 +169872,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153324,7 +169892,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "de": { "description": "Options for the registration in DE.", @@ -153345,7 +169917,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153362,7 +169937,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "dk": { "description": "Options for the registration in DK.", @@ -153383,7 +169962,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153400,7 +169982,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "ee": { "description": "Options for the registration in EE.", @@ -153421,7 +170007,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153438,7 +170027,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "eg": { "description": "Options for the registration in EG.", @@ -153455,7 +170048,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "es": { "description": "Options for the registration in ES.", @@ -153476,7 +170072,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153493,7 +170092,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "fi": { "description": "Options for the registration in FI.", @@ -153514,7 +170117,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153531,7 +170137,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "fr": { "description": "Options for the registration in FR.", @@ -153552,7 +170162,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153569,7 +170182,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "gb": { "description": "Options for the registration in GB.", @@ -153586,7 +170203,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ge": { "description": "Options for the registration in GE.", @@ -153603,7 +170223,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "gr": { "description": "Options for the registration in GR.", @@ -153624,7 +170247,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153641,7 +170267,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "hr": { "description": "Options for the registration in HR.", @@ -153662,7 +170292,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153679,7 +170312,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "hu": { "description": "Options for the registration in HU.", @@ -153700,7 +170337,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153717,7 +170357,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "id": { "description": "Options for the registration in ID.", @@ -153734,7 +170378,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ie": { "description": "Options for the registration in IE.", @@ -153755,7 +170402,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153772,7 +170422,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "is": { "description": "Options for the registration in IS.", @@ -153789,7 +170443,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "it": { "description": "Options for the registration in IT.", @@ -153810,7 +170467,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153827,7 +170487,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "jp": { "description": "Options for the registration in JP.", @@ -153844,7 +170508,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ke": { "description": "Options for the registration in KE.", @@ -153861,7 +170528,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "kr": { "description": "Options for the registration in KR.", @@ -153878,7 +170548,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "kz": { "description": "Options for the registration in KZ.", @@ -153895,7 +170568,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "lt": { "description": "Options for the registration in LT.", @@ -153916,7 +170592,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153933,7 +170612,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "lu": { "description": "Options for the registration in LU.", @@ -153954,7 +170637,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -153971,7 +170657,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "lv": { "description": "Options for the registration in LV.", @@ -153992,7 +170682,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154009,7 +170702,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "mt": { "description": "Options for the registration in MT.", @@ -154030,7 +170727,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154047,7 +170747,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "mx": { "description": "Options for the registration in MX.", @@ -154064,7 +170768,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "my": { "description": "Options for the registration in MY.", @@ -154081,7 +170788,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ng": { "description": "Options for the registration in NG.", @@ -154098,7 +170808,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "nl": { "description": "Options for the registration in NL.", @@ -154119,7 +170832,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154136,7 +170852,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "no": { "description": "Options for the registration in NO.", @@ -154153,7 +170873,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "nz": { "description": "Options for the registration in NZ.", @@ -154170,7 +170893,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "om": { "description": "Options for the registration in OM.", @@ -154187,7 +170913,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "pl": { "description": "Options for the registration in PL.", @@ -154208,7 +170937,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154225,7 +170957,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "pt": { "description": "Options for the registration in PT.", @@ -154246,7 +170982,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154263,7 +171002,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "ro": { "description": "Options for the registration in RO.", @@ -154284,7 +171027,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154301,7 +171047,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "sa": { "description": "Options for the registration in SA.", @@ -154318,7 +171068,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "se": { "description": "Options for the registration in SE.", @@ -154339,7 +171092,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154356,7 +171112,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "sg": { "description": "Options for the registration in SG.", @@ -154373,7 +171133,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "si": { "description": "Options for the registration in SI.", @@ -154394,7 +171157,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154411,7 +171177,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "sk": { "description": "Options for the registration in SK.", @@ -154432,7 +171202,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -154449,7 +171222,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "th": { "description": "Options for the registration in TH.", @@ -154466,7 +171243,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "tr": { "description": "Options for the registration in TR.", @@ -154483,7 +171263,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "us": { "description": "Options for the registration in US.", @@ -154501,7 +171284,10 @@ "jurisdiction" ], "title": "local_amusement_tax", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "jurisdiction" + ] }, "local_lease_tax": { "description": "Options for the local lease tax registration.", @@ -154516,7 +171302,10 @@ "jurisdiction" ], "title": "local_lease_tax", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "jurisdiction" + ] }, "state": { "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", @@ -154540,7 +171329,14 @@ "type" ], "title": "united_states", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "local_amusement_tax", + "local_lease_tax", + "state", + "state_sales_tax", + "type" + ] }, "vn": { "description": "Options for the registration in VN.", @@ -154557,7 +171353,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "za": { "description": "Options for the registration in ZA.", @@ -154574,11 +171373,75 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] } }, "title": "country_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ae", + "at", + "au", + "be", + "bg", + "bh", + "ca", + "ch", + "cl", + "co", + "cy", + "cz", + "de", + "dk", + "ee", + "eg", + "es", + "fi", + "fr", + "gb", + "ge", + "gr", + "hr", + "hu", + "id", + "ie", + "in", + "is", + "it", + "jp", + "ke", + "kr", + "kz", + "lt", + "lu", + "lv", + "mt", + "mx", + "my", + "ng", + "nl", + "no", + "nz", + "om", + "pl", + "pt", + "ro", + "sa", + "se", + "sg", + "si", + "sk", + "th", + "tr", + "tw", + "ua", + "us", + "vn", + "za" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -154599,7 +171462,13 @@ "country", "country_options" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active_from", + "country", + "country_options", + "expires_at" + ] } } }, @@ -154778,7 +171647,11 @@ "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active_from", + "expires_at" + ] } } }, @@ -154906,7 +171779,11 @@ } }, "title": "defaults_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_behavior", + "tax_code" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -154954,17 +171831,32 @@ } }, "title": "validated_country_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] } }, "required": [ "address" ], "title": "head_office_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "defaults", + "head_office" + ] } } }, @@ -155049,7 +171941,12 @@ "calculation", "reference" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "calculation", + "metadata", + "reference" + ] } } }, @@ -155160,7 +172057,15 @@ "reference" ], "title": "transaction_line_item_reversal", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_tax", + "metadata", + "original_line_item", + "quantity", + "reference" + ] }, "type": "array" }, @@ -155206,7 +172111,11 @@ "amount_tax" ], "title": "transaction_shipping_cost_reversal", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_tax" + ] } }, "required": [ @@ -155214,7 +172123,15 @@ "original_transaction", "reference" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "flat_amount", + "line_items", + "metadata", + "mode", + "original_transaction", + "reference" + ] } } }, @@ -155396,9 +172313,139 @@ "description": "", "properties": { "data": { - "description": "Details about each object.", + "description": "Details about each object.", + "items": { + "$ref": "#/components/schemas/tax.transaction_line_item" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/tax/transactions/[^/]+/line_items", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "TaxProductResourceTaxTransactionLineItemList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/tax_codes": { + "get": { + "description": "

A list of all tax codes available to add to Products in order to allow specific tax calculations.

", + "operationId": "GetTaxCodes", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { "items": { - "$ref": "#/components/schemas/tax.transaction_line_item" + "$ref": "#/components/schemas/tax_code" }, "type": "array" }, @@ -155416,7 +172463,6 @@ "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, - "pattern": "^/v1/tax/transactions/[^/]+/line_items", "type": "string" } }, @@ -155426,133 +172472,16 @@ "object", "url" ], - "title": "TaxProductResourceTaxTransactionLineItemList", + "title": "TaxProductResourceTaxCodeList", "type": "object", "x-expandableFields": [ "data" - ] - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/tax_codes": { - "get": { - "description": "

A list of all tax codes available to add to Products in order to allow specific tax calculations.

", - "operationId": "GetTaxCodes", - "parameters": [ - { - "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "in": "query", - "name": "ending_before", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "in": "query", - "name": "starting_after", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/tax_code" - }, - "type": "array" - }, - "has_more": { - "description": "True if this list has another page of items after this one that can be fetched.", - "type": "boolean" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "enum": [ - "list" - ], - "type": "string" - }, - "url": { - "description": "The URL where this list can be accessed.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ + ], + "x-stripeMostCommon": [ "data", "has_more", "object", "url" - ], - "title": "TaxProductResourceTaxCodeList", - "type": "object", - "x-expandableFields": [ - "data" ] } } @@ -155713,7 +172642,12 @@ "type" ], "title": "owner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer", + "type" + ] }, "style": "deepObject" }, @@ -155783,6 +172717,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -155855,7 +172795,12 @@ "type" ], "title": "owner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer", + "type" + ] }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", @@ -155948,7 +172893,11 @@ "type", "value" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] } } }, @@ -156140,7 +173089,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -156261,6 +173216,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -156375,7 +173336,18 @@ "inclusive", "percentage" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "metadata", + "percentage", + "state" + ] } } }, @@ -156577,7 +173549,16 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "country", + "description", + "display_name", + "jurisdiction", + "metadata", + "state" + ] } } }, @@ -156724,6 +173705,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -156800,7 +173787,10 @@ } }, "title": "bbpos_wise_pose", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -156828,7 +173818,10 @@ "enabled" ], "title": "offline", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, { "enum": [ @@ -156856,7 +173849,12 @@ "start_hour" ], "title": "reboot_window", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_reader_override", + "end_hour", + "start_hour" + ] }, "stripe_s700": { "description": "An object containing device type specific settings for Stripe S700 readers", @@ -156877,7 +173875,10 @@ } }, "title": "stripe_s700", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, "tipping": { "anyOf": [ @@ -156906,7 +173907,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "cad": { "description": "Tipping configuration for CAD", @@ -156931,7 +173937,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "chf": { "description": "Tipping configuration for CHF", @@ -156956,7 +173967,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "czk": { "description": "Tipping configuration for CZK", @@ -156981,7 +173997,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "dkk": { "description": "Tipping configuration for DKK", @@ -157006,7 +174027,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "eur": { "description": "Tipping configuration for EUR", @@ -157031,7 +174057,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "gbp": { "description": "Tipping configuration for GBP", @@ -157056,7 +174087,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "hkd": { "description": "Tipping configuration for HKD", @@ -157081,7 +174117,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "myr": { "description": "Tipping configuration for MYR", @@ -157106,7 +174147,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nok": { "description": "Tipping configuration for NOK", @@ -157131,7 +174177,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nzd": { "description": "Tipping configuration for NZD", @@ -157156,7 +174207,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sek": { "description": "Tipping configuration for SEK", @@ -157181,7 +174237,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sgd": { "description": "Tipping configuration for SGD", @@ -157206,7 +174267,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "usd": { "description": "Tipping configuration for USD", @@ -157231,11 +174297,32 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] } }, "title": "tipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aud", + "cad", + "chf", + "czk", + "dkk", + "eur", + "gbp", + "hkd", + "myr", + "nok", + "nzd", + "sek", + "sgd", + "usd" + ] }, { "enum": [ @@ -157265,10 +174352,19 @@ } }, "title": "verifone_p400", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bbpos_wisepos_e", + "stripe_s700", + "tipping", + "verifone_p400" + ] } } }, @@ -157494,7 +174590,10 @@ } }, "title": "bbpos_wise_pose", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, { "enum": [ @@ -157531,7 +174630,10 @@ "enabled" ], "title": "offline", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, { "enum": [ @@ -157560,7 +174662,12 @@ "start_hour" ], "title": "reboot_window", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_reader_override", + "end_hour", + "start_hour" + ] }, { "enum": [ @@ -157591,7 +174698,10 @@ } }, "title": "stripe_s700", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, { "enum": [ @@ -157629,7 +174739,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "cad": { "description": "Tipping configuration for CAD", @@ -157654,7 +174769,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "chf": { "description": "Tipping configuration for CHF", @@ -157679,7 +174799,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "czk": { "description": "Tipping configuration for CZK", @@ -157704,7 +174829,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "dkk": { "description": "Tipping configuration for DKK", @@ -157729,7 +174859,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "eur": { "description": "Tipping configuration for EUR", @@ -157754,7 +174889,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "gbp": { "description": "Tipping configuration for GBP", @@ -157779,7 +174919,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "hkd": { "description": "Tipping configuration for HKD", @@ -157804,7 +174949,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "myr": { "description": "Tipping configuration for MYR", @@ -157829,7 +174979,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nok": { "description": "Tipping configuration for NOK", @@ -157854,7 +175009,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nzd": { "description": "Tipping configuration for NZD", @@ -157879,7 +175039,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sek": { "description": "Tipping configuration for SEK", @@ -157904,7 +175069,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sgd": { "description": "Tipping configuration for SGD", @@ -157929,7 +175099,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "usd": { "description": "Tipping configuration for USD", @@ -157954,11 +175129,32 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] } }, "title": "tipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aud", + "cad", + "chf", + "czk", + "dkk", + "eur", + "gbp", + "hkd", + "myr", + "nok", + "nzd", + "sek", + "sgd", + "usd" + ] }, { "enum": [ @@ -157989,7 +175185,10 @@ } }, "title": "verifone_p400", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, { "enum": [ @@ -158001,7 +175200,13 @@ "description": "An object containing device type specific settings for Verifone P400 readers" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bbpos_wisepos_e", + "stripe_s700", + "tipping", + "verifone_p400" + ] } } }, @@ -158068,7 +175273,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "location" + ] } } }, @@ -158205,6 +175413,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -158284,7 +175498,15 @@ "country" ], "title": "create_location_address_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "configuration_overrides": { "description": "The ID of a configuration that will be used to customize all readers in this location.", @@ -158326,7 +175548,12 @@ "address", "display_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "display_name", + "metadata" + ] } } }, @@ -158555,7 +175782,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "configuration_overrides": { "anyOf": [ @@ -158603,7 +175838,12 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "display_name", + "metadata" + ] } } }, @@ -158804,6 +176044,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -158885,7 +176131,13 @@ "required": [ "registration_code" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "label", + "location", + "metadata", + "registration_code" + ] } } }, @@ -159116,7 +176368,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "label", + "metadata" + ] } } }, @@ -159285,17 +176541,31 @@ } }, "title": "tipping_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_eligible" + ] } }, "title": "process_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enable_customer_cancellation", + "moto", + "request_dynamic_currency_conversion", + "return_url", + "skip_tipping", + "tipping" + ] } }, "required": [ "payment_intent" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_intent" + ] } } }, @@ -159378,7 +176648,11 @@ } }, "title": "process_setup_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enable_customer_cancellation", + "moto" + ] }, "setup_intent": { "description": "SetupIntent ID", @@ -159387,10 +176661,13 @@ } }, "required": [ - "customer_consent_collected", "setup_intent" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_consent_collected", + "setup_intent" + ] } } }, @@ -159498,14 +176775,25 @@ } }, "title": "refund_payment_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enable_customer_cancellation" + ] }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.", "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "charge", + "metadata", + "payment_intent", + "refund_application_fee", + "reverse_transfer" + ] } } }, @@ -159598,7 +176886,12 @@ "quantity" ], "title": "line_item", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "quantity" + ] }, "type": "array" }, @@ -159617,7 +176910,13 @@ "total" ], "title": "cart", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "line_items", + "tax", + "total" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -159638,7 +176937,11 @@ "required": [ "type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cart", + "type" + ] } } }, @@ -159733,7 +177036,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -159787,7 +177095,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -159804,7 +177116,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -159851,7 +177167,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -159908,7 +177232,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -159929,7 +177259,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -159983,7 +177316,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -160032,7 +177368,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -160074,13 +177414,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -160107,11 +177456,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -160188,7 +177545,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -160206,7 +177566,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -160224,7 +177587,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -160245,7 +177612,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -160267,7 +177637,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -160360,7 +177733,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -160379,7 +177759,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "return_url": { "description": "Return URL used to confirm the Intent.", @@ -160431,7 +177816,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Recipient name.", @@ -160459,10 +177852,22 @@ "name" ], "title": "recipient_shipping_with_optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method", + "payment_method_data", + "return_url", + "setup_future_usage", + "shipping" + ] } } }, @@ -160546,7 +177951,11 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] } } }, @@ -160633,7 +178042,11 @@ } }, "title": "amount_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "atm_fee", + "cashback_amount" + ] }, "authorization_method": { "description": "How the card details were provided. Defaults to online.", @@ -160695,7 +178108,14 @@ } }, "title": "fleet_cardholder_prompt_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", @@ -160720,7 +178140,10 @@ } }, "title": "fleet_reported_breakdown_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", @@ -160732,7 +178155,10 @@ } }, "title": "fleet_reported_breakdown_non_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "tax": { "description": "Information about tax included in this transaction.", @@ -160749,11 +178175,20 @@ } }, "title": "fleet_reported_breakdown_tax_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] } }, "title": "fleet_reported_breakdown_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", @@ -160767,7 +178202,14 @@ } }, "title": "fleet_testmode_authorization_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "dynamic_purchase_controls_supported", + "purchase_type", + "reported_breakdown", + "service_type" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", @@ -160816,7 +178258,14 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", @@ -161168,7 +178617,18 @@ } }, "title": "merchant_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "category", + "city", + "country", + "name", + "network_id", + "postal_code", + "state", + "terminal_id", + "url" + ] }, "network_data": { "description": "Details about the authorization, such as identifiers, set by the card network.", @@ -161180,7 +178640,10 @@ } }, "title": "network_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acquiring_institution_id" + ] }, "verification_data": { "description": "Verifications that Stripe performed on information that the cardholder provided to the merchant.", @@ -161230,7 +178693,11 @@ "type" ], "title": "authentication_exemption_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "claimed_by", + "type" + ] }, "cvc_check": { "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.", @@ -161269,11 +178736,22 @@ "result" ], "title": "three_d_secure_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "result" + ] } }, "title": "verification_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address_line1_check", + "address_postal_code_check", + "authentication_exemption", + "cvc_check", + "expiry_check", + "three_d_secure" + ] }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.", @@ -161289,7 +178767,12 @@ "amount", "card" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "card", + "currency" + ] } } }, @@ -161402,7 +178885,14 @@ } }, "title": "fleet_cardholder_prompt_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", @@ -161427,7 +178917,10 @@ } }, "title": "fleet_reported_breakdown_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", @@ -161439,7 +178932,10 @@ } }, "title": "fleet_reported_breakdown_non_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "tax": { "description": "Information about tax included in this transaction.", @@ -161456,11 +178952,20 @@ } }, "title": "fleet_reported_breakdown_tax_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] } }, "title": "fleet_reported_breakdown_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", @@ -161474,7 +178979,13 @@ } }, "title": "fleet_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] }, "flight": { "description": "Information about the flight that was purchased with this transaction.", @@ -161528,7 +179039,15 @@ } }, "title": "flight_segment_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "arrival_airport_code", + "carrier", + "departure_airport_code", + "flight_number", + "service_class", + "stopover_allowed" + ] }, "type": "array" }, @@ -161539,7 +179058,14 @@ } }, "title": "flight_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "departure_at", + "passenger_name", + "refundable", + "segments", + "travel_agency" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", @@ -161588,7 +179114,14 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", @@ -161604,7 +179137,11 @@ } }, "title": "lodging_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "check_in_at", + "nights" + ] }, "receipt": { "description": "The line items in the purchase.", @@ -161626,7 +179163,13 @@ } }, "title": "receipt_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "quantity", + "total", + "unit_cost" + ] }, "type": "array" }, @@ -161637,10 +179180,23 @@ } }, "title": "purchase_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fleet", + "flight", + "fuel", + "lodging", + "receipt", + "reference" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_amount", + "close_authorization", + "purchase_details" + ] } } }, @@ -161817,7 +179373,14 @@ } }, "title": "fleet_cardholder_prompt_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", @@ -161842,7 +179405,10 @@ } }, "title": "fleet_reported_breakdown_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", @@ -161854,7 +179420,10 @@ } }, "title": "fleet_reported_breakdown_non_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "tax": { "description": "Information about tax included in this transaction.", @@ -161871,11 +179440,20 @@ } }, "title": "fleet_reported_breakdown_tax_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] } }, "title": "fleet_reported_breakdown_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", @@ -161889,7 +179467,13 @@ } }, "title": "fleet_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", @@ -161938,13 +179522,23 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] } }, "required": [ "final_amount" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "final_amount" + ] } } }, @@ -162022,7 +179616,11 @@ "required": [ "increment_amount" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "increment_amount", + "is_amount_controllable" + ] } } }, @@ -162093,7 +179691,10 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reverse_amount" + ] } } }, @@ -162603,13 +180204,20 @@ } }, "title": "rejection_reasons_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_logo", + "carrier_text" + ] } }, "required": [ "rejection_reasons" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "rejection_reasons" + ] } } }, @@ -163030,7 +180638,18 @@ } }, "title": "merchant_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "category", + "city", + "country", + "name", + "network_id", + "postal_code", + "state", + "terminal_id", + "url" + ] }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", @@ -163067,7 +180686,14 @@ } }, "title": "fleet_cardholder_prompt_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", @@ -163092,7 +180718,10 @@ } }, "title": "fleet_reported_breakdown_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", @@ -163104,7 +180733,10 @@ } }, "title": "fleet_reported_breakdown_non_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "tax": { "description": "Information about tax included in this transaction.", @@ -163121,11 +180753,20 @@ } }, "title": "fleet_reported_breakdown_tax_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] } }, "title": "fleet_reported_breakdown_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", @@ -163139,7 +180780,13 @@ } }, "title": "fleet_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] }, "flight": { "description": "Information about the flight that was purchased with this transaction.", @@ -163193,7 +180840,15 @@ } }, "title": "flight_segment_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "arrival_airport_code", + "carrier", + "departure_airport_code", + "flight_number", + "service_class", + "stopover_allowed" + ] }, "type": "array" }, @@ -163204,7 +180859,14 @@ } }, "title": "flight_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "departure_at", + "passenger_name", + "refundable", + "segments", + "travel_agency" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", @@ -163253,7 +180915,14 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", @@ -163269,7 +180938,11 @@ } }, "title": "lodging_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "check_in_at", + "nights" + ] }, "receipt": { "description": "The line items in the purchase.", @@ -163291,7 +180964,13 @@ } }, "title": "receipt_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "quantity", + "total", + "unit_cost" + ] }, "type": "array" }, @@ -163302,14 +180981,27 @@ } }, "title": "purchase_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fleet", + "flight", + "fuel", + "lodging", + "receipt", + "reference" + ] } }, "required": [ "amount", "card" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "card", + "currency" + ] } } }, @@ -163730,7 +181422,18 @@ } }, "title": "merchant_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "category", + "city", + "country", + "name", + "network_id", + "postal_code", + "state", + "terminal_id", + "url" + ] }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", @@ -163767,7 +181470,14 @@ } }, "title": "fleet_cardholder_prompt_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] }, "purchase_type": { "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", @@ -163792,7 +181502,10 @@ } }, "title": "fleet_reported_breakdown_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "non_fuel": { "description": "Breakdown of non-fuel portion of the purchase.", @@ -163804,7 +181517,10 @@ } }, "title": "fleet_reported_breakdown_non_fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] }, "tax": { "description": "Information about tax included in this transaction.", @@ -163821,11 +181537,20 @@ } }, "title": "fleet_reported_breakdown_tax_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] } }, "title": "fleet_reported_breakdown_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] }, "service_type": { "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", @@ -163839,7 +181564,13 @@ } }, "title": "fleet_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] }, "flight": { "description": "Information about the flight that was purchased with this transaction.", @@ -163893,7 +181624,15 @@ } }, "title": "flight_segment_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "arrival_airport_code", + "carrier", + "departure_airport_code", + "flight_number", + "service_class", + "stopover_allowed" + ] }, "type": "array" }, @@ -163904,7 +181643,14 @@ } }, "title": "flight_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "departure_at", + "passenger_name", + "refundable", + "segments", + "travel_agency" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", @@ -163953,7 +181699,14 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", @@ -163969,7 +181722,11 @@ } }, "title": "lodging_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "check_in_at", + "nights" + ] }, "receipt": { "description": "The line items in the purchase.", @@ -163991,7 +181748,13 @@ } }, "title": "receipt_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "quantity", + "total", + "unit_cost" + ] }, "type": "array" }, @@ -164002,14 +181765,27 @@ } }, "title": "purchase_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fleet", + "flight", + "fuel", + "lodging", + "receipt", + "reference" + ] } }, "required": [ "amount", "card" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "card", + "currency" + ] } } }, @@ -164080,7 +181856,10 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "refund_amount" + ] } } }, @@ -164226,7 +182005,10 @@ } }, "title": "card_present", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "number" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -164246,7 +182028,10 @@ } }, "title": "interac_present", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "number" + ] }, "type": { "description": "Simulated payment type.", @@ -164258,7 +182043,11 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_present", + "type" + ] } } }, @@ -164395,6 +182184,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -164450,7 +182245,11 @@ "required": [ "frozen_time" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "frozen_time", + "name" + ] } } }, @@ -164644,7 +182443,10 @@ "required": [ "frozen_time" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "frozen_time" + ] } } }, @@ -164738,10 +182540,16 @@ } }, "title": "failure_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "failure_details" + ] } } }, @@ -164961,7 +182769,10 @@ "trace_id" ], "title": "ach_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "trace_id" + ] }, "type": { "description": "The US bank account network used to send funds.", @@ -164991,20 +182802,33 @@ } }, "title": "us_domestic_wire_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "chips", + "imad", + "omad" + ] } }, "required": [ "type" ], "title": "tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "type", + "us_domestic_wire" + ] } }, "required": [ "tracking_details" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tracking_details" + ] } } }, @@ -165229,10 +183053,16 @@ } }, "title": "returned_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "returned_details" + ] } } }, @@ -165318,7 +183148,10 @@ "trace_id" ], "title": "ach_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "trace_id" + ] }, "type": { "description": "The US bank account network used to send funds.", @@ -165348,20 +183181,33 @@ } }, "title": "us_domestic_wire_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "chips", + "imad", + "omad" + ] } }, "required": [ "type" ], "title": "tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "type", + "us_domestic_wire" + ] } }, "required": [ "tracking_details" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tracking_details" + ] } } }, @@ -165586,10 +183432,16 @@ } }, "title": "returned_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "returned_details" + ] } } }, @@ -165694,14 +183546,23 @@ } }, "title": "us_bank_account_source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_name", + "account_number", + "routing_number" + ] } }, "required": [ "type" ], "title": "source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "us_bank_account" + ] }, "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", @@ -165718,7 +183579,15 @@ "financial_account", "network" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "financial_account", + "initiating_payment_method_details", + "network" + ] } } }, @@ -165823,14 +183692,23 @@ } }, "title": "us_bank_account_source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_name", + "account_number", + "routing_number" + ] } }, "required": [ "type" ], "title": "source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "us_bank_account" + ] }, "network": { "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", @@ -165846,7 +183724,15 @@ "financial_account", "network" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "financial_account", + "initiating_payment_method_details", + "network" + ] } } }, @@ -165968,7 +183854,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", @@ -166010,7 +183904,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", @@ -166052,7 +183956,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "directors_provided": { "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", @@ -166110,7 +184024,12 @@ } }, "title": "company_ownership_declaration", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "ownership_declaration_shown_and_signed": { "description": "Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.", @@ -166190,15 +184109,54 @@ } }, "title": "verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "connect_js_account_token_company_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "contact_point_verification_address", + "cross_border_transaction_classifications", + "directors_provided", + "executives_provided", + "export_license_id", + "export_purpose_code", + "fiscal_code", + "invoicing_recipient_code", + "name", + "name_kana", + "name_kanji", + "owners_provided", + "ownership_declaration", + "ownership_declaration_shown_and_signed", + "pan", + "phone", + "registered_email", + "registration_date", + "registration_number", + "stock_data", + "structure", + "tax_deduction_account_number", + "tax_id", + "tax_id_registrar", + "vat_id", + "vat_registration_status", + "verification" + ] }, "individual": { "description": "Information about the person represented by the account.", @@ -166238,7 +184196,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", @@ -166280,7 +184246,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", @@ -166322,7 +184298,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -166347,7 +184333,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -166493,7 +184484,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "Describes the person’s relationship to the account.", @@ -166531,7 +184530,17 @@ } }, "title": "individual_relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "controller", + "director", + "executive", + "officer", + "owner", + "partner", + "percent_ownership", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", @@ -166556,7 +184565,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -166573,15 +184586,50 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, "title": "individual_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "birth_city", + "birth_country", + "dob", + "email", + "first_name", + "first_name_kana", + "first_name_kanji", + "full_name_aliases", + "gender", + "id_number", + "id_number_secondary", + "last_name", + "last_name_kana", + "last_name_kanji", + "maiden_name", + "metadata", + "phone", + "political_exposure", + "registered_address", + "relationship", + "ssn_last_4", + "verification" + ] }, "tos_shown_and_accepted": { "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", @@ -166589,7 +184637,13 @@ } }, "title": "connect_js_account_token_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "business_type", + "company", + "individual", + "tos_shown_and_accepted" + ] }, "bank_account": { "description": "The bank account this token will represent.", @@ -166650,7 +184704,19 @@ ], "title": "token_create_bank_account", "type": "object", - "x-stripeBypassValidation": true + "x-stripeBypassValidation": true, + "x-stripeMostCommon": [ + "account_holder_name", + "account_holder_type", + "account_number", + "account_type", + "country", + "currency", + "debit_agreement_shown_and_accepted", + "debit_agreement_type", + "payment_method", + "routing_number" + ] }, "card": { "anyOf": [ @@ -166725,7 +184791,10 @@ } }, "title": "networks_param_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred" + ] }, "number": { "description": "The card number, as a string without any separators.", @@ -166740,6 +184809,21 @@ ], "title": "credit_card_specs", "type": "object", + "x-stripeMostCommon": [ + "address_city", + "address_country", + "address_line1", + "address_line2", + "address_state", + "address_zip", + "currency", + "cvc", + "exp_month", + "exp_year", + "name", + "networks", + "number" + ], "x-stripeParam": { "class_name": "Card" } @@ -166770,7 +184854,10 @@ "cvc" ], "title": "cvc_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cvc" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -166815,11 +184902,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "person_additional_tos_acceptances_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "representative" + ] }, "address": { "description": "The person's address.", @@ -166856,7 +184952,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", @@ -166898,7 +185002,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", @@ -166940,7 +185054,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -166965,7 +185089,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -167002,7 +185131,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", @@ -167027,7 +185159,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", @@ -167052,11 +185187,20 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "person_documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "DASHBOARD_proof_of_liveness", + "company_authorization", + "passport", + "visa" + ] }, "email": { "description": "The person's email address.", @@ -167195,7 +185339,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", @@ -167241,7 +185393,20 @@ } }, "title": "relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "controller", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "percent_ownership", + "representative", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", @@ -167265,7 +185430,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -167282,15 +185451,35 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, "title": "person_token_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "first_name", + "id_number", + "last_name", + "metadata", + "phone", + "relationship", + "ssn_last_4" + ] }, "pii": { "description": "The PII this token represents.", @@ -167302,10 +185491,21 @@ } }, "title": "pii_token_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "id_number" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "bank_account", + "card", + "cvc_update", + "person", + "pii" + ] } } }, @@ -167436,7 +185636,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -167473,7 +185679,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -167601,6 +185813,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -167695,7 +185913,13 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "metadata" + ] } } }, @@ -167854,7 +186078,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "metadata" + ] } } }, @@ -167984,7 +186212,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -168118,6 +186352,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -168211,7 +186451,14 @@ "currency", "destination" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "destination", + "metadata" + ] } } }, @@ -168358,6 +186605,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -168446,7 +186699,12 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "metadata" + ] } } }, @@ -168605,7 +186863,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "metadata" + ] } } }, @@ -168779,7 +187041,10 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata" + ] } } }, @@ -168952,6 +187217,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -169013,7 +187284,11 @@ "required": [ "received_credit" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "received_credit" + ] } } }, @@ -169268,6 +187543,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -169329,7 +187610,11 @@ "required": [ "received_debit" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "received_debit" + ] } } }, @@ -169460,7 +187745,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -169571,6 +187862,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -169643,7 +187940,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", @@ -169657,7 +187957,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", @@ -169674,11 +187977,19 @@ "requested" ], "title": "aba_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank", + "forwarding", + "requested" + ] } }, "title": "financial_addresses", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aba" + ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", @@ -169695,11 +188006,18 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] } }, "title": "inbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach" + ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", @@ -169713,7 +188031,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", @@ -169730,7 +188051,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", @@ -169744,11 +188069,18 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_payments", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", @@ -169765,7 +188097,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", @@ -169779,15 +188115,31 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] } }, "title": "feature_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "deposit_insurance", + "financial_addresses", + "inbound_transfers", + "intra_stripe_flows", + "outbound_payments", + "outbound_transfers" + ] }, "metadata": { "additionalProperties": { @@ -169817,7 +188169,13 @@ } }, "title": "platform_restrictions", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "inbound_flows", + "outbound_flows", + "received_credits", + "received_debits" + ] }, "supported_currencies": { "description": "The currencies the FinancialAccount can hold a balance in.", @@ -169831,7 +188189,13 @@ "required": [ "supported_currencies" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features", + "metadata", + "platform_restrictions", + "supported_currencies" + ] } } }, @@ -169990,7 +188354,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", @@ -170004,7 +188371,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", @@ -170021,11 +188391,19 @@ "requested" ], "title": "aba_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank", + "forwarding", + "requested" + ] } }, "title": "financial_addresses", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aba" + ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", @@ -170042,11 +188420,18 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] } }, "title": "inbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach" + ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", @@ -170060,7 +188445,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", @@ -170077,7 +188465,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", @@ -170091,11 +188483,18 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_payments", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", @@ -170112,7 +188511,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", @@ -170126,15 +188529,31 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] } }, "title": "feature_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "deposit_insurance", + "financial_addresses", + "inbound_transfers", + "intra_stripe_flows", + "outbound_payments", + "outbound_transfers" + ] }, "metadata": { "additionalProperties": { @@ -170164,10 +188583,21 @@ } }, "title": "platform_restrictions", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "inbound_flows", + "outbound_flows", + "received_credits", + "received_debits" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features", + "metadata", + "platform_restrictions" + ] } } }, @@ -170331,7 +188761,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", @@ -170345,7 +188778,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -170370,11 +188806,19 @@ "requested" ], "title": "aba_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank", + "forwarding", + "requested" + ] } }, "title": "financial_addresses", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aba" + ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", @@ -170391,11 +188835,18 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] } }, "title": "inbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach" + ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", @@ -170409,7 +188860,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", @@ -170426,7 +188880,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", @@ -170440,11 +188898,18 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_payments", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", @@ -170461,7 +188926,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", @@ -170475,14 +188944,30 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "deposit_insurance", + "financial_addresses", + "inbound_transfers", + "intra_stripe_flows", + "outbound_payments", + "outbound_transfers" + ] } } }, @@ -170645,6 +189130,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -170731,7 +189222,16 @@ "financial_account", "origin_payment_method" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "financial_account", + "metadata", + "origin_payment_method", + "statement_descriptor" + ] } } }, @@ -170929,7 +189429,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -171079,6 +189585,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -171193,7 +189705,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -171250,7 +189770,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "financial_account": { "description": "Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.", @@ -171307,14 +189833,26 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] } }, "required": [ "type" ], "title": "payment_method_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "destination_payment_method_options": { "description": "Payment method-specific configuration for this OutboundPayment.", @@ -171333,7 +189871,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "network" + ] }, { "enum": [ @@ -171346,7 +189888,10 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "us_bank_account" + ] }, "end_user_details": { "description": "End user details.", @@ -171364,7 +189909,11 @@ "present" ], "title": "end_user_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "present" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -171396,7 +189945,20 @@ "currency", "financial_account" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "destination_payment_method", + "destination_payment_method_data", + "destination_payment_method_options", + "end_user_details", + "financial_account", + "metadata", + "statement_descriptor" + ] } } }, @@ -171695,6 +190257,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -171771,7 +190339,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "network" + ] }, { "enum": [ @@ -171784,7 +190356,10 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "us_bank_account" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -171816,7 +190391,17 @@ "currency", "financial_account" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "destination_payment_method", + "destination_payment_method_options", + "financial_account", + "metadata", + "statement_descriptor" + ] } } }, @@ -172056,7 +190641,10 @@ "source_flow_type" ], "title": "linked_flows_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "source_flow_type" + ] }, "style": "deepObject" }, @@ -172141,6 +190729,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -172360,6 +190954,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -172480,7 +191080,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -172516,7 +191122,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -172663,6 +191275,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -172783,7 +191401,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -172909,7 +191533,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -172919,7 +191549,10 @@ } }, "title": "status_transition_timestamp_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "posted_at" + ] }, "style": "deepObject" } @@ -172978,6 +191611,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -173172,6 +191811,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -173628,7 +192273,14 @@ "enabled_events", "url" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "api_version", + "description", + "enabled_events", + "metadata", + "url" + ] } } }, @@ -174112,7 +192764,13 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "enabled_events", + "metadata", + "url" + ] } } },