SetupIntent

  • Type: object · SetupIntent

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

    • created
      Type: stringFormat: date-time
      required

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • id
      Type: string
      required

      Unique identifier for the setup intent.

    • livemode
      Type: boolean
      required

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • status
      Type: stringenum
      required

      Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.

      values
      • canceled
      • processing
      • requires_action
      • requires_confirmation
      • requires_payment_method
      • succeeded
    • usage
      Type: string
      max length:  
      100
      required

      Indicates how the payment method is intended to be used in the future. Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.

    • currency
      Type: string

      ISO 4217 currency codes (alpha3) supported for payments

    • payment_method

      ID of the payment method used with this SetupIntent.

      • Type: string · PaymentMethodId

        ID of the payment method to attach to this PaymentIntent.

    • x-expansionResources
      • Type: string · PaymentMethodId

        ID of the payment method to attach to this PaymentIntent.