Contents

List plan availabilities for a subscription

List all plan availabilities for a specific auto-renewable 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. Obtain the subscription resource ID from the List all subscriptions for a subscription group 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 Optionalinteger

The maximum number of subscription plan availability resources to return.

limit[availableTerritories] Optionalinteger

The maximum number of available territory resources to return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SubscriptionPlanAvailabilitiesResponse

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

Mentioned in

See Also

Reading plan availability from a subscription