Setup Token Request where the source defines the type of instrument to be stored.
idstring<merchant_partner_customer_id>Optionalexpirystring<date_year_month>Optionalbrandenum<card_brand>Optionalbilling_addressobject<Portable Postal Address (Medium-Grained)>Optionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
verification_methodenum<card_verification_method>Optionalexperience_contextobject<card_experience_context>Optionallocalestring<language>Optionalvault_instructionenum<vault_instruction>OptionalDeprecateduser_actionenum<user_action>Optionalnetwork_transaction_referencenetwork_transaction_reference_requestOptionalpaypalobject<paypal_wallet_request>Optionalusage_patternenum<usage_pattern>Optionalemail_addressstring<email_address>Optionalcountry_codestringRequirednational_numberstringRequiredtypeenumOptionaladdressobject<Portable Postal Address (Medium-Grained)>Optionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
permit_multiple_payment_tokensbooleanOptionalusage_typeenumOptionalcustomer_typeenumOptionalbilling_planobject<plan>Optionalbilling_cyclesobject<billing_cycle>[]Requiredtenure_typeenumRequiredpricing_schemeobject<pricing_scheme>Optionalpriceobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpricing_modelenumRequiredreload_threshold_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredfrequencyfrequencyOptionaltotal_cyclesintegerOptional1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).start_datestring<date_no_time>Optionalproductproduct_overrideOptionalone_time_chargesobject<one_time_charges>Requiredsetup_feeobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshipping_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtaxesobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredproduct_priceobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredsubtotalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtotal_amountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredexperience_contextobject<paypal_wallet_experience_context>Optionallocalestring<language>Optionalshipping_preferenceenumOptionalvault_instructionenum<vault_instruction>OptionalDeprecatedapp_switch_contextobject<app_switch_context>Optionalnative_appobject<native_app_context>Optionalmobile_webobject<mobile_web_context>Optionalreturn_flowenumOptionaluser_actionenum<user_action>Optionalvenmoobject<venmo_request>Optionalusage_patternenum<usage_pattern>Optionalemail_addressstring<email_address>Optionalcountry_codestringRequirednational_numberstringRequiredtypeenumOptionaladdressobject<Portable Postal Address (Medium-Grained)>Optionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
permit_multiple_payment_tokensbooleanOptionalusage_typeenumOptionalcustomer_typeenumOptionalexperience_contextobject<venmo_experience_context>Optionalshipping_preferenceenumOptionalvault_instructionenum<vault_instruction>OptionalDeprecateduser_actionenum<user_action>Optionalapple_payobject<apple_pay_request>Optionaltypeenum<card_type>Optionalbrandenum<card_brand>Optionalbilling_addressobject<Portable Postal Address (Medium-Grained)>Optionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
tokenobject<token_id_request>Optionalbankobject<bank_request>Optionalach_debitobject<ach_debit_request>Optionalverification_intentach_verification_intentOptionalverificationach_debit_verificationOptionalsepa_debitobject<sepa_debit_request>Optionalmandate_intentsepa_mandate_intentOptionalexperience_contextobject<sepa_debit_experience_context>Optionallocalestring<language>Optionalreturn_urlstring<url>Requiredcancel_urlstring<url>Requiredshopper_session_idshopper_session_idOptional