SetupAttempt.php 2.4 KB

1234567891011121314151617181920212223242526272829303132
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * A SetupAttempt describes one attempted confirmation of a SetupIntent, whether
  6. * that confirmation was successful or unsuccessful. You can use SetupAttempts to
  7. * inspect details of a specific attempt at setting up a payment method using a
  8. * SetupIntent.
  9. *
  10. * @property string $id Unique identifier for the object.
  11. * @property string $object String representing the object's type. Objects of the same type share the same value.
  12. * @property null|string|\Stripe\StripeObject $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.
  13. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  14. * @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.
  15. * @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.
  16. * @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.
  17. * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupAttempt.
  18. * @property \Stripe\StripeObject $payment_method_details
  19. * @property null|\Stripe\ErrorObject $setup_error The error encountered during this attempt to confirm the SetupIntent, if any.
  20. * @property string|\Stripe\SetupIntent $setup_intent ID of the SetupIntent that this attempt belongs to.
  21. * @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>.
  22. * @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>.
  23. */
  24. class SetupAttempt extends ApiResource
  25. {
  26. const OBJECT_NAME = 'setup_attempt';
  27. use ApiOperations\All;
  28. }