Contents

List plan availabilities for a subscription

List the subscription plan availabilities related to a subscription.

URL

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

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource.

Query Parameters

NameTypeDescription
fields[subscriptionPlanAvailabilities] Optional[string]

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

fields[territories] Optional[string]

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

include Optional[string]

The relationship data to include in the response.

limit Optionalinteger

The maximum number of subscriptionPlanAvailabilities resources to return.

limit[availableTerritories] Optionalinteger

The maximum number of related availableTerritories resources to return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SubscriptionPlanAvailabilitiesResponse

The request completed successfully.

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

Authentication failed.

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

The request rate limit was exceeded.

See Also

Reading plan availability from a subscription