Stripe: Issuing schemas (part 1)

← Issuing operations · All schemas

Create a card — issuing post Issuing Cards — request body — body spending controls

Field	Type	Presence	Description and constraints
$	object	Root	Rules that control spending for this card. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
allowed_card_presences	array	Optional
allowed_card_presences[]	string	Each item	One of: not_present, present Maximum length: 5000
allowed_categories	array	Optional
allowed_categories[]	string	Each item	One of: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards Maximum length: 5000
allowed_merchant_countries	array	Optional
allowed_merchant_countries[]	string	Each item	Maximum length: 5000
blocked_card_presences	array	Optional
blocked_card_presences[]	string	Each item	One of: not_present, present Maximum length: 5000
blocked_categories	array	Optional
blocked_categories[]	string	Each item	One of: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards Maximum length: 5000
blocked_merchant_countries	array	Optional
blocked_merchant_countries[]	string	Each item	Maximum length: 5000
spending_limits	array	Optional
spending_limits[]	Model	Each item	Expand Create a cardholder — request body — body spending controls spending limits item

Referenced models: Create a cardholder — request body — body spending controls spending limits item

Create a cardholder — request body — body individual

Field	Type	Presence	Description and constraints
$	object	Root	Additional information about an `individual` cardholder.
card_issuing	object	Optional
card_issuing.user_terms_acceptance	object	Optional
card_issuing.user_terms_acceptance.date	integer	Optional	Format: unix-time
card_issuing.user_terms_acceptance.ip	string	Optional
card_issuing.user_terms_acceptance.user_agent	JSON	Optional
card_issuing.user_terms_acceptance.user_agent (anyOf 1)	string	Alternative	Maximum length: 5000
card_issuing.user_terms_acceptance.user_agent (anyOf 2)	string	Alternative	One of:
dob	object	Optional
dob.day	integer	Required within parent
dob.month	integer	Required within parent
dob.year	integer	Required within parent
first_name	string	Optional
last_name	string	Optional
verification	object	Optional
verification.document	object	Optional
verification.document.back	string	Optional	Maximum length: 5000
verification.document.front	string	Optional	Maximum length: 5000

Create a cardholder — request body — body spending controls

Field	Type	Presence	Description and constraints
$	object	Root	Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
allowed_card_presences	array	Optional
allowed_card_presences[]	string	Each item	One of: not_present, present Maximum length: 5000
allowed_categories	array	Optional
allowed_categories[]	string	Each item	One of: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards Maximum length: 5000
allowed_merchant_countries	array	Optional
allowed_merchant_countries[]	string	Each item	Maximum length: 5000
blocked_card_presences	array	Optional
blocked_card_presences[]	string	Each item	One of: not_present, present Maximum length: 5000
blocked_categories	array	Optional
blocked_categories[]	string	Each item	One of: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards Maximum length: 5000
blocked_merchant_countries	array	Optional
blocked_merchant_countries[]	string	Each item	Maximum length: 5000
spending_limits	array	Optional
spending_limits[]	Model	Each item	Expand Create a cardholder — request body — body spending controls spending limits item
spending_limits_currency	string	Optional

Referenced models: Create a cardholder — request body — body spending controls spending limits item

Create a cardholder — request body — body spending controls spending limits item

Field	Type	Presence	Description and constraints
$	object	Root
amount	integer	Required within parent
categories	array	Optional
categories[]	string	Each item	One of: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards Maximum length: 5000
interval	string	Required within parent	One of: all_time, daily, monthly, per_authorization, weekly, yearly

Create a cardholder — response body

