STPCustomer

public class STPCustomer : NSObject

extension STPCustomer: STPAPIResponseDecodable

An STPCustomer represents a deserialized Customer object from the Stripe API. You shouldn’t need to instantiate an STPCustomer – you should instead use STPCustomerContext to manage retrieving and updating a customer.

Show on GitHub

stripeID
The Stripe ID of the customer, e.g. cus_1234
Declaration
Swift

@objc public let stripeID: String
Show on GitHub
defaultSource
The default source used to charge the customer.
Declaration
Swift

@objc public private(set) var defaultSource: STPSourceProtocol? { get }
Show on GitHub
sources
The available payment sources the customer has (this may be an empty array).
Declaration
Swift

@objc public private(set) var sources: [STPSourceProtocol] { get }
Show on GitHub
email
The customer’s email address.
Declaration
Swift

@objc public private(set) var email: String? { get }
Show on GitHub
shippingAddress
The customer’s shipping address.
Declaration
Swift

@objc public var shippingAddress: STPAddress?
Show on GitHub


                    
                    
                    allResponseFields

Declaration

Swift

@objc
public let allResponseFields: [AnyHashable : Any]

Show on GitHub


                    
                    
                    init(stripeID:defaultSource:sources:)

Initialize a customer object with the provided values.

Declaration

Swift

@objc
public convenience init(
    stripeID: String,
    defaultSource: STPSourceProtocol?,
    sources: [STPSourceProtocol]
)

Parameters

`stripeID`	The ID of the customer, e.g. `cus_abc`
`defaultSource`	The default source of the customer, such as an `STPCard` object. Can be nil.
`sources`	All of the customer’s payment sources. This might be an empty array.

Return Value

an instance of STPCustomer

Show on GitHub

Description

updateSources(filteringApplePay:)
Replaces the customer’s sources and defaultSource based on whether or not they should include Apple Pay sources. More details on documentation for STPCustomerContext includeApplePaySources

@param filteringApplePay If YES, Apple Pay sources will be ignored
Declaration
Swift

@objc(updateSourcesFilteringApplePay:) public func updateSources(filteringApplePay: Bool)
Show on GitHub


                    
                    
                    decodedObject(fromAPIResponse:)

Declaration

Swift

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

Show on GitHub