Contents

Read subscription plan availability information

Get information about a specific subscription plan availability.

URL

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

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource. Obtain the subscriptionPlanAvailability resource ID from the List plan availabilities for a subscription response.

Query Parameters

NameTypeDescription
fields[subscriptionPlanAvailabilities] Optional[string]

Additional fields to include for each subscription plan availability resource that the response returns.

fields[territories] Optional[string]

Additional fields to include for each territory resource that the response returns.

include Optional[string]

The relationship data to include in the response.

limit[availableTerritories] Optionalinteger

The maximum number of available territory resources to return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SubscriptionPlanAvailabilityResponse

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

Request not authorized.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found.

429
Content-Type: application/json
ErrorResponse

See Also

Creating and modifying plan availability