Value Lists
Value lists allow you to group values together which can then be referenced in rules.
Related guide: Default Stripe lists
The Value List object
Attributes
- idstring
Unique identifier for the object.
- aliasstring
The name of the value list for use in rules.
- item_
typeenum The type of items in the value list. One of
card_fingerprint
,us_bank_account_fingerprint
,sepa_debit_fingerprint
,card_bin
,email
,ip_address
,country
,string
,case_sensitive_string
, orcustomer_id
. - list_
itemsobject List of items contained within this value list.
- 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.
- namestring
The name of the value list.
More attributes
- objectstring
- createdtimestamp
- created_
bystring - livemodeboolean
Create a value list
Creates a new ValueList
object, which can then be referenced in rules.
Parameters
- aliasstringRequired
The name of the value list for use in rules.
- namestringRequired
The human-readable name of the value list.
- item_
typestring Type of the items in the value list. One of
card_fingerprint
,us_bank_account_fingerprint
,sepa_debit_fingerprint
,card_bin
,email
,ip_address
,country
,string
,case_sensitive_string
, orcustomer_id
. Usestring
if the item type is unknown or mixed. - 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
.
Returns
Returns a ValueList
object if creation succeeds.
Update a value list
Updates a ValueList
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type
is immutable.
Parameters
- aliasstring
The name of the value list for use in rules.
- 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
. - namestring
The human-readable name of the value list.
Returns
Returns an updated ValueList
object if a valid identifier was provided.
Retrieve a value list
Retrieves a ValueList
object.
Parameters
No parameters.
Returns
Returns a ValueList
object if a valid identifier was provided.