SCPSetupIntentParameters

Objective-C


@interface SCPSetupIntentParameters : NSObject

Swift

class SetupIntentParameters : NSObject

Parameters for creating an SCPSetupIntent.

  • ID of the customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent’s payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *customer;

    Swift

    var customer: String? { get set }
  • An arbitrary string attached to the object. Often useful for displaying to users.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *stripeDescription;

    Swift

    var stripeDescription: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSDictionary *metadata;

    Swift

    var metadata: [AnyHashable : Any]? { get set }
  • Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to SCPSetupIntentUsageOffSession.

    Declaration

    Objective-C

    @property (nonatomic) SCPSetupIntentUsage usage;

    Swift

    var usage: SetupIntentUsage { get set }
  • Connect Only:** The Stripe account ID for which this SetupIntent is created.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *onBehalfOf;

    Swift

    var onBehalfOf: String? { get set }
  • Initializes SCPSetupIntentParameters with the given customer ID.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCustomer:(NSString *_Nullable)customerId;

    Swift

    init(customer customerId: String?)

    Parameters

    customerId

    ID of the customer this SetupIntent belongs to, if one exists. Stripe will attach this SetupIntent to the customer on successful creation.

  • Unavailable

    Use initWithCustomer:

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Unavailable

    Use initWithCustomer:

    Declaration

    Objective-C

    + (nonnull instancetype)new;
  • Deprecated

    Did you mean to use stripeDescription?

    Use stripeDescription for the string attached to the object.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE("Did you mean to use stripeDescription?") NSString *description;

    Swift

    var description: String { get }