Contents

Read the billing grace period value for an app

Get the Boolean value that represents the grace period opt-in state for your app.

URL

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

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource. Obtain the app resource ID from the List apps response.

Query Parameters

NameTypeDescription
fields[subscriptionGracePeriods] Optional[string]

Additional fields to include for each subscription grace period resource returned by the response.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SubscriptionGracePeriodResponse

400Bad Request
Content-Type: application/json
ErrorResponse

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

404Not Found
Content-Type: application/json
ErrorResponse

429
Content-Type: application/json
ErrorResponse

Discussion

Example Request and Response

See Also

Getting subscription group and subscription grace period information