View charges and earnings
You can view your app's revenue and retrieve data on transactions using the following mechanisms:
Requirements
Anchor link to section titled "Requirements"To use the Partner Dashboard, you require a Partner account.
To view the Partner Dashboard's app charge overview and Payouts pages, store owners and staff require the
View financials
permission.To use the GraphQL Admin API, your app must be able to make authenticated requests to the API.
Viewing app charges in the Partner Dashboard
Anchor link to section titled "Viewing app charges in the Partner Dashboard"The following procedures explain how to view app charges and data from the Partner Dashboard:
App charge overview page
Anchor link to section titled "App charge overview page"- From the Partner Dashboard, click Apps .
- Select the app that you want to view charges for.
- On the Overview page, scroll to Latest app history.
- Optional: Select View all app history and navigate through the pages.
- In the Event Details column, click Open payments.
- To view transaction details, next to a transaction click the inverted caret (▼).
- From the Partner Dashboard, click Apps .
- In the search bar, enter the name of the store with the app charges that you want to check.
- In the search results, select the store.
- Next to the app charge that you want to check, click the link in the Details column.
Payouts page
Anchor link to section titled "Payouts page"- From the Partner Dashboard, click Apps .
- In the sidebar, click Payouts.
- On the Payouts page, click the payout with the app charges that you want to check.
- Next to the app charge that you want to check, click the link in the Type column.
- For details, next to a transaction click the inverted caret.
App history page
Anchor link to section titled "App history page"- From the Partner Dashboard, click Apps .
- Click the name of the app with the charges that you want to check.
- In the sidebar, click Insights > App history.
- In the table next to the app charge that you want to check, in the Event Details column, click Open payments.
- For details, next to a transaction click the inverted caret.
Querying billing data with the GraphQL Admin API
Anchor link to section titled "Querying billing data with the GraphQL Admin API"Use the following examples to familiarize yourself with billing data in the GraphQL Admin API. The currency code must be one of the supported currencies.
App purchases
Anchor link to section titled "App purchases"You can query a single purchase or multiple purchases.
Single app purchase
Anchor link to section titled "Single app purchase"Query a single purchase with the AppPurchaseOneTime
object. Pass the app purchase ID as an argument. You can retrieve this ID from the Payouts page.
The following is an example:
Multiple app purchases
Anchor link to section titled "Multiple app purchases"Query multiple purchases using currentAppInstallation
. Specify the number of purchases to return by passing first
or last
as an argument.
The following is an example:
App subscriptions
Anchor link to section titled "App subscriptions"You can query a single subscription or multiple subscriptions.
Single app subscription
Anchor link to section titled "Single app subscription"Query a single subscription using the AppSubscription
object. Pass the subscription ID as an argument.
The subscription ID is returned when you create a subscription. The AppSubscription
object can also return the app subscriptions that are associated with the installation.
The following is an example:
Multiple app subscriptions
Anchor link to section titled "Multiple app subscriptions"Query multiple subscriptions using currentAppInstallation
. Specify the number of subscriptions to return by passing first
or last
as an argument.
The following is an example:
App usage records
Anchor link to section titled "App usage records"Query an app usage record for a single subscription or records for multiple subscriptions. You can also query a specific app usage record by its ID.
App usage records for a single subscription
Anchor link to section titled "App usage records for a single subscription"Query the app usage record for a single subscription using the AppSubscription
object. Pass the subscription ID as an argument. You can specify the number of records to return by passing first
or last
as an argument.
The subscription ID is returned when you create a subscription. The AppSubscription
object can also return the app subscriptions that are associated with the installation.
The following is an example:
App usage records for multiple subscriptions
Anchor link to section titled "App usage records for multiple subscriptions"Query the app usage record for a single subscription using currentAppInstallation
. You can get the usageRecords
from the lineItems
field of allSubscriptions
. Specify the number of records to return by passing first
or last
as an argument.
App usage record by ID
Anchor link to section titled "App usage record by ID"Query a specific app usage record using the AppUsageRecord
object. Pass the app usage record ID as an argument.