Skip to content

Stripe: Create a value list

Stripe radar.postRadarValueLists: arguments, response, policy and SDK examples.

← Radar operations · Get started

Operation stripe.postradarvaluelists

Provider route: POST /v1/radar/value_lists. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["radar"]["postRadarValueLists"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.radar.postRadarValueLists(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.radar.post_radar_value_lists(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptionalMinimum length: 1
Maximum length: 255
bodyobjectRequired within parentAdditional keys: not allowed
body.aliasstringRequired within parentThe name of the value list for use in rules.
Maximum length: 100
body.expandarrayOptionalSpecifies which fields in the response should be expanded.
body.expand[]stringEach itemMaximum length: 5000
body.item_typestringOptionalType 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.
One of: account, card_bin, card_fingerprint, case_sensitive_string, country, crypto_fingerprint, customer_id, email, ip_address, sepa_debit_fingerprint, string, us_bank_account_fingerprint
Maximum length: 5000
body.metadataobjectOptionalSet 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`.
Additional keys: see wildcard field
body.metadata.*stringAdditional keys
body.namestringRequired within parentThe human-readable name of the value list.
Maximum length: 100

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a value list — response body

Referenced models: Create a value list — response body

Create a value list — response body
FieldTypePresenceDescription and constraints
$objectRootValue lists allow you to group values together which can then be referenced in rules.

Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items)
aliasstringRequired within parentThe name of the value list for use in rules.
Maximum length: 5000
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_bystringRequired within parentThe name or email address of the user who created this value list.
Maximum length: 5000
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
item_typestringRequired within parentThe 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`.
Known values: account, card_bin, card_fingerprint, case_sensitive_string, country, crypto_fingerprint, customer_id, email, ip_address, sepa_debit_fingerprint, string, us_bank_account_fingerprint
list_itemsobjectRequired within parentList of items contained within this value list.
list_items.dataarrayRequired within parentDetails about each object.
list_items.data[]ModelEach itemExpand Create a value list item — response body
list_items.has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
list_items.objectstringRequired within parentString representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
list_items.urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet 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.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
namestringRequired within parentThe name of the value list.
Maximum length: 5000
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: radar.value_list

Referenced models: Create a value list item — response body

Create a value list item — response body
FieldTypePresenceDescription and constraints
$objectRootValue list items allow you to add specific values to a given Radar value list, which can then be used in rules.

Related guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items)
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_bystringRequired within parentThe name or email address of the user who added this item to the value list.
Maximum length: 5000
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: radar.value_list_item
valuestringRequired within parentThe value of the item.
Maximum length: 5000
value_liststringRequired within parentThe identifier of the value list this item belongs to.
Maximum length: 5000

SDK function policy ID: stripe.postradarvaluelists. Catalog operation: PostRadarValueLists. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.