Update a cardholder

Changed on

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post/v1/issuing/cardholders/{cardholder}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/issuing/cardholders/{cardholder}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

cardholderstring required

Request body application/x-www-form-urlencoded

emailstring

The cardholder's email address.

expandstring[]

Specifies which fields in the response should be expanded.

metadataobject

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.

phone_numberstring

The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.

preferred_localesstring[]

The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.

status'active' | 'inactive'

Specifies whether to permit authorizations on this cardholder's cards.

Response

Successful response.

createdinteger required

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

emailstring nullable

The cardholder's email address.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

namestring required

The cardholder's name. This will be printed on cards issued to them.

object'issuing.cardholder' required

String representing the object's type. Objects of the same type share the same value.

phone_numberstring nullable

The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.

preferred_localesstring[] nullable

The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.

status'active' | 'blocked' | 'inactive' required

Specifies whether to permit authorizations on this cardholder's cards.

type'company' | 'individual' required

One of individual or company. See Choose a cardholder type for more details.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.