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}/promotedPurchasesPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | An opaque resource ID that uniquely identifies the resource. Obtain the app resource ID from the List apps response. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[inAppPurchases] Optional | [string] | Additional fields to include for each in-app purchase resource returned by the response. |
fields[promotedPurchases] Optional | [string] | Additional fields to include for each promoted purchase resource returned by the response. |
fields[subscriptions] Optional | [string] | Additional fields to include for each subscription resource returned by the response. |
include Optional | [string] | The relationship data to include in the response. |
limit Optional | integer | The maximum number of promoted purchase resources to return. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | PromotedPurchasesResponse | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Content-Type: application/json | ErrorResponse |