Field	Type	Presence	Description and constraints
$	object	Root	An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)
billing	Model	Required within parent	Expand Create a cardholder — response body — billing
company	JSON	Optional
company (anyOf 1)	JSON	Alternative	Additional information about a `company` cardholder.
company (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — company value tax id provided
company (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
email	JSON	Optional
email (anyOf 1)	string	Alternative	The cardholder's email address. Maximum length: 5000
email (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
individual	JSON	Optional
individual (anyOf 1)	JSON	Alternative	Additional information about an `individual` cardholder.
individual (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification
individual (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
name	string	Required within parent	The cardholder's name. This will be printed on cards issued to them. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.cardholder
phone_number	JSON	Optional
phone_number (anyOf 1)	string	Alternative	The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. Maximum length: 5000
phone_number (anyOf 2)	null	Alternative
preferred_locales	JSON	Optional
preferred_locales (anyOf 1)	array	Alternative	The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder.
preferred_locales (anyOf 1)[]	string	Each item	Known values: de, en, es, fr, it
preferred_locales (anyOf 2)	null	Alternative
requirements	Model	Required within parent	Expand Create a cardholder — response body — requirements
spending_controls	JSON	Optional
spending_controls (anyOf 1)	JSON	Alternative	Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
spending_controls (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — spending controls value allowed card presences, allowed categories, allowed merchant countries, blocked card presences, blocked categories, blocked merchant countries, spending limits, spending limits currency
spending_controls (anyOf 2)	null	Alternative
status	string	Required within parent	Specifies whether to permit authorizations on this cardholder's cards. Known values: active, blocked, inactive
type	string	Required within parent	One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. Known values: company, individual

Referenced models: Create a cardholder — response body — billing, Create a cardholder — response body — spending controls value allowed card presences, allowed categories, allowed merchant countries, blocked card presences, blocked categories, blocked merchant countries, spending limits, spending limits currency, Create a cardholder — response body — company value tax id provided, Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification, Create a cardholder — response body — requirements

Create a cardholder — response body — billing

Field	Type	Presence	Description and constraints
$	object	Root
address	Model	Required within parent	Expand Create a Location — response body — address

Referenced models: Create a Location — response body — address

Create a cardholder — response body — company value tax id provided

Field	Type	Presence	Description and constraints
$	object	Root
tax_id_provided	boolean	Required within parent	Whether the company's business ID number was provided.

Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification

Field	Type	Presence	Description and constraints
$	object	Root
card_issuing	JSON	Optional
card_issuing (anyOf 1)	JSON	Alternative	Information related to the card_issuing program for this cardholder.
card_issuing (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance
card_issuing (anyOf 2)	null	Alternative
dob	JSON	Optional
dob (anyOf 1)	JSON	Alternative	The date of birth of this cardholder.
dob (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a person — accounts post Accounts Account People — response body — dob
dob (anyOf 2)	null	Alternative
first_name	JSON	Optional
first_name (anyOf 1)	string	Alternative	The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. Maximum length: 5000
first_name (anyOf 2)	null	Alternative
last_name	JSON	Optional
last_name (anyOf 1)	string	Alternative	The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. Maximum length: 5000
last_name (anyOf 2)	null	Alternative
verification	JSON	Optional
verification (anyOf 1)	JSON	Alternative	Government-issued ID document for this cardholder.
verification (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document
verification (anyOf 2)	null	Alternative

Referenced models: Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance, Create a person — accounts post Accounts Account People — response body — dob, Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document

Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance

Field	Type	Presence	Description and constraints
$	object	Root
user_terms_acceptance	JSON	Optional
user_terms_acceptance (anyOf 1)	JSON	Alternative	Information about cardholder acceptance of Celtic [Authorized User Terms](https://docs.stripe.com/issuing/compliance-us#issuing-terms). Required for cards backed by a Celtic program.
user_terms_acceptance (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance user terms acceptance value date, ip, user agent
user_terms_acceptance (anyOf 2)	null	Alternative

Referenced models: Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance user terms acceptance value date, ip, user agent

Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance user terms acceptance value date, ip, user agent

Field	Type	Presence	Description and constraints
$	object	Root
date	JSON	Optional
date (anyOf 1)	JSON	Alternative
date (anyOf 1) (anyOf 1)	integer	Alternative	The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Format: unix-time
date (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date (anyOf 2)	null	Alternative
ip	JSON	Optional
ip (anyOf 1)	string	Alternative	The IP address from which the cardholder accepted the Authorized User Terms. Maximum length: 5000
ip (anyOf 2)	null	Alternative
user_agent	JSON	Optional
user_agent (anyOf 1)	string	Alternative	The user agent of the browser from which the cardholder accepted the Authorized User Terms. Maximum length: 5000
user_agent (anyOf 2)	null	Alternative

Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document

Field	Type	Presence	Description and constraints
$	object	Root
document	JSON	Optional
document (anyOf 1)	JSON	Alternative	An identifying document, either a passport or local ID card.
document (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document document value back, front
document (anyOf 2)	null	Alternative

Referenced models: Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document document value back, front

Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document document value back, front

Field	Type	Presence	Description and constraints
$	object	Root
back	JSON	Optional
back (anyOf 1)	JSON	Alternative	The back of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`.
back (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
back (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
back (anyOf 2)	null	Alternative
front	JSON	Optional
front (anyOf 1)	JSON	Alternative	The front of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`.
front (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
front (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
front (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a cardholder — response body — requirements

Field	Type	Presence	Description and constraints
$	object	Root
disabled_reason	JSON	Optional
disabled_reason (anyOf 1)	string	Alternative	If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. Known values: listed, rejected.listed, requirements.past_due, under_review
disabled_reason (anyOf 2)	null	Alternative
past_due	JSON	Optional
past_due (anyOf 1)	array	Alternative	Array of fields that need to be collected in order to verify and re-enable the cardholder.
past_due (anyOf 1)[]	string	Each item	Known values: company.tax_id, individual.card_issuing.user_terms_acceptance.date, individual.card_issuing.user_terms_acceptance.ip, individual.dob.day, individual.dob.month, individual.dob.year, individual.first_name, individual.last_name, individual.verification.document
past_due (anyOf 2)	null	Alternative

Create a cardholder — response body — spending controls value allowed card presences, allowed categories, allowed merchant countries, blocked card presences, blocked categories, blocked merchant countries, spending limits, spending limits currency

Field	Type	Presence	Description and constraints
$	object	Root
allowed_card_presences	JSON	Optional
allowed_card_presences (anyOf 1)	array	Alternative	Array of card presence statuses from which authorizations will be allowed. Possible options are `present`, `not_present`. All other statuses will be blocked. Cannot be set with `blocked_card_presences`. Provide an empty value to unset this control.
allowed_card_presences (anyOf 1)[]	string	Each item	Known values: not_present, present
allowed_card_presences (anyOf 2)	null	Alternative
allowed_categories	JSON	Optional
allowed_categories (anyOf 1)	array	Alternative	Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
allowed_categories (anyOf 1)[]	string	Each item	Known values: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards
allowed_categories (anyOf 2)	null	Alternative
allowed_merchant_countries	JSON	Optional
allowed_merchant_countries (anyOf 1)	array	Alternative	Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
allowed_merchant_countries (anyOf 1)[]	string	Each item	Maximum length: 5000
allowed_merchant_countries (anyOf 2)	null	Alternative
blocked_card_presences	JSON	Optional
blocked_card_presences (anyOf 1)	array	Alternative	Array of card presence statuses from which authorizations will be declined. Possible options are `present`, `not_present`. Cannot be set with `allowed_card_presences`. Provide an empty value to unset this control.
blocked_card_presences (anyOf 1)[]	string	Each item	Known values: not_present, present
blocked_card_presences (anyOf 2)	null	Alternative
blocked_categories	JSON	Optional
blocked_categories (anyOf 1)	array	Alternative	Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
blocked_categories (anyOf 1)[]	string	Each item	Known values: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards
blocked_categories (anyOf 2)	null	Alternative
blocked_merchant_countries	JSON	Optional
blocked_merchant_countries (anyOf 1)	array	Alternative	Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
blocked_merchant_countries (anyOf 1)[]	string	Each item	Maximum length: 5000
blocked_merchant_countries (anyOf 2)	null	Alternative
spending_limits	JSON	Optional
spending_limits (anyOf 1)	array	Alternative	Limit spending with amount-based rules that apply across this cardholder's cards.
spending_limits (anyOf 1)[]	Model	Each item	Expand Fail a testmode card — response body — spending controls spending limits array item
spending_limits (anyOf 2)	null	Alternative
spending_limits_currency	JSON	Optional
spending_limits_currency (anyOf 1)	string	Alternative	Currency of the amounts within `spending_limits`. Format: currency
spending_limits_currency (anyOf 2)	null	Alternative

Referenced models: Fail a testmode card — response body — spending controls spending limits array item

Create a dispute — request body — body / evidence / canceled / product_type: , merchandise, service, return status: , merchant rejected, successful

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	string	Alternative
additional_documentation (anyOf 2)	string	Alternative	One of:
canceled_at	JSON	Optional
canceled_at (anyOf 1)	integer	Alternative	Format: unix-time
canceled_at (anyOf 2)	string	Alternative	One of:
cancellation_policy_provided	JSON	Optional
cancellation_policy_provided (anyOf 1)	boolean	Alternative
cancellation_policy_provided (anyOf 2)	string	Alternative	One of:
cancellation_reason	JSON	Optional
cancellation_reason (anyOf 1)	string	Alternative	Maximum length: 2500
cancellation_reason (anyOf 2)	string	Alternative	One of:
expected_at	JSON	Optional
expected_at (anyOf 1)	integer	Alternative	Format: unix-time
expected_at (anyOf 2)	string	Alternative	One of:
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Maximum length: 2500
explanation (anyOf 2)	string	Alternative	One of:
product_description	JSON	Optional
product_description (anyOf 1)	string	Alternative	Maximum length: 2500
product_description (anyOf 2)	string	Alternative	One of:
product_type	string	Optional	One of: , merchandise, service
return_status	string	Optional	One of: , merchant_rejected, successful
returned_at	JSON	Optional
returned_at (anyOf 1)	integer	Alternative	Format: unix-time
returned_at (anyOf 2)	string	Alternative	One of:

Create a dispute — request body — body / evidence / merchandise_not_as_described / return_status: , merchant rejected, successful

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	string	Alternative
additional_documentation (anyOf 2)	string	Alternative	One of:
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Maximum length: 2500
explanation (anyOf 2)	string	Alternative	One of:
received_at	JSON	Optional
received_at (anyOf 1)	integer	Alternative	Format: unix-time
received_at (anyOf 2)	string	Alternative	One of:
return_description	JSON	Optional
return_description (anyOf 1)	string	Alternative	Maximum length: 2500
return_description (anyOf 2)	string	Alternative	One of:
return_status	string	Optional	One of: , merchant_rejected, successful
returned_at	JSON	Optional
returned_at (anyOf 1)	integer	Alternative	Format: unix-time
returned_at (anyOf 2)	string	Alternative	One of:

Create a dispute — request body — body / evidence / not_received / product_type: , merchandise, service

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	string	Alternative
additional_documentation (anyOf 2)	string	Alternative	One of:
expected_at	JSON	Optional
expected_at (anyOf 1)	integer	Alternative	Format: unix-time
expected_at (anyOf 2)	string	Alternative	One of:
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Maximum length: 2500
explanation (anyOf 2)	string	Alternative	One of:
product_description	JSON	Optional
product_description (anyOf 1)	string	Alternative	Maximum length: 2500
product_description (anyOf 2)	string	Alternative	One of:
product_type	string	Optional	One of: , merchandise, service

Create a dispute — request body — body evidence

Field	Type	Presence	Description and constraints
$	object	Root	Evidence provided for the dispute.
canceled	JSON	Optional
canceled (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body / evidence / canceled / product_type: , merchandise, service, return status: , merchant rejected, successful
canceled (anyOf 2)	string	Alternative	One of:
duplicate	JSON	Optional
duplicate (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body evidence duplicate additional documentation, card statement, cash receipt, check image, explanation, original transaction
duplicate (anyOf 2)	string	Alternative	One of:
fraudulent	JSON	Optional
fraudulent (anyOf 1)	object	Alternative
fraudulent (anyOf 1).additional_documentation	JSON	Optional
fraudulent (anyOf 1).additional_documentation (anyOf 1)	string	Alternative
fraudulent (anyOf 1).additional_documentation (anyOf 2)	string	Alternative	One of:
fraudulent (anyOf 1).explanation	JSON	Optional
fraudulent (anyOf 1).explanation (anyOf 1)	string	Alternative	Maximum length: 2500
fraudulent (anyOf 1).explanation (anyOf 2)	string	Alternative	One of:
fraudulent (anyOf 2)	string	Alternative	One of:
merchandise_not_as_described	JSON	Optional
merchandise_not_as_described (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body / evidence / merchandise_not_as_described / return_status: , merchant rejected, successful
merchandise_not_as_described (anyOf 2)	string	Alternative	One of:
no_valid_authorization	JSON	Optional
no_valid_authorization (anyOf 1)	object	Alternative
no_valid_authorization (anyOf 1).additional_documentation	JSON	Optional
no_valid_authorization (anyOf 1).additional_documentation (anyOf 1)	string	Alternative
no_valid_authorization (anyOf 1).additional_documentation (anyOf 2)	string	Alternative	One of:
no_valid_authorization (anyOf 1).explanation	JSON	Optional
no_valid_authorization (anyOf 1).explanation (anyOf 1)	string	Alternative	Maximum length: 2500
no_valid_authorization (anyOf 1).explanation (anyOf 2)	string	Alternative	One of:
no_valid_authorization (anyOf 2)	string	Alternative	One of:
not_received	JSON	Optional
not_received (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body / evidence / not_received / product_type: , merchandise, service
not_received (anyOf 2)	string	Alternative	One of:
other	JSON	Optional
other (anyOf 1)	object	Alternative
other (anyOf 1).additional_documentation	JSON	Optional
other (anyOf 1).additional_documentation (anyOf 1)	string	Alternative
other (anyOf 1).additional_documentation (anyOf 2)	string	Alternative	One of:
other (anyOf 1).explanation	JSON	Optional
other (anyOf 1).explanation (anyOf 1)	string	Alternative	Maximum length: 2500
other (anyOf 1).explanation (anyOf 2)	string	Alternative	One of:
other (anyOf 1).product_description	JSON	Optional
other (anyOf 1).product_description (anyOf 1)	string	Alternative	Maximum length: 2500
other (anyOf 1).product_description (anyOf 2)	string	Alternative	One of:
other (anyOf 1).product_type	string	Optional	One of: , merchandise, service
other (anyOf 2)	string	Alternative	One of:
reason	string	Optional	One of: canceled, duplicate, fraudulent, merchandise_not_as_described, no_valid_authorization, not_received, other, service_not_as_described
service_not_as_described	JSON	Optional
service_not_as_described (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body evidence service not as described additional documentation, canceled at, cancellation reason, explanation, received at
service_not_as_described (anyOf 2)	string	Alternative	One of:

Referenced models: Create a dispute — request body — body / evidence / canceled / product_type: , merchandise, service, return status: , merchant rejected, successful, Create a dispute — request body — body evidence duplicate additional documentation, card statement, cash receipt, check image, explanation, original transaction, Create a dispute — request body — body / evidence / merchandise_not_as_described / return_status: , merchant rejected, successful, Create a dispute — request body — body / evidence / not_received / product_type: , merchandise, service, Create a dispute — request body — body evidence service not as described additional documentation, canceled at, cancellation reason, explanation, received at

Create a dispute — request body — body evidence duplicate additional documentation, card statement, cash receipt, check image, explanation, original transaction

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	string	Alternative
additional_documentation (anyOf 2)	string	Alternative	One of:
card_statement	JSON	Optional
card_statement (anyOf 1)	string	Alternative
card_statement (anyOf 2)	string	Alternative	One of:
cash_receipt	JSON	Optional
cash_receipt (anyOf 1)	string	Alternative
cash_receipt (anyOf 2)	string	Alternative	One of:
check_image	JSON	Optional
check_image (anyOf 1)	string	Alternative
check_image (anyOf 2)	string	Alternative	One of:
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Maximum length: 2500
explanation (anyOf 2)	string	Alternative	One of:
original_transaction	string	Optional	Maximum length: 5000

Create a dispute — request body — body evidence service not as described additional documentation, canceled at, cancellation reason, explanation, received at

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	string	Alternative
additional_documentation (anyOf 2)	string	Alternative	One of:
canceled_at	JSON	Optional
canceled_at (anyOf 1)	integer	Alternative	Format: unix-time
canceled_at (anyOf 2)	string	Alternative	One of:
cancellation_reason	JSON	Optional
cancellation_reason (anyOf 1)	string	Alternative	Maximum length: 2500
cancellation_reason (anyOf 2)	string	Alternative	One of:
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Maximum length: 2500
explanation (anyOf 2)	string	Alternative	One of:
received_at	JSON	Optional
received_at (anyOf 1)	integer	Alternative	Format: unix-time
received_at (anyOf 2)	string	Alternative	One of:

Create a dispute — response body

Field	Type	Presence	Description and constraints
$	object	Root	As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes)
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_transactions	JSON	Optional
balance_transactions (anyOf 1)	array	Alternative	List of balance transactions associated with the dispute.
balance_transactions (anyOf 1)[]	Model	Each item	Expand Retrieve a balance transaction — balance get Balance History Id — response body
balance_transactions (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	The currency the `transaction` was made in. Format: currency
evidence	Model	Required within parent	Expand Create a dispute — response body — evidence
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
loss_reason	string	Optional	The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values. Known values: cardholder_authentication_issuer_liability, eci5_token_transaction_with_tavv, excess_disputes_in_timeframe, has_not_met_the_minimum_dispute_amount_requirements, invalid_duplicate_dispute, invalid_incorrect_amount_dispute, invalid_no_authorization, invalid_use_of_disputes, merchandise_delivered_or_shipped, merchandise_or_service_as_described, not_cancelled, other, refund_issued, submitted_beyond_allowable_time_limit, transaction_3ds_required, transaction_approved_after_prior_fraud_dispute, transaction_authorized, transaction_electronically_read, transaction_qualifies_for_visa_easy_payment_service, transaction_unattended
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.dispute
status	string	Required within parent	Current status of the dispute. Known values: expired, lost, submitted, unsubmitted, won
transaction	JSON	Required within parent	The transaction being disputed.
transaction (anyOf 1)	string	Alternative	Maximum length: 5000
transaction (anyOf 2)	Model	Alternative	Expand Update a transaction — response body
treasury	JSON	Optional
treasury (anyOf 1)	JSON	Alternative	[Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts)
treasury (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a dispute — response body — treasury value debit reversal, received debit
treasury (anyOf 2)	null	Alternative

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Update a transaction — response body, Create a dispute — response body — evidence, Create a dispute — response body — treasury value debit reversal, received debit

Create a dispute — response body — evidence

Field	Type	Presence	Description and constraints
$	object	Root
canceled	Model	Optional	Expand Create a dispute — response body — evidence canceled
duplicate	Model	Optional	Expand Create a dispute — response body — evidence duplicate
fraudulent	Model	Optional	Expand Create a dispute — response body — evidence fraudulent
merchandise_not_as_described	Model	Optional	Expand Create a dispute — response body — evidence merchandise not as described
no_valid_authorization	Model	Optional	Expand Create a dispute — response body — evidence fraudulent
not_received	Model	Optional	Expand Create a dispute — response body — evidence not received
other	Model	Optional	Expand Create a dispute — response body — evidence other
reason	string	Required within parent	The reason for filing the dispute. Its value will match the field containing the evidence. Known values: canceled, duplicate, fraudulent, merchandise_not_as_described, no_valid_authorization, not_received, other, service_not_as_described
service_not_as_described	Model	Optional	Expand Create a dispute — response body — evidence service not as described

Referenced models: Create a dispute — response body — evidence canceled, Create a dispute — response body — evidence duplicate, Create a dispute — response body — evidence fraudulent, Create a dispute — response body — evidence merchandise not as described, Create a dispute — response body — evidence not received, Create a dispute — response body — evidence other, Create a dispute — response body — evidence service not as described

Create a dispute — response body — evidence canceled

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
additional_documentation (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
additional_documentation (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
additional_documentation (anyOf 2)	null	Alternative
canceled_at	JSON	Optional
canceled_at (anyOf 1)	JSON	Alternative
canceled_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when order was canceled. Format: unix-time
canceled_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canceled_at (anyOf 2)	null	Alternative
cancellation_policy_provided	JSON	Optional
cancellation_policy_provided (anyOf 1)	boolean	Alternative	Whether the cardholder was provided with a cancellation policy.
cancellation_policy_provided (anyOf 2)	null	Alternative
cancellation_reason	JSON	Optional
cancellation_reason (anyOf 1)	string	Alternative	Reason for canceling the order. Maximum length: 5000
cancellation_reason (anyOf 2)	null	Alternative
expected_at	JSON	Optional
expected_at (anyOf 1)	JSON	Alternative
expected_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when the cardholder expected to receive the product. Format: unix-time
expected_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expected_at (anyOf 2)	null	Alternative
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Explanation of why the cardholder is disputing this transaction. Maximum length: 5000
explanation (anyOf 2)	null	Alternative
product_description	JSON	Optional
product_description (anyOf 1)	string	Alternative	Description of the merchandise or service that was purchased. Maximum length: 5000
product_description (anyOf 2)	null	Alternative
product_type	JSON	Optional
product_type (anyOf 1)	string	Alternative	Whether the product was a merchandise or service. Known values: merchandise, service
product_type (anyOf 2)	null	Alternative
return_status	JSON	Optional
return_status (anyOf 1)	string	Alternative	Result of cardholder's attempt to return the product. Known values: merchant_rejected, successful
return_status (anyOf 2)	null	Alternative
returned_at	JSON	Optional
returned_at (anyOf 1)	JSON	Alternative
returned_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when the product was returned or attempted to be returned. Format: unix-time
returned_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
returned_at (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a dispute — response body — evidence duplicate

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
additional_documentation (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
additional_documentation (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
additional_documentation (anyOf 2)	null	Alternative
card_statement	JSON	Optional
card_statement (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
card_statement (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
card_statement (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
card_statement (anyOf 2)	null	Alternative
cash_receipt	JSON	Optional
cash_receipt (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
cash_receipt (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
cash_receipt (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
cash_receipt (anyOf 2)	null	Alternative
check_image	JSON	Optional
check_image (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
check_image (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
check_image (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
check_image (anyOf 2)	null	Alternative
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Explanation of why the cardholder is disputing this transaction. Maximum length: 5000
explanation (anyOf 2)	null	Alternative
original_transaction	JSON	Optional
original_transaction (anyOf 1)	string	Alternative	Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. Maximum length: 5000
original_transaction (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a dispute — response body — evidence fraudulent

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
additional_documentation (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
additional_documentation (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
additional_documentation (anyOf 2)	null	Alternative
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Explanation of why the cardholder is disputing this transaction. Maximum length: 5000
explanation (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a dispute — response body — evidence merchandise not as described

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
additional_documentation (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
additional_documentation (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
additional_documentation (anyOf 2)	null	Alternative
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Explanation of why the cardholder is disputing this transaction. Maximum length: 5000
explanation (anyOf 2)	null	Alternative
received_at	JSON	Optional
received_at (anyOf 1)	JSON	Alternative
received_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when the product was received. Format: unix-time
received_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
received_at (anyOf 2)	null	Alternative
return_description	JSON	Optional
return_description (anyOf 1)	string	Alternative	Description of the cardholder's attempt to return the product. Maximum length: 5000
return_description (anyOf 2)	null	Alternative
return_status	JSON	Optional
return_status (anyOf 1)	string	Alternative	Result of cardholder's attempt to return the product. Known values: merchant_rejected, successful
return_status (anyOf 2)	null	Alternative
returned_at	JSON	Optional
returned_at (anyOf 1)	JSON	Alternative
returned_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when the product was returned or attempted to be returned. Format: unix-time
returned_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
returned_at (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a dispute — response body — evidence not received

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
additional_documentation (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
additional_documentation (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
additional_documentation (anyOf 2)	null	Alternative
expected_at	JSON	Optional
expected_at (anyOf 1)	JSON	Alternative
expected_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when the cardholder expected to receive the product. Format: unix-time
expected_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expected_at (anyOf 2)	null	Alternative
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Explanation of why the cardholder is disputing this transaction. Maximum length: 5000
explanation (anyOf 2)	null	Alternative
product_description	JSON	Optional
product_description (anyOf 1)	string	Alternative	Description of the merchandise or service that was purchased. Maximum length: 5000
product_description (anyOf 2)	null	Alternative
product_type	JSON	Optional
product_type (anyOf 1)	string	Alternative	Whether the product was a merchandise or service. Known values: merchandise, service
product_type (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a dispute — response body — evidence other

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
additional_documentation (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
additional_documentation (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
additional_documentation (anyOf 2)	null	Alternative
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Explanation of why the cardholder is disputing this transaction. Maximum length: 5000
explanation (anyOf 2)	null	Alternative
product_description	JSON	Optional
product_description (anyOf 1)	string	Alternative	Description of the merchandise or service that was purchased. Maximum length: 5000
product_description (anyOf 2)	null	Alternative
product_type	JSON	Optional
product_type (anyOf 1)	string	Alternative	Whether the product was a merchandise or service. Known values: merchandise, service
product_type (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a dispute — response body — evidence service not as described

Field	Type	Presence	Description and constraints
$	object	Root
additional_documentation	JSON	Optional
additional_documentation (anyOf 1)	JSON	Alternative	(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
additional_documentation (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
additional_documentation (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
additional_documentation (anyOf 2)	null	Alternative
canceled_at	JSON	Optional
canceled_at (anyOf 1)	JSON	Alternative
canceled_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when order was canceled. Format: unix-time
canceled_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canceled_at (anyOf 2)	null	Alternative
cancellation_reason	JSON	Optional
cancellation_reason (anyOf 1)	string	Alternative	Reason for canceling the order. Maximum length: 5000
cancellation_reason (anyOf 2)	null	Alternative
explanation	JSON	Optional
explanation (anyOf 1)	string	Alternative	Explanation of why the cardholder is disputing this transaction. Maximum length: 5000
explanation (anyOf 2)	null	Alternative
received_at	JSON	Optional
received_at (anyOf 1)	JSON	Alternative
received_at (anyOf 1) (anyOf 1)	integer	Alternative	Date when the product was received. Format: unix-time
received_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
received_at (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Create a dispute — response body — treasury value debit reversal, received debit

Field	Type	Presence	Description and constraints
$	object	Root
debit_reversal	JSON	Optional
debit_reversal (anyOf 1)	string	Alternative	The Treasury [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute Maximum length: 5000
debit_reversal (anyOf 2)	null	Alternative
received_debit	string	Required within parent	The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed. Maximum length: 5000

Create a personalization design — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
card_logo	JSON	Optional
card_logo (anyOf 1)	JSON	Alternative	The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. Image must be in PNG format with dimensions of 1000px by 200px. It must be a binary (black and white) image containing a black logo on a white background. We don't accept grayscale.
card_logo (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
card_logo (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a file — response body
card_logo (anyOf 2)	null	Alternative
carrier_text	JSON	Optional
carrier_text (anyOf 1)	JSON	Alternative	Hash containing carrier text, for use with physical bundles that support carrier text.
carrier_text (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a personalization design — response body — carrier text value footer body, footer title, header body, header title
carrier_text (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
lookup_key	JSON	Optional
lookup_key (anyOf 1)	string	Alternative	A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. Maximum length: 5000
lookup_key (anyOf 2)	null	Alternative
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
name	JSON	Optional
name (anyOf 1)	string	Alternative	Friendly display name. Maximum length: 5000
name (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.personalization_design
physical_bundle	JSON	Required within parent	The physical bundle object belonging to this personalization design.
physical_bundle (anyOf 1)	string	Alternative	Maximum length: 5000
physical_bundle (anyOf 2)	Model	Alternative	Expand Retrieve a physical bundle — response body
preferences	Model	Required within parent	Expand Create a personalization design — response body — preferences
rejection_reasons	Model	Required within parent	Expand Create a personalization design — response body — rejection reasons
status	string	Required within parent	Whether this personalization design can be used to create cards. Known values: active, inactive, rejected, review

Referenced models: Create a file — response body, Retrieve a physical bundle — response body, Create a personalization design — response body — carrier text value footer body, footer title, header body, header title, Create a personalization design — response body — preferences, Create a personalization design — response body — rejection reasons

Create a personalization design — response body — carrier text value footer body, footer title, header body, header title

Field	Type	Presence	Description and constraints
$	object	Root
footer_body	JSON	Optional
footer_body (anyOf 1)	string	Alternative	The footer body text of the carrier letter. Maximum length: 5000
footer_body (anyOf 2)	null	Alternative
footer_title	JSON	Optional
footer_title (anyOf 1)	string	Alternative	The footer title text of the carrier letter. Maximum length: 5000
footer_title (anyOf 2)	null	Alternative
header_body	JSON	Optional
header_body (anyOf 1)	string	Alternative	The header body text of the carrier letter. Maximum length: 5000
header_body (anyOf 2)	null	Alternative
header_title	JSON	Optional
header_title (anyOf 1)	string	Alternative	The header title text of the carrier letter. Maximum length: 5000
header_title (anyOf 2)	null	Alternative

Create a personalization design — response body — preferences

Field	Type	Presence	Description and constraints
$	object	Root
is_default	boolean	Required within parent	Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
is_platform_default	JSON	Optional
is_platform_default (anyOf 1)	boolean	Alternative	Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.
is_platform_default (anyOf 2)	null	Alternative

Create a personalization design — response body — rejection reasons

Field	Type	Presence	Description and constraints
$	object	Root
card_logo	JSON	Optional
card_logo (anyOf 1)	array	Alternative	The reason(s) the card logo was rejected.
card_logo (anyOf 1)[]	string	Each item	Known values: geographic_location, inappropriate, network_name, non_binary_image, non_fiat_currency, other, other_entity, promotional_material
card_logo (anyOf 2)	null	Alternative
carrier_text	JSON	Optional
carrier_text (anyOf 1)	array	Alternative	The reason(s) the carrier text was rejected.
carrier_text (anyOf 1)[]	string	Each item	Known values: geographic_location, inappropriate, network_name, non_fiat_currency, other, other_entity, promotional_material
carrier_text (anyOf 2)	null	Alternative

Retrieve a physical bundle — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
features	Model	Required within parent	Expand Retrieve a physical bundle — response body — features
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
name	string	Required within parent	Friendly display name. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.physical_bundle
status	string	Required within parent	Whether this physical bundle can be used to create cards. Known values: active, inactive, review
type	string	Required within parent	Whether this physical bundle is a standard Stripe offering or custom-made for you. Known values: custom, standard

Referenced models: Retrieve a physical bundle — response body — features

Retrieve a physical bundle — response body — features

Field	Type	Presence	Description and constraints
$	object	Root
card_logo	string	Required within parent	The policy for how to use card logo images in a card design with this physical bundle. Known values: optional, required, unsupported
carrier_text	string	Required within parent	The policy for how to use carrier letter text in a card design with this physical bundle. Known values: optional, required, unsupported
second_line	string	Required within parent	The policy for how to use a second line on a card with this physical bundle. Known values: optional, required, unsupported

Update a settlement — response body

Field	Type	Presence	Description and constraints
$	object	Root	When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
bin	string	Required within parent	The Bank Identification Number reflecting this settlement record. Maximum length: 5000
clearing_date	JSON	Required within parent
clearing_date (anyOf 1)	integer	Alternative	The date that the transactions are cleared and posted to user's accounts. Format: unix-time
clearing_date (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
interchange_fees_amount	JSON	Required within parent
interchange_fees_amount (anyOf 1)	integer	Alternative	The total interchange received as reimbursement for the transactions.
interchange_fees_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
net_total_amount	JSON	Required within parent
net_total_amount (anyOf 1)	integer	Alternative	The total net amount required to settle with the network.
net_total_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
network	string	Required within parent	The card network for this settlement report. One of ["visa", "maestro", "mastercard"] Known values: maestro, mastercard, visa
network_fees_amount	JSON	Required within parent
network_fees_amount (anyOf 1)	integer	Alternative	The total amount of fees owed to the network.
network_fees_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
network_settlement_identifier	string	Required within parent	The Settlement Identification Number assigned by the network. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.settlement
settlement_service	string	Required within parent	One of `international` or `uk_national_net`. Maximum length: 5000
status	string	Required within parent	The current processing status of this settlement. Known values: complete, pending
transaction_amount	JSON	Required within parent
transaction_amount (anyOf 1)	integer	Alternative	The total transaction amount reflected in this settlement.
transaction_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
transaction_count	JSON	Required within parent
transaction_count (anyOf 1)	integer	Alternative	The total number of transactions reflected in this settlement.
transaction_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a token status — response body

Field	Type	Presence	Description and constraints
$	object	Root	An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe.
card	JSON	Required within parent	Card associated with this token.
card (anyOf 1)	string	Alternative	Maximum length: 5000
card (anyOf 2)	Model	Alternative	Expand Fail a testmode card — response body
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
device_fingerprint	JSON	Optional
device_fingerprint (anyOf 1)	string	Alternative	The hashed ID derived from the device ID from the card network associated with the token. Maximum length: 5000
device_fingerprint (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
last4	string	Optional	The last four digits of the token. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
network	string	Required within parent	The token service provider / card network associated with the token. Known values: mastercard, visa
network_data	Model	Optional	Expand Update a token status — response body — network data
network_updated_at	JSON	Required within parent
network_updated_at (anyOf 1)	integer	Alternative	Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. Format: unix-time
network_updated_at (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.token
status	string	Required within parent	The usage state of the token. Known values: active, deleted, requested, suspended
wallet_provider	string	Optional	The digital wallet for this token, if one was used. Known values: apple_pay, google_pay, samsung_pay

Referenced models: Fail a testmode card — response body, Update a token status — response body — network data

Update a token status — response body — network data

Field	Type	Presence	Description and constraints
$	object	Root
device	Model	Optional	Expand Update a token status — response body — network data device
mastercard	Model	Optional	Expand Update a token status — response body — network data mastercard
type	string	Required within parent	The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network. Known values: mastercard, visa
visa	Model	Optional	Expand Update a token status — response body — network data visa
wallet_provider	Model	Optional	Expand Update a token status — response body — network data wallet provider

Referenced models: Update a token status — response body — network data device, Update a token status — response body — network data mastercard, Update a token status — response body — network data visa, Update a token status — response body — network data wallet provider

Update a token status — response body — network data device

Field	Type	Presence	Description and constraints
$	object	Root
device_fingerprint	string	Optional	An obfuscated ID derived from the device ID. Maximum length: 5000
ip_address	string	Optional	The IP address of the device at provisioning time. Maximum length: 5000
location	string	Optional	The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal. Maximum length: 5000
name	string	Optional	The name of the device used for tokenization. Maximum length: 5000
phone_number	string	Optional	The phone number of the device used for tokenization. Maximum length: 5000
type	string	Optional	The type of device used for tokenization. Known values: other, phone, watch

Update a token status — response body — network data mastercard

Field	Type	Presence	Description and constraints
$	object	Root
card_reference_id	string	Optional	A unique reference ID from Mastercard to represent the card account number. Maximum length: 5000
token_reference_id	string	Required within parent	The network-unique identifier for the token. Maximum length: 5000
token_requestor_id	string	Required within parent	The ID of the entity requesting tokenization, specific to Mastercard. Maximum length: 5000
token_requestor_name	string	Optional	The name of the entity requesting tokenization, if known. This is directly provided from Mastercard. Maximum length: 5000

Update a token status — response body — network data visa

Field	Type	Presence	Description and constraints
$	object	Root
card_reference_id	JSON	Optional
card_reference_id (anyOf 1)	string	Alternative	A unique reference ID from Visa to represent the card account number. Maximum length: 5000
card_reference_id (anyOf 2)	null	Alternative
token_reference_id	string	Required within parent	The network-unique identifier for the token. Maximum length: 5000
token_requestor_id	string	Required within parent	The ID of the entity requesting tokenization, specific to Visa. Maximum length: 5000
token_risk_score	string	Optional	Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa. Maximum length: 5000

Update a token status — response body — network data wallet provider

Field	Type	Presence	Description and constraints
$	object	Root
account_id	string	Optional	The wallet provider-given account ID of the digital wallet the token belongs to. Maximum length: 5000
account_trust_score	JSON	Optional
account_trust_score (anyOf 1)	integer	Alternative	An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.
account_trust_score (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
card_number_source	string	Optional	The method used for tokenizing a card. Known values: app, manual, on_file, other
cardholder_address	Model	Optional	Expand Update a token status — response body — network data wallet provider cardholder address
cardholder_name	string	Optional	The name of the cardholder tokenizing the card. Maximum length: 5000
device_trust_score	JSON	Optional
device_trust_score (anyOf 1)	integer	Alternative	An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.
device_trust_score (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hashed_account_email_address	string	Optional	The hashed email address of the cardholder's account with the wallet provider. Maximum length: 5000
reason_codes	array	Optional	The reasons for suggested tokenization given by the card network.
reason_codes[]	string	Each item	Known values: account_card_too_new, account_recently_changed, account_too_new, account_too_new_since_launch, additional_device, data_expired, defer_id_v_decision, device_recently_lost, good_activity_history, has_suspended_tokens, high_risk, inactive_account, long_account_tenure, low_account_score, low_device_score, low_phone_number_score, network_service_error, outside_home_territory, provisioning_cardholder_mismatch, provisioning_device_and_cardholder_mismatch, provisioning_device_mismatch, same_device_no_prior_authentication, same_device_successful_prior_authentication, software_update, suspicious_activity, too_many_different_cardholders, too_many_recent_attempts, too_many_recent_tokens
suggested_decision	string	Optional	The recommendation on responding to the tokenization request. Known values: approve, decline, require_auth
suggested_decision_version	string	Optional	The version of the standard for mapping reason codes followed by the wallet provider. Maximum length: 5000

Referenced models: Update a token status — response body — network data wallet provider cardholder address

Update a token status — response body — network data wallet provider cardholder address

Field	Type	Presence	Description and constraints
$	object	Root
line1	string	Required within parent	The street address of the cardholder tokenizing the card. Maximum length: 5000
postal_code	string	Required within parent	The postal code of the cardholder tokenizing the card. Maximum length: 5000