App Revenue Attribution Record
Requires Access allowed for apps with scope using offline tokens only. This API is under a private program and is not available to all partners.
Tracks revenue that was captured outside of Shopify's billing system but needs to be attributed to the app for comprehensive revenue reporting and partner analytics. This object enables accurate revenue tracking when apps process payments through external systems while maintaining visibility into total app performance.
External revenue attribution is essential for apps that offer multiple payment channels or process certain transactions outside Shopify's billing infrastructure. For example, an enterprise app might process large custom contracts through external payment processors, or a marketplace app could handle direct merchant-to-merchant transactions that still generate app commissions.
Use the object to:
- Report revenue from external payment processors and billing systems
- Track commission-based earnings from marketplace or referral activities
- Maintain comprehensive revenue analytics across multiple payment channels
- Ensure accurate partner revenue sharing and commission calculations
- Generate complete financial reports that include all app-generated revenue streams
- Support compliance requirements for external revenue documentation
Each attribution record includes the captured amount, external transaction timestamp, and idempotency keys to prevent duplicate reporting. The record type field categorizes different revenue streams, enabling detailed analytics and reporting segmentation.
Revenue attribution records are particularly important for apps participating in Shopify's partner program, as they ensure accurate revenue sharing calculations and comprehensive performance metrics. The captured timestamp reflects when the external payment was processed, not when the attribution record was created in Shopify.
For detailed revenue attribution values, see the AppRevenueAttributionType enum.
Anchor to FieldsFields
- Anchor to amountamount•Money
V2! non-null The financial amount captured in this attribution.
- Anchor to capturedAtcaptured•Date
At Time! non-null The timestamp when the financial amount was captured.
- Anchor to createdAtcreated•Date
At Time! non-null The timestamp at which this revenue attribution was issued.
- •ID!non-null
A globally-unique ID.
- Anchor to idempotencyKeyidempotency•String!
Key non-null The unique value submitted during the creation of the app revenue attribution record. For more information, refer to Idempotent requests.
- Anchor to testtest•Boolean!non-null
Indicates whether this is a test submission.
- Anchor to typetype•App
Revenue Attribution Type! non-null The type of revenue attribution.