class Stripe::SetupAttemptsApi
- Stripe::SetupAttemptsApi
- Reference
- Object
Defined in:
stripe/api/setup_attempts_api.crConstant Summary
-
GET_SETUP_ATTEMPTS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_SETUP_ATTEMPTS_MAX_LENGTH_FOR_SETUP_INTENT =
5000
-
GET_SETUP_ATTEMPTS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_setup_attempts(*, setup_intent : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_setup_attempts(*, setup_intent : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::PaymentFlowsSetupIntentSetupAttemptList
Returns a list of SetupAttempts that associate with a provided SetupIntent.
@required @param setup_intent [String?] Only return SetupAttempts created by the SetupIntent specified by this ID. -
#get_setup_attempts(*, setup_intent : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of SetupAttempts that associate with a provided SetupIntent.</p> @required @param setup_intent [String?] Only return SetupAttempts created by the SetupIntent specified by this ID.
-
#get_setup_attempts_with_http_info(*, setup_intent : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::PaymentFlowsSetupIntentSetupAttemptList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of SetupAttempts that associate with a provided SetupIntent.</p> @required @param setup_intent [String?] Only return SetupAttempts created by the SetupIntent specified by this ID.
Constructor Detail
Instance Method Detail
@return Crest::Request
Returns a list of SetupAttempts that associate with a provided SetupIntent.
@required @param setup_intent [String?] Only return SetupAttempts created by the SetupIntent specified by this ID. @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentFlowsSetupIntentSetupAttemptList]<p>Returns a list of SetupAttempts that associate with a provided SetupIntent.</p>
@required @param setup_intent [String?] Only return SetupAttempts created by the SetupIntent specified by this ID.
@optional @param ending_before [String?] 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.
@optional @param starting_after [String?] 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.
@optional @param created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object created
field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
<p>Returns a list of SetupAttempts that associate with a provided SetupIntent.</p>
@required @param setup_intent [String?] Only return SetupAttempts created by the SetupIntent specified by this ID.
@optional @param ending_before [String?] 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.
@optional @param starting_after [String?] 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.
@optional @param created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object created
field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::PaymentFlowsSetupIntentSetupAttemptList, Integer, Hash)] Stripe::PaymentFlowsSetupIntentSetupAttemptList, response status code and response headers