App Store Connect Help

Support / App Store Connect / Reference / Subscription Event Report

Reference

Subscription Event Report

The below table shows columns for Subscription Event Report Version 1_3.

Tip: To better understand the values below, view a sample report.

Report Field

Data Type

Notes

Event Date

Date

Date the event occurred.

Event

String

Type of event that occurred. For more information, visit Subscription events.

App Name

String

Title of your subscription’s parent app.

App Apple ID

BigInt

Apple ID of your subscription’s parent app.

Subscription Name

String

Title of your subscription.

Subscription Apple ID

BigInt

Apple ID of your subscription.

Subscription Group ID

BigInt

Your subscription’s Group ID (formerly Family ID).

Standard Subscription Duration

String

Duration of the standard subscription: 7 Days, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.

Subscription Offer Type

String

Subscription offer pricing: Pay Up Front, Pay As You Go, or Free Trial

Subscription Offer Duration

String

Duration of the subscription offer. For example: 3 Days, 7 Days, 2 Weeks, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.

Marketing Opt-In

String

If the subscription included a marketing opt-in then this field equals “Yes”. Otherwise, it is blank.

Marketing Opt-In Duration

String

Duration of the opt-in if applicable: 7 Days, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.

Preserved Pricing

String

For Renew events, if the price is preserved then this field equals “Yes”. Otherwise, it is blank.

Proceeds Reason

String

For Renew events, if the subscription has been active for more than a year then you receive 85% of the customer price, minus applicable taxes, and this field equals “Rate After One Year”. Otherwise, you receive 70% and the field is blank.

Subscription Offer Name

String

Offer reference name that you set for your subscription offers in App Store Connect.

Promotional Offer ID

String

An identifier that you set for your subscription offers in App Store Connect.

Consecutive Paid Periods

Int

The total number of paid periods that the subscription has been active without cancellation. This does not include free trials, marketing opt-in bonus periods, or grace periods.

Original Start Date

Date

Date of the initial subscription purchase.

Device

String

Type of device used for initial subscription purchase: iPhone, iPad, iPod touch, Desktop, Apple TV, or Apple Vision.

Client

String

If the subscription was purchased from News then this field equals “News”. Otherwise, it is blank.

State

String

State field in the address submitted by the customer when signing up for their Apple Account. This field is not validated and may be blank.

Country

String

Two-character ISO country code indicating the App Store country or region for the purchase. For more information, visit Financial report regions and currencies

Previous Subscription Name

String

For upgrade, downgrade, and crossgrade events, the title of the previous subscription.

Previous Subscription Apple ID

BigInt

For upgrade, downgrade, and crossgrade events, the Apple ID of the previous subscription.

Days Before Canceling

Int

For cancel events, the number of days from the start date to when a subscriber canceled, which could be in the middle of the period. This only applies to cancel events where cancellation reason equals ‘canceled.' Otherwise, it is blank.

Cancellation Reason

String

Reason for a cancellation: Billing issue, Price increase, Canceled, Removed from Sale, or Other. For more information, visit Cancellation reasons.

Days Canceled

Int

For reactivate events, the number of days ago that the subscriber canceled.

Quantity

Int

Number of events with the same values for the other fields.

Paid Service Days Recovered

Int

The estimated number of paid service days recovered due to Billing Grace Period.