Value lists allow you to group values together which can then be referenced in rules.
Related guide: Default Stripe lists
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_
, orsensitive_ string customer_
.id Possible enum valuescard_
bin card_
fingerprint case_
sensitive_ string country
customer_
id email
ip_
address sepa_
debit_ fingerprint string
us_
bank_ account_ fingerprint - 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
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist"}
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_
, orsensitive_ string customer_
. Useid string
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.
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist"}
Updates a ValueList
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_
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.
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Updated IP Blocklist"}
Retrieves a ValueList
object.
Parameters
No parameters.
Returns
Returns a ValueList
object if a valid identifier was provided.
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist"}