PaymentMethodResponse

PaymentMethod response object. Response-specific fields model API serialization details such as nullable fields and expandable references.

  • id
    Type: string
    max length:  
    100
    required

    Unique identifier for the object.

  • type
    enum
    const:  
    card
    required

    The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

  • card
    Type: PaymentMethodCard

    PaymentMethodCard

    Properties: 15
  • billing_details
    Type: BillingDetails

    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

    Properties: 4
  • billing_address
    Type: Addressnullable
    required

    Billing address associated with the PaymentMethod, if one exists.

    Properties: 6
  • metadata

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • propertyName
      additionalPropertyType: string
  • customer
    required

    ID of an existing Customer, if one exists, or the expanded Customer object when expand=customer is requested.

    • Type: Customer ID
      max length:  
      100

      ID of an existing Customer, if one exists, or the expanded Customer object when expand=customer is requested.

  • usage
    Type: PaymentMethodUsageenumnullable

    Context in which this payment method is eligible for future reuse.

    values
    • on_session

      The payment method can be reused while the customer is present in the checkout flow.

    • off_session

      The payment method can be reused when the customer is not actively in the checkout flow.

  • reusable
    Type: boolean | null

    Whether this payment method is eligible for future reuse.

  • 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.

  • created
    Type: stringFormat: date-time
    required

    Unix timestamp when refund was created