Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS SubscriptionGracePeriods API

The SubscriptionGracePeriods API from iOS — 1 operation(s) for subscriptiongraceperiods.

iOS SubscriptionGracePeriods API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SubscriptionGracePeriods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.

This API exposes 2 operations across 1 path, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.

Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.

2 operations 1 paths 10 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iOS SubscriptionGracePeriods API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (itc-bearer-token). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

SubscriptionGracePeriods 2
GET
/v1/subscriptionGracePeriods/{id}
Get Subscription Grace Periods
subscriptionGracePeriods_getInstance 2 params → 400401403404200429
PATCH
/v1/subscriptionGracePeriods/{id}
Update Subscription Grace Periods
subscriptionGracePeriods_updateInstance 1 param body → 400401403404422200409429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are SubscriptionGracePeriod (4 properties), ErrorLinks (2 properties), SubscriptionGracePeriodResponse (2 properties), ErrorSourcePointer (1 property). Each schema is shown below with its type and property counts.

DocumentLinks
object
1 property 1 required
SubscriptionGracePeriod
object
4 properties 2 required
ResourceLinks
object
1 property
SubscriptionGracePeriodUpdateRequest
object
1 property 1 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
ErrorResponse
object
1 property
SubscriptionGracePeriodResponse
object
2 properties 2 required
ErrorSourcePointer
object
1 property 1 required
SubscriptionGracePeriodDuration
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-subscriptiongraceperiods-api-openapi.yml Raw ↑

Other APIs iOS publishes across the network.

App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API