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

Type of introductory price: Pay Up Front, Pay As You Go, or Free Trial

Subscription Offer Duration

String

Duration of the introductory price if applicable. 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.

Promotional Offer Name

String

The Promotional Offer Reference Name used in App Store Connect when setting up the offer.

Promotional Offer ID

String

An identifier that you set for your subscription offers in App Store Connect. This is the value entered in the Promotional Offer Product Code field when setting up a subscription offer. For details on implementation, visit Generating a Signature for Promotional Offers.

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 ID. 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.

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

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

Type of introductory price: Pay Up Front, Pay As You Go, or Free Trial

Subscription Offer Duration

String

Duration of the introductory price if applicable. 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.

Promotional Offer Name

String

The Promotional Offer Reference Name used in App Store Connect when setting up the offer.

Promotional Offer ID

String

An identifier that you set for your subscription offers in App Store Connect. This is the value entered in the Promotional Offer Product Code field when setting up a subscription offer. For details on implementation, visit Generating a Signature for Subscription Offers.

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 ID. 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.

Sample Subscription Event Report

Event Date

Event

Subscription Name

Consecutive Paid Periods

Original Start Date

Cancellation Reason

Introductory Price Type

Quantity

2016-09-01

Start Introductory Price

1 Month Basic

0

2016-09-01

Free Trial

10

2016-09-01

Paid Subscription from Introductory Price

1 Month Basic

1

2016-08-25

Free Trial

8

2016-09-01

Renew

1 Month Basic

2

2016-08-01

14

2016-09-01

Renew

1 Month Basic

3

2016-07-01

12

2016-09-01

Cancel

1 Month Basic

1

2016-08-01

Billing Issue

3

  • 8 subscriptions converted from a free trial to a paid subscription on 2016-09-01. These subscriptions started their free trial on 2016-08-25.

  • 14 subscriptions then renewed and are moved into their second billing cycle.

  • In the next row, 12 subscriptions renewed and moved into their third billing cycle.

  • 3 subscriptions ended after one billing cycle because a billing issue was encountered when trying to renew.

Event Date

Event

Subscription Name

Consecutive Paid Periods

Original Start Date

Days Canceled

Quantity

2016-09-01

Refund

1 Month Basic

1

2016-08-15

1

2016-09-01

Reactivate

1 Month Basic

1

2016-09-01

7

2

  • 1 subscription started on 2016-08-15 but ended on 2016-09-01 with a refund for the rest of the billing cycle.

  • 2 subscriptions reactivated on 2016-09-01, after being canceled for 7 days.

Event Date

Event

Subscription Name

Consecutive Paid Periods

Original Start Date

Previous Subscription Name

Quantity

2016-09-01

Upgrade

1 Month Premium

2

2016-08-20

1 Month Basic

2

2016-09-01

Downgrade

1 Month Basic

2

2016-08-01

1 Month Premium

1

  • 2 subscriptions upgraded on 2016-09-01.

  • 1 subscription downgraded on 2016-09-01.

Event Date

Event

Subscription Name

Consecutive Paid Periods

Original Start Date

Days Before Canceling

Cancellation Reason

Quantity

2016-09-01

Cancel

1 Month Premium

1

2016-08-01

15

Canceled

2

  • 2 subscriptions canceled after one billing cycle. While the billing cycle ended on 2016-09-01, the subscribers tapped the cancel button 15 days after starting on 2016-08-01, as indicated by the column “Days Before Canceling.”

Event Date

Event

Subscription Name

Consecutive Paid Periods

Original Start Date

Cancellation Reason

Quantity

2017-10-01

Billing Retry from Paid Subscription

1 Month Basic

2

2017-09-01

11

  • On 2017-10-01 11 subscriptions were unable to renew due to a billing issue and entered into a Billing Retry status.

Event Date

Event

Subscription Name

Consecutive Paid Periods

Original Start Date

Cancellation Reason

Quantity

2017-11-01

Renewal from Billing Retry

1 Month Basic

3

2017-08-01

7

2017-11-01

Canceled from Billing Retry

1 Month Basic

2

2017-07-01

Billing Issue

4

  • On 2017-11-01, 7 subscriptions were able to successfully renew and are no longer in a Billing Retry status.

  • 4 subscriptions were canceled as they were unable to renew while in the Billing Retry status.

Event Date

Event

Subscription Name

Consecutive Paid Periods

Original Start Date

Introductory Price Type

Introductory Price Duration

Quantity

2016-09-01

Start Introductory Price

1 Month Basic

0

2016-09-01

Pay up front

3 Months

13

2016-09-01

Paid Subscription from Introductory Price

1 Month Basic

4

2016-08-25

8

2016-09-01

Renew

3 Month Basic

1

2016-08-01

Pay as you go

6 Months

14

2016-09-01

Paid Subscription from Introductory Price

3 Month Basic

3

2016-08-01

17

  • 13 subscriptions started a Pay up front Introductory Price on 2016 - 09 - 01. These subscriptions have a total Pay up front duration of 3 months.

  • 8 subscriptions converted from a 3 Month Pay up front Introductory Price to a Paid Subscription.

  • 14 subscriptions renewed into their Pay as you go Introductory Price with a total duration of 6 month.

  • 17 subscriptions also converted from a Introductory price to a Paid Subscription.

Event Date

Event

Subscription Name

Promotional Offer Name

Promotional Offer ID

Subscription Offer Type

Subscription Offer Duration

Previous Subscription Name

Quantity

2016-09-01

Start Promotional Offer

1 Month Basic

1 Month Basic Offer A

ExampleOfferIDa

Pay As You Go

1 Month

12

2016-09-01

Reactivation to Promotional Offer

1 Month Basic

1 Month Basic Offer B

ExampleOfferIDb

Pay As You Go

1 Month

1 Month Basic

67

  • 12 Promotional Offers started on 2016-09-01

  • On 2016-09-01, 67 Subscriptions reactivated to a Promotional Offer after previously canceling.