<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "ExternalPurchaseServerAPI",
  "identifier" : "/documentation/ExternalPurchaseServerAPI/subscriptionEvent",
  "metadataVersion" : "0.1.0",
  "role" : "Type",
  "symbol" : {
    "kind" : "Type",
    "modules" : [
      "External Purchase Server API"
    ],
    "preciseIdentifier" : "data:external_purchase_server_api:subscriptionEvent"
  },
  "title" : "subscriptionEvent"
}
-->

# subscriptionEvent

The event in the subscription’s life cycle that the transaction represents.

```
string subscriptionEvent
```

## Discussion

Allowed values: `SUBSCRIPTION_START`, `RENEWAL`, `SUBSCRIPTION_CHANGE`, `SUBSCRIPTION_PAYMENT`

Use the allowed values to indicate the subscription event in a [`SubscriptionBuyLineItem`](/documentation/ExternalPurchaseServerAPI/SubscriptionBuyLineItem), as follows:

- `SUBSCRIPTION_START`: The first time you report the subscription, for example, when a customer first subscribes.
- `RENEWAL`: A subscription renewal.
- `SUBSCRIPTION_CHANGE`: The customer upgraded or downgraded the subscription.
  An *upgrade* is a change to the subscription that adds features or functionality, or increases the subscription renewal period (such as from a weekly to a monthly renewal).
  A *downgrade* is a change to the subscription that reduces features or functionality, or decreases the subscription period (such as from an annual to a monthly renewal).
- `SUBSCRIPTION_PAYMENT`: A payment for the subscription.

---

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)