Create a value list

Creates a new ValueList object, which can then be referenced in rules.

Returns

Returns a ValueList object if creation succeeds.

Parameters

• alias (string, required) The name of the value list for use in rules.

  The maximum length is 100 characters.

• name (string, required) The human-readable name of the value list.

  The maximum length is 100 characters.

• item_type (string, optional) Type of the items in the value list. One of card_fingerprint, card_bin, crypto_fingerprint, email, ip_address, country, string, case_sensitive_string, customer_id, account, sepa_debit_fingerprint, or us_bank_account_fingerprint. Use string if the item type is unknown or mixed.

• metadata (object, optional) 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.

curl https://api.stripe.com/v1/radar/value_lists \
  -u "<<YOUR_SECRET_KEY>>" \
  -d "name=Custom IP Blocklist" \
  -d alias=custom_ip_blocklist \
  -d item_type=ip_address

Response

{
  "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"
}