Sample - Stripe API
POST/v1/radar/value_lists

Create a value list

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

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields
aliasstringrequired
The name of the value list for use in rules.
expandarray<string>optional
Specifies which fields in the response should be expanded.
item_typestringoptional
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.
Allowed:accountcard_bincard_fingerprintcase_sensitive_stringcountrycrypto_fingerprintcustomer_idemailip_addresssepa_debit_fingerprintstringus_bank_account_fingerprint
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
namestringrequired
The human-readable name of the value list.

2 status codes
200Successful response.
aliasstringrequired
The name of the value list for use in rules.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
created_bystringrequired
The name or email address of the user who created this value list.
idstringrequired
Unique identifier for the object.
item_typestringrequired
The type of 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`.
Allowed:accountcard_bincard_fingerprintcase_sensitive_stringcountrycrypto_fingerprintcustomer_idemailip_addresssepa_debit_fingerprintstringus_bank_account_fingerprint
list_itemsobjectrequired
List of items contained within this value list.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringrequired
The name of the value list.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:radar.value_list
defaultError response.
errorobjectrequired

Error handling

Any other status is an error: Error response.