STPSetupIntent

public class STPSetupIntent : NSObject, STPAPIResponseDecodable

A SetupIntent guides you through the process of setting up a customer’s payment credentials for future payments.

Seealso

https://stripe.com/docs/api/setup_intents

Show on GitHub

stripeID
The Stripe ID of the SetupIntent.
Declaration
Swift

@objc public let stripeID: String
Show on GitHub
clientSecret
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
Declaration
Swift

@objc public let clientSecret: String
Show on GitHub
created
Time at which the object was created.
Declaration
Swift

@objc public let created: Date
Show on GitHub
customerID
ID of the Customer this SetupIntent belongs to, if one exists.
Declaration
Swift

@objc public let customerID: String?
Show on GitHub
stripeDescription
An arbitrary string attached to the object. Often useful for displaying to users.
Declaration
Swift

@objc public let stripeDescription: String?
Show on GitHub
livemode
Has the value YES if the object exists in live mode or the value NO if the object exists in test mode.
Declaration
Swift

@objc public let livemode: Bool
Show on GitHub
nextAction
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 let nextAction: STPIntentAction?
Show on GitHub
paymentMethodID
ID of the payment method used with this SetupIntent.
Declaration
Swift

@objc public let paymentMethodID: String?
Show on GitHub
paymentMethod
The optionally expanded PaymentMethod used in this SetupIntent.
Declaration
Swift

@objc public let paymentMethod: STPPaymentMethod?
Show on GitHub
paymentMethodTypes
The list of payment method types (e.g. [STPPaymentMethodType.card]) that this SetupIntent is allowed to set up.
Declaration
Swift

@objc public let paymentMethodTypes: [NSNumber]
Show on GitHub
status
Status of this SetupIntent.
Declaration
Swift

@objc public let status: STPSetupIntentStatus
Show on GitHub
usage
Indicates how the payment method is intended to be used in the future.
Declaration
Swift

@objc public let usage: STPSetupIntentUsage
Show on GitHub
lastSetupError
The setup error encountered in the previous SetupIntent confirmation.
Declaration
Swift

@objc public let lastSetupError: STPSetupIntentLastSetupError?
Show on GitHub

Deprecated

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. @deprecated Metadata is not returned to clients using publishable keys. Retrieve them on your server using yoursecret key instead.

Seealso
https://stripe.com/docs/api#metadata
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 }
Show on GitHub


                    
                    
                    allResponseFields

Declaration

Swift

@objc
public let allResponseFields: [AnyHashable : Any]

Show on GitHub

STPAPIResponseDecodable


                    
                    
                    decodedObject(fromAPIResponse:)

Declaration

Swift

public class func decodedObject(fromAPIResponse response: [AnyHashable : Any]?) -> `Self`?

Show on GitHub