STPSetupIntent
public class STPSetupIntent : NSObject, STPAPIResponseDecodable
A SetupIntent guides you through the process of setting up a customer’s payment credentials for future payments.
-
The Stripe ID of the SetupIntent.
Declaration
Swift
@objc public private(set) var stripeID: String { get }
-
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
Declaration
Swift
@objc public private(set) var clientSecret: String { get }
-
Time at which the object was created.
Declaration
Swift
@objc public private(set) var created: Date? { get }
-
ID of the Customer this SetupIntent belongs to, if one exists.
Declaration
Swift
@objc public private(set) var customerID: String? { get }
-
An arbitrary string attached to the object. Often useful for displaying to users.
Declaration
Swift
@objc public private(set) var stripeDescription: String? { get }
-
Has the value
YES
if the object exists in live mode or the valueNO
if the object exists in test mode.Declaration
Swift
@objc public private(set) var livemode: Bool { get }
-
If present, this property tells you what actions you need to take in order for your customer to set up this payment method.
Declaration
Swift
@objc public private(set) var nextAction: STPIntentAction? { get }
-
ID of the payment method used with this SetupIntent.
Declaration
Swift
@objc public private(set) var paymentMethodID: String? { get }
-
The list of payment method types (e.g.
[STPPaymentMethodType.card]
) that this SetupIntent is allowed to set up.Declaration
Swift
@objc public private(set) var paymentMethodTypes: [NSNumber]? { get }
-
Status of this SetupIntent.
Declaration
Swift
@objc public private(set) var status: STPSetupIntentStatus { get }
-
Indicates how the payment method is intended to be used in the future.
Declaration
Swift
@objc public private(set) var usage: STPSetupIntentUsage { get }
-
The setup error encountered in the previous SetupIntent confirmation.
Declaration
Swift
@objc public private(set) var lastSetupError: STPSetupIntentLastSetupError? { get }
-
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. @deprecated Metadata is not returned to clients using publishable keys. Retrieve them on your server using yoursecret key instead.
Declaration
Swift
@available(*, deprecated, message: "Metadata is not returned to clients using publishable keys. Retrieve them on your server using your secret key instead.") @objc public private(set) var metadata: [String : String]? { get }
-
Declaration
Swift
@objc public private(set) var allResponseFields: [AnyHashable : Any] { get }
-
Declaration
Swift
public class func decodedObject(fromAPIResponse response: [AnyHashable : Any]?) -> `Self`?