<!--
{
  "availability" : [
    "iOS: 10.3.0 - 15.0.0",
    "iPadOS: 10.3.0 - 15.0.0",
    "macCatalyst: 13.1.0 - 15.0.0",
    "visionOS: 1.0.0 - 1.0.0",
    "watchOS: 3.2.0 - 8.0.0"
  ],
  "documentType" : "symbol",
  "framework" : "Intents",
  "identifier" : "/documentation/Intents/INBillPayee/nickname",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "Intents"
    ],
    "preciseIdentifier" : "c:objc(cs)INBillPayee(py)nickname"
  },
  "title" : "nickname"
}
-->

# nickname

A user-defined name that identifies a bill-payment account in your app.

```
@NSCopying var nickname: INSpeakableString? { get }
```

## Discussion

You should allow your users to assign custom nicknames to the payees they configure in your app. Nicknames let the user speak more naturally when talking to Siri. For example, the user might assign the nickname “cable” to an account associated with their cable television provider. When the user identifies a bill payee by its nickname, use this value to locate the corresponding account in your app.

> Note:
> In your app, don’t let the user include account numbers or other potentially sensitive information in account nicknames.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)