Reference

Subscriber Report

The table shows columns for Subscriber 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.

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 Name

String

The promotional offer reference name or the offer code reference name used in App Store Connect when setting up the subscription offer.

Promotional Offer ID

String

A code that you create for customers to enter and redeem the subscription offer.

Introductory Price 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, 1 Week, 2 Weeks, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.

Marketing Opt-In Duration

String

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

Customer Price

Decimal

The price of your auto-renewable subscription.

Negative values indicate refunds.

Customer Currency

String

Three-character ISO code indicating the customer’s currency. For more information, visit Currency codes.

Developer Proceeds

Decimal

The proceeds for each item delivered.

Proceeds Currency

String

The currency in which your proceeds are earned. For more information, visit Currency codes.

Preserved Pricing

String

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

Proceeds Reason

String

If a 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.

Client

String

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

Device

String

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

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.

Subscriber ID

BigInt

The randomly generated Subscriber ID that's unique to each customer and developer. This field will be null when a customer requests a refund after the 180-day countdown described in Subscriber ID Reset.

Subscriber ID Reset

String

If a customer cancels all of their subscriptions with you and does not resubscribe within 180 days, the Subscriber ID will be deleted. If the same customer resubscribes after 180 days, then we create a new Subscriber ID and this field equals “Yes.” Otherwise, it is blank.Subscriber IDs are reset when an app is transferred to another developer account.

Refund

String

For full or partial refunds, this field equals “Yes.” Otherwise, it's blank. Refunds with a positive customer price imply a refund reversal.

Purchase Date

Date

For refunds, the date of the original purchase.

Units

Decimal

The aggregated number of units. A value of 0 may indicate a partial refund.

The below table shows columns for Subscriber 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.

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.

Promotional Offer Name

String

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

Promotional Offer ID

String

A code that you create for customers to enter and redeem the subscription offer.

Introductory Price 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, 1 Week, 2 Weeks, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.

Marketing Opt-In Duration

String

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

Customer Price

Decimal

The price of your auto-renewable subscription.

Negative values indicate refunds.

Customer Currency

String

Three-character ISO code indicating the customer’s currency. For more information, visit Currency codes.

Developer Proceeds

Decimal

The proceeds for each item delivered.

Proceeds Currency

String

The currency in which your proceeds are earned. For more information, visit Currency codes.

Preserved Pricing

String

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

Proceeds Reason

String

If a 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.

Client

String

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

Device

String

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

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.

Subscriber ID

BigInt

The randomly generated Subscriber ID that is unique to each customer and developer.

Subscriber ID Reset

String

If a customer cancels all of their subscriptions with you and does not resubscribe within 180 days, the Subscriber ID will be deleted. If the same customer resubscribes after 180 days, then we create a new Subscriber ID and this field equals “Yes.” Otherwise, it is blank.Subscriber IDs are reset when an app is transferred to another developer account.

Refund

String

For full or partial refunds, this field equals “Yes.” Otherwise, it is blank.

Purchase Date

Date

For refunds, the date of the original purchase.

Units

Decimal

The aggregated number of units. A value of 0 may indicate a partial refund.

Sample Subscriber Report

Purchases

Report on Day 1 of Initial Purchase

Title

Subscriber ID

Units

Developer Proceeds

Customer Price

1 Month Basic

7890

1

7

9.99

Report on Renewal the Next Month

Title

Subscriber ID

Units

Developer Proceeds

Customer Price

1 Month Basic

7890

1

7

9.99

The first time a customer purchases a subscription from you, a Subscriber ID is created. The same ID is reported for subsequent purchases from the same customer.

For example, Report on Day 1 of Initial Purchase shows a purchase of a 1-month subscription from a customer that is given Subscriber ID 7890. The same customer renews the next month with the same Subscriber ID.

Subscriber ID Reset

Report on Day 1 of Initial Purchase

Title

Subscriber ID

Units

Developer Proceeds

Customer Price

1 Month Basic

7890

1

7

9.99

Report 181 Days After End of Subscription

Title

Subscriber ID

Subscriber ID Reset

Units

Developer Proceeds

Customer Price

1 Month Premium

54321

Yes

1

21

29.99

If a customer cancels all of their subscriptions with you and does not resubscribe within 180 days, the Subscriber ID will be deleted. If the same customer resubscribes after 180 days, then we create a new Subscriber ID.

For example, Report on Day 1 of Initial Purchase shows a purchase of a 1-month subscription from a customer that is given Subscriber ID 7890. The same customer cancels after the first month and subscribes again 181 days later. The corresponding report shows a new Subscriber ID of 54321 along with an indication that the previous ID has been reset.

Subscriber Upgrade with Partial Credit

Report on Day 1 of Initial Purchase

Title

Subscriber ID

Units

Developer Proceeds

Customer Price

1 Month Basic

7890

1

7

9.99

Report on Day 25 of Upgrade

Title

Subscriber ID

Units

Developer Proceeds

Customer Price

Refund

1 Month Premium

7890

1

21

29.99

1 Month Basic

7890

1

1.17

-1.67

Yes

When a subscriber upgrades, the pro-rated credit is refunded and the new subscription is charged at full price, as long as the credit is not greater than the new price.

For example, Report on Day 1 shows a sale of a 1-month subscription for 9.99. On Day 25, the subscriber upgrades to a subscription priced at 29.99. Note that the upgrade goes into effect immediately. The pro-rated credit of 1.67 (9.99/30 days x 5 days left) is refunded and the full price of 29.99 is charged.