STPCustomer

@interface STPCustomer : NSObject <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.


                    
                    
                    +customerWithStripeID:defaultSource:sources:

Initialize a customer object with the provided values.

Declaration

Objective-C

+ (nonnull instancetype)
customerWithStripeID:(nonnull NSString *)stripeID
       defaultSource:(nullable id<STPSourceProtocol>)defaultSource
             sources:(nonnull NSArray<id<STPSourceProtocol>> *)sources;

Swift

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


                    
                    
                    stripeID

The Stripe ID of the customer, e.g. cus_1234

Declaration

Objective-C

@property (readonly, copy, nonatomic) NSString *_Nonnull stripeID;

Swift

var stripeID: String { get }

Show on GitHub


                    
                    
                    defaultSource

The default source used to charge the customer.

Declaration

Objective-C

@property (readonly, nonatomic, nullable) id<STPSourceProtocol> defaultSource;

Swift

var defaultSource: STPSourceProtocol? { get }

Show on GitHub


                    
                    
                    sources

The available payment sources the customer has (this may be an empty array).

Declaration

Objective-C

@property (readonly, nonatomic) NSArray<id<STPSourceProtocol>> *_Nonnull sources;

Swift

var sources: [STPSourceProtocol] { get }

Show on GitHub


                    
                    
                    shippingAddress

The customer’s shipping address.

Declaration

Objective-C

@property (readonly, nonatomic, nullable) STPAddress *shippingAddress;

Swift

var shippingAddress: STPAddress? { get }

Show on GitHub