<!--
{
  "availability" : [
    "App Store Server Notifications: 2.10.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "AppStoreServerNotifications",
  "identifier" : "/documentation/AppStoreServerNotifications/externalPurchaseToken",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "App Store Server Notifications"
    ],
    "preciseIdentifier" : "data:store_s2s:externalPurchaseToken"
  },
  "title" : "externalPurchaseToken"
}
-->

# externalPurchaseToken

The payload data that contains an external purchase token.

```
object externalPurchaseToken
```

## Discussion

The `externalPurchaseToken` object is part of the [`responseBodyV2DecodedPayload`](/documentation/AppStoreServerNotifications/responseBodyV2DecodedPayload). It’s present in the payload when the [`notificationType`](/documentation/AppStoreServerNotifications/notificationType) is `EXTERNAL_PURCHASE_TOKEN`. This notification type applies to apps that use the <doc://com.apple.documentation/documentation/StoreKit/external-purchase> API to offer alternative payment options.

The `externalPurchaseToken` object is the Base64URL-decoded JSON of the external purchase token your app or website receives when your customer initiates an external purchase. For more information on external purchase tokens, see <doc://com.apple.documentation/documentation/StoreKit/receiving-and-decoding-external-purchase-tokens>.

To report tokens with or without associated transactions, call the <doc://com.apple.documentation/documentation/ExternalPurchaseServerAPI/Send-External-Purchase-Report> endpoint of the <doc://com.apple.documentation/documentation/ExternalPurchaseServerAPI> from your server.

## Topics

### External purchase token fields

[`externalPurchaseId`](/documentation/AppStoreServerNotifications/externalPurchaseId)

The field of an external purchase token that uniquely identifies the token.

[`tokenCreationDate`](/documentation/AppStoreServerNotifications/tokenCreationDate)

The field of an external purchase token that contains the UNIX date, in milliseconds, when the system created the token.

[`tokenExpirationDate`](/documentation/AppStoreServerNotifications/tokenExpirationDate)

The field of a custom link token that contains the UNIX date, in milliseconds, when the token expires.

[`tokenType`](/documentation/AppStoreServerNotifications/tokenType)

The type of an external purchase custom link token.


---

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)