{ "opencollection": "1.0.0", "info": { "name": "App Store Connect AccessibilityDeclarations Subscriptions API", "version": "4.3.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Create Subscriptions", "type": "http" }, "http": { "method": "POST", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions", "body": { "type": "json", "data": "{}" } }, "docs": "Create Subscriptions" }, { "info": { "name": "Get Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "fields[subscriptionLocalizations]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionLocalizations" }, { "name": "fields[subscriptionAppStoreReviewScreenshots]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots" }, { "name": "fields[subscriptionGroups]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionGroups" }, { "name": "fields[subscriptionIntroductoryOffers]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers" }, { "name": "fields[subscriptionPromotionalOffers]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPromotionalOffers" }, { "name": "fields[subscriptionOfferCodes]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionOfferCodes" }, { "name": "fields[subscriptionPrices]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPrices" }, { "name": "fields[promotedPurchases]", "value": "", "type": "query", "description": "the fields to include for returned resources of type promotedPurchases" }, { "name": "fields[subscriptionAvailabilities]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionAvailabilities" }, { "name": "fields[winBackOffers]", "value": "", "type": "query", "description": "the fields to include for returned resources of type winBackOffers" }, { "name": "fields[subscriptionImages]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionImages" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" }, { "name": "limit[images]", "value": "", "type": "query", "description": "maximum number of related images returned (when they are included)" }, { "name": "limit[introductoryOffers]", "value": "", "type": "query", "description": "maximum number of related introductoryOffers returned (when they are included)" }, { "name": "limit[offerCodes]", "value": "", "type": "query", "description": "maximum number of related offerCodes returned (when they are included)" }, { "name": "limit[prices]", "value": "", "type": "query", "description": "maximum number of related prices returned (when they are included)" }, { "name": "limit[promotionalOffers]", "value": "", "type": "query", "description": "maximum number of related promotionalOffers returned (when they are included)" }, { "name": "limit[subscriptionLocalizations]", "value": "", "type": "query", "description": "maximum number of related subscriptionLocalizations returned (when they are included)" }, { "name": "limit[winBackOffers]", "value": "", "type": "query", "description": "maximum number of related winBackOffers returned (when they are included)" } ] }, "docs": "Get Subscriptions" }, { "info": { "name": "Update Subscriptions", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Subscriptions" }, { "info": { "name": "Delete Subscriptions", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" } ] }, "docs": "Delete Subscriptions" }, { "info": { "name": "Get Related Subscriptions / App Store Review Screenshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/appStoreReviewScreenshot", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" } ] }, "docs": "Get Related Subscriptions / App Store Review Screenshot" }, { "info": { "name": "Get Related Subscriptions / App Store Review Screenshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/appStoreReviewScreenshot", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "fields[subscriptionAppStoreReviewScreenshots]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionAppStoreReviewScreenshots" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" } ] }, "docs": "Get Related Subscriptions / App Store Review Screenshot" }, { "info": { "name": "List Related Subscriptions / Images", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/images", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Images" }, { "info": { "name": "List Related Subscriptions / Images", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/images", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "fields[subscriptionImages]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionImages" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" } ] }, "docs": "List Related Subscriptions / Images" }, { "info": { "name": "List Related Subscriptions / Introductory Offers", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/introductoryOffers", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Introductory Offers" }, { "info": { "name": "Remove Related Subscriptions / Introductory Offers", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/introductoryOffers", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Related Subscriptions / Introductory Offers" }, { "info": { "name": "List Related Subscriptions / Introductory Offers", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/introductoryOffers", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "filter[territory]", "value": "", "type": "query", "description": "filter by id(s) of related 'territory'" }, { "name": "fields[subscriptionIntroductoryOffers]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionIntroductoryOffers" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "fields[territories]", "value": "", "type": "query", "description": "the fields to include for returned resources of type territories" }, { "name": "fields[subscriptionPricePoints]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPricePoints" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" } ] }, "docs": "List Related Subscriptions / Introductory Offers" }, { "info": { "name": "List Related Subscriptions / Offer Codes", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/offerCodes", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Offer Codes" }, { "info": { "name": "List Related Subscriptions / Offer Codes", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/offerCodes", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "filter[territory]", "value": "", "type": "query", "description": "filter by territory" }, { "name": "fields[subscriptionOfferCodes]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionOfferCodes" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "fields[subscriptionOfferCodeOneTimeUseCodes]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionOfferCodeOneTimeUseCodes" }, { "name": "fields[subscriptionOfferCodeCustomCodes]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionOfferCodeCustomCodes" }, { "name": "fields[subscriptionOfferCodePrices]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionOfferCodePrices" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" }, { "name": "limit[oneTimeUseCodes]", "value": "", "type": "query", "description": "maximum number of related oneTimeUseCodes returned (when they are included)" }, { "name": "limit[customCodes]", "value": "", "type": "query", "description": "maximum number of related customCodes returned (when they are included)" }, { "name": "limit[prices]", "value": "", "type": "query", "description": "maximum number of related prices returned (when they are included)" } ] }, "docs": "List Related Subscriptions / Offer Codes" }, { "info": { "name": "List Related Subscriptions / Price Points", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/pricePoints", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Price Points" }, { "info": { "name": "List Related Subscriptions / Price Points", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/pricePoints", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "filter[territory]", "value": "", "type": "query", "description": "filter by id(s) of related 'territory'" }, { "name": "fields[subscriptionPricePoints]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPricePoints" }, { "name": "fields[territories]", "value": "", "type": "query", "description": "the fields to include for returned resources of type territories" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" } ] }, "docs": "List Related Subscriptions / Price Points" }, { "info": { "name": "List Related Subscriptions / Prices", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/prices", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Prices" }, { "info": { "name": "Remove Related Subscriptions / Prices", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/prices", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Related Subscriptions / Prices" }, { "info": { "name": "List Related Subscriptions / Prices", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/prices", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "filter[subscriptionPricePoint]", "value": "", "type": "query", "description": "filter by id(s) of related 'subscriptionPricePoint'" }, { "name": "filter[territory]", "value": "", "type": "query", "description": "filter by id(s) of related 'territory'" }, { "name": "fields[subscriptionPrices]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPrices" }, { "name": "fields[territories]", "value": "", "type": "query", "description": "the fields to include for returned resources of type territories" }, { "name": "fields[subscriptionPricePoints]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPricePoints" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" } ] }, "docs": "List Related Subscriptions / Prices" }, { "info": { "name": "Get Related Subscriptions / Promoted Purchase", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/promotedPurchase", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" } ] }, "docs": "Get Related Subscriptions / Promoted Purchase" }, { "info": { "name": "Get Related Subscriptions / Promoted Purchase", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/promotedPurchase", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "fields[promotedPurchases]", "value": "", "type": "query", "description": "the fields to include for returned resources of type promotedPurchases" }, { "name": "fields[inAppPurchases]", "value": "", "type": "query", "description": "the fields to include for returned resources of type inAppPurchases" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" } ] }, "docs": "Get Related Subscriptions / Promoted Purchase" }, { "info": { "name": "List Related Subscriptions / Promotional Offers", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/promotionalOffers", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Promotional Offers" }, { "info": { "name": "List Related Subscriptions / Promotional Offers", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/promotionalOffers", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "filter[territory]", "value": "", "type": "query", "description": "filter by territory" }, { "name": "fields[subscriptionPromotionalOffers]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPromotionalOffers" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "fields[subscriptionPromotionalOfferPrices]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionPromotionalOfferPrices" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" }, { "name": "limit[prices]", "value": "", "type": "query", "description": "maximum number of related prices returned (when they are included)" } ] }, "docs": "List Related Subscriptions / Promotional Offers" }, { "info": { "name": "Get Related Subscriptions / Subscription Availability", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/subscriptionAvailability", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" } ] }, "docs": "Get Related Subscriptions / Subscription Availability" }, { "info": { "name": "Get Related Subscriptions / Subscription Availability", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/subscriptionAvailability", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "fields[subscriptionAvailabilities]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionAvailabilities" }, { "name": "fields[territories]", "value": "", "type": "query", "description": "the fields to include for returned resources of type territories" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" }, { "name": "limit[availableTerritories]", "value": "", "type": "query", "description": "maximum number of related availableTerritories returned (when they are included)" } ] }, "docs": "Get Related Subscriptions / Subscription Availability" }, { "info": { "name": "List Related Subscriptions / Subscription Localizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/subscriptionLocalizations", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Subscription Localizations" }, { "info": { "name": "List Related Subscriptions / Subscription Localizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/subscriptionLocalizations", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "fields[subscriptionLocalizations]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptionLocalizations" }, { "name": "fields[subscriptions]", "value": "", "type": "query", "description": "the fields to include for returned resources of type subscriptions" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" } ] }, "docs": "List Related Subscriptions / Subscription Localizations" }, { "info": { "name": "List Related Subscriptions / Win Back Offers", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/relationships/winBackOffers", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" } ] }, "docs": "List Related Subscriptions / Win Back Offers" }, { "info": { "name": "List Related Subscriptions / Win Back Offers", "type": "http" }, "http": { "method": "GET", "url": "https://api.appstoreconnect.apple.com/v1/subscriptions/:id/winBackOffers", "params": [ { "name": "id", "value": "", "type": "path", "description": "the id of the requested resource" }, { "name": "fields[winBackOffers]", "value": "", "type": "query", "description": "the fields to include for returned resources of type winBackOffers" }, { "name": "fields[winBackOfferPrices]", "value": "", "type": "query", "description": "the fields to include for returned resources of type winBackOfferPrices" }, { "name": "limit", "value": "", "type": "query", "description": "maximum resources per page" }, { "name": "include", "value": "", "type": "query", "description": "comma-separated list of relationships to include" }, { "name": "limit[prices]", "value": "", "type": "query", "description": "maximum number of related prices returned (when they are included)" } ] }, "docs": "List Related Subscriptions / Win Back Offers" } ] } ], "bundled": true }