Get Status of Subscription Renewal Date Extensions
Checks whether a renewal date extension request completed, and provides the final count of successful or failed extensions.
URL
GET https://api.storekit.apple.com/inApps/v1/subscriptions/extend/mass/{productId}/{requestIdentifier}Sandbox URL
GET https://api.storekit-sandbox.apple.com/inApps/v1/subscriptions/extend/mass/{productId}/{requestIdentifier}Path Parameters
| Name | Type | Description |
|---|---|---|
productId Required | productId | The product identifier of the auto-renewable subscription that you request a renewal-date extension for. |
requestIdentifier Required | requestIdentifier | The |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | MassExtendRenewalDateStatusResponse | The request succeeded. |
| 400 | Bad Request Content-Type: application/json | (InvalidProductIdError | InvalidRequestIdentifierError) | The request is invalid. |
| 401 | Unauthorized | The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. | |
| 429 | Content-Type: application/json | RateLimitExceededError | The request exceeded the rate limit. |
| 500 | Internal Server Error Content-Type: application/json | (GeneralInternalError | GeneralInternalRetryableError) | Server error. Try again later. |
Mentioned in
Discussion
This endpoint provides basic status information about a request you initiate when you call the Extend Subscription Renewal Dates for All Active Subscribers endpoint. Such requests may take hours, or even days, depending on the number of subscribers. This status tells whether the request is complete. If so, it has the total count of successful and failed subscription-renewal-date extensions.