SetupAttempt.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / SetupAttempt.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

SetupAttempt.php

47 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* A SetupAttempt describes one attempted confirmation of a SetupIntent,
8	* whether that confirmation is successful or unsuccessful. You can use
9	* SetupAttempts to inspect details of a specific attempt at setting up a
10	* payment method using a SetupIntent.
11	*
12	* @property string $id Unique identifier for the object.
13	* @property string $object String representing the object's type. Objects of the same type share the same value.
14	* @property null\|string\|\Stripe\Application $application The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application">application</a> on the SetupIntent at the time of this confirmation.
15	* @property null\|bool $attach_to_self <p>If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.</p><p>It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.</p>
16	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
17	* @property null\|string\|\Stripe\Customer $customer The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer">customer</a> on the SetupIntent at the time of this confirmation.
18	* @property null\|string[] $flow_directions <p>Indicates the directions of money movement for which this payment method is intended to be used.</p><p>Include <code>inbound</code> if you intend to use the payment method as the origin to pull funds from. Include <code>outbound</code> 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.</p>
19	* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
20	* @property null\|string\|\Stripe\Account $on_behalf_of The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of">on_behalf_of</a> on the SetupIntent at the time of this confirmation.
21	* @property string\|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupAttempt.
22	* @property \Stripe\StripeObject $payment_method_details
23	* @property null\|\Stripe\StripeObject $setup_error The error encountered during this attempt to confirm the SetupIntent, if any.
24	* @property string\|\Stripe\SetupIntent $setup_intent ID of the SetupIntent that this attempt belongs to.
25	* @property string $status Status of this SetupAttempt, one of <code>requires_confirmation</code>, <code>requires_action</code>, <code>processing</code>, <code>succeeded</code>, <code>failed</code>, or <code>abandoned</code>.
26	* @property string $usage The value of <a href="https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage">usage</a> on the SetupIntent at the time of this confirmation, one of <code>off_session</code> or <code>on_session</code>.
27	*/
28	class SetupAttempt extends ApiResource
29	{
30	const OBJECT_NAME = 'setup_attempt';
31	/**
32	* Returns a list of SetupAttempts that associate with a provided SetupIntent.
33	*
34	* @param null\|array $params
35	* @param null\|array\|string $opts
36	*
37	* @throws \Stripe\Exception\ApiErrorException if the request fails
38	*
39	* @return \Stripe\Collection<\Stripe\SetupAttempt> of ApiResources
40	*/
41	public static function all($params = null, $opts = null)
42	{
43	$url = static::classUrl();
44	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
45	}
46	}
47