Subscriptions Card Attributes

November 13, 2025 ยท View on GitHub

Additional attributes associated with the use of this card.

Structure

SubscriptionsCardAttributes

Fields

NameTypeTagsDescriptionGetterSetter
CustomerCardCustomerOptionalThe details about a customer in PayPal's system of record.CardCustomer getCustomer()setCustomer(CardCustomer customer)
VaultVaultInstructionBaseOptionalBasic vault instruction specification that can be extended by specific payment sources that supports vaulting.VaultInstructionBase getVault()setVault(VaultInstructionBase vault)
VerificationCardVerificationOptionalThe API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).CardVerification getVerification()setVerification(CardVerification verification)

Example (as JSON)

{
  "customer": {
    "id": "id0",
    "email_address": "email_address2",
    "phone": {
      "phone_type": "OTHER",
      "phone_number": {
        "national_number": "national_number6"
      }
    },
    "merchant_customer_id": "merchant_customer_id2"
  },
  "vault": {
    "store_in_vault": "ON_SUCCESS"
  },
  "verification": {
    "method": "3D_SECURE"
  }
}