Contents

List All Promoted Purchases for an App

Get a list of promoted in-app purchases, including promoted auto-renewable subscriptions, for an app.

URL

GET https://api.appstoreconnect.apple.com/v1/apps/{id}/promotedPurchases

Path Parameters

NameTypeDescription
id Requiredstring

The opaque resource ID that uniquely identifies the Apps resource. Obtain the app resource ID from the List Apps response.

Query Parameters

NameTypeDescription
fields[inAppPurchases] Optional[string]

fields[promotedPurchases] Optional[string]

fields[subscriptions] Optional[string]

include Optional[string]

The relationship data to include in the response.

limit Optionalinteger

The number of Promoted Purchases resources to return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
PromotedPurchasesResponse

400Bad Request
Content-Type: application/json
ErrorResponse

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

404Not Found
Content-Type: application/json
ErrorResponse

429
Content-Type: application/json
ErrorResponse

Mentioned in

Discussion

Example Request and Response

See Also

Getting in-app purchase information