STPCustomerContext

Objective-C

@interface STPCustomerContext : NSObject <STPBackendAPIAdapter>

Swift

class STPCustomerContext : NSObject, STPBackendAPIAdapter

An STPCustomerContext retrieves and updates a Stripe customer and their attached payment methods using an ephemeral key, a short-lived API key scoped to a specific customer object. If your current user logs out of your app and a new user logs in, be sure to either create a new instance of STPCustomerContext or clear the current instance’s cache. On your backend, be sure to create and return a new ephemeral key for the Customer object associated with the new user.

Show on GitHub

  • Initializes a new STPCustomerContext with the specified key provider. Upon initialization, a CustomerContext will fetch a new ephemeral key from your backend and use it to prefetch the customer object specified in the key. Subsequent customer and payment method retrievals (e.g. by STPPaymentContext) will return the prefetched customer / attached payment methods immediately if its age does not exceed 60 seconds.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithKeyProvider:
    (nonnull id<STPCustomerEphemeralKeyProvider>)keyProvider;

    Parameters

    keyProvider

    The key provider the customer context will use.

    Return Value

    the newly-instantiated customer context.

    Show on GitHub

  • Initializes a new STPCustomerContext with the specified key provider. Upon initialization, a CustomerContext will fetch a new ephemeral key from your backend and use it to prefetch the customer object specified in the key. Subsequent customer and payment method retrievals (e.g. by STPPaymentContext) will return the prefetched customer / attached payment methods immediately if its age does not exceed 60 seconds.

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithKeyProvider:(nonnull id<STPCustomerEphemeralKeyProvider>)keyProvider
              apiClient:(nonnull STPAPIClient *)apiClient;

    Parameters

    keyProvider

    The key provider the customer context will use.
    apiClient

    The API Client to use to make requests.

    Return Value

    the newly-instantiated customer context.

    Show on GitHub

  • STPCustomerContext will cache its customer object and associated payment methods for up to 60 seconds. If your current user logs out of your app and a new user logs in, be sure to either call this method or create a new instance of STPCustomerContext. On your backend, be sure to create and return a new ephemeral key for the customer object associated with the new user.

    Declaration

    Objective-C

    - (void)clearCache;

    Swift

    func clearCache()
    Show on GitHub

  • By default, STPCustomerContext will filter Apple Pay when it retrieves Payment Methods. Apple Pay payment methods should generally not be re-used and shouldn’t be offered to customers as a new payment method (Apple Pay payment methods may only be re-used for subscriptions).

    If you are using STPCustomerContext to back your own UI and would like to disable Apple Pay filtering, set this property to YES.

    Note: If you are using STPPaymentContext, you should not change this property.

    Declaration

    Objective-C

    @property (nonatomic) BOOL includeApplePayPaymentMethods;

    Swift

    var includeApplePayPaymentMethods: Bool { get set }
    Show on GitHub