Payments

The /reports/payments resource gives you the payments you can expect from app sales and in-app purchases, plus ad revenue, for all your apps.

Getting Total Payments

Request

GET /reports/payments?start_date={start_date}&end_date={end_date}&products={products}&countries={countries}

Arguments

Argument	Type	Description
start_date	Date	(yyyy-MM-dd) First date to report on, inclusive. With a granularity other than daily, we round it down to the nearest period. Default: the earliest data available.
end_date	Date	(yyyy-MM-dd) Last date to report on, inclusive. With a granularity other than daily, we round it up to the nearest period. Default: the latest data available.
group_by	List	One or more pivots, separated by commas. Available pivots: product, country, date, and store.
products	List	(productId \| productId1, productId2, …) Products to include in the response. Default: all active products in your account.
countries	List	(isoCode \| isoCode1;isoCode2;isoCodeN) Countries to limit the report to. Get country codes from /data/countries. Default: all countries.
format	String	Output format: JSON or CSV. Defaults to JSON. Note: With `format=csv`, we don’t fully serialize sub-objects (like the product in /revenue/products/…), only their reference, to avoid repetition.

Response

Field	Description
estimated_revenue	The total amount expected to be paid at the end of the month based on daily reports. This is available for all apps and from all sources, and is considered a best estimate which may not match exactly with the actual payment from the source. Common reasons for mismatches include transaction clearing times and exchange rate conversion.
financial_revenue	The total amount to be paid for iOS and Mac apps. Only Apple supports this type of revenue. It’s more accurate than `estimated_revenue`, but Apple releases it about a month after the end of the fiscal month, so it isn’t available right away.
converted_revenue	The total amount that has been paid for iOS and Mac apps. At this time only Apple is supported for this type of revenue. This revenue is 100% accurate and will match the deposit from Apple, but is only available about two months after the end of the fiscal month.
revenue	The most accurate of the three values above that’s available for the app. For iOS and Mac apps, this starts as `estimated_revenue`, switches to `financial_revenue` about 30 days after the end of the fiscal month, then to `converted_revenue` about 30 days after that. The specific times depend on Apple’s Fiscal Calendar.

Example Response

// /reports/payments?start_date=-30

{
    "revenue": 12091,
    "converted_revenue": 12091,
    "financial_revenue": 11997,
    "estimated_revenue": 11987
}

Getting Detailed Payments

You can break payments down by these dimensions:

Country
Type
Product
Storefront

Pass the dimensions in the group_by parameter. Separate multiple dimensions with a comma.

The response is nested in the order you list the dimensions.

Example Response

Get payments for each app broken down by country and type

// /reports/payments?start_date=-30

{
    "1095138104": {
        "US": {
            "app": {
                "revenue": 0,
                "converted_revenue": 0,
                "financial_revenue": 0,
                "estimated_revenue": 0,
                "product_id": 1095138104,
                "iso": "US",
                "country": "United States",
                "type": "app"
            }
        },
        ...
    }
}