iOS

iOS SubscriptionGracePeriods API

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

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/subscriptionGracePeriods/{id} Get billing grace period settings · Get Subscription Grace Periods #
Ask an LLM
“Is Billing Grace Period turned on for my subscriptions?”
“How long do subscribers keep access after a failed renewal payment?”
Tell an agent
Show subscription grace period settings {grace}.
Fetch the grace period duration in settings {grace}.
PATCH /v1/subscriptionGracePeriods/{id} Change billing grace period settings · Update Subscription Grace Periods #
Ask an LLM
“How do I enable Billing Grace Period for my app's subscriptions?”
“Can I extend the grace period to 16 days or apply it to sandbox too?”
Tell an agent
Update grace period settings {grace} to 16 days.
Turn on billing grace period in settings {grace}.

Documentation

📖
Documentation
https://developer.apple.com/documentation/appstoreconnectapi
📖
APIReference
https://developer.apple.com/documentation/appstoreconnectapi
📖
GettingStarted
https://developer.apple.com/documentation/appstoreconnectapi/creating-api-keys-for-app-store-connect-api
📖
Authentication
https://developer.apple.com/documentation/appstoreconnectapi/generating-tokens-for-api-requests

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ios/refs/heads/main/openapi/ios-subscriptiongraceperiods-api-openapi.yml

Other Resources

🔗
ReleaseNotes
https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-release-notes
🔗
SDKs
https://github.com/apple/app-store-server-library-swift
🔗
SDKs
https://github.com/apple/app-store-server-library-java
🔗
SDKs
https://github.com/apple/app-store-server-library-python
🔗
SDKs
https://github.com/apple/app-store-server-library-node

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ios:ios-subscriptiongraceperiods-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ios-subscriptiongraceperiods-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: App Store Connect Subscription Grace Periods API
  version: 4.3.1
  x-platforms:
    app_store_connect_api: App Store Connect API
  description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles.
servers:
- url: https://api.appstoreconnect.apple.com/
security:
- itc-bearer-token: []
tags:
- name: SubscriptionGracePeriods
paths:
  /v1/subscriptionGracePeriods/{id}:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - SubscriptionGracePeriods
      operationId: subscriptionGracePeriods_getInstance
      parameters:
      - name: fields[subscriptionGracePeriods]
        in: query
        description: the fields to include for returned resources of type subscriptionGracePeriods
        schema:
          type: array
          items:
            type: string
            enum:
            - optIn
            - sandboxOptIn
            - duration
            - renewalType
        style: form
        explode: false
        required: false
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Single SubscriptionGracePeriod
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionGracePeriodResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Subscription Grace Periods
    patch:
      tags:
      - SubscriptionGracePeriods
      operationId: subscriptionGracePeriods_updateInstance
      requestBody:
        description: SubscriptionGracePeriod representation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionGracePeriodUpdateRequest'
        required: true
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable request entity error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Single SubscriptionGracePeriod
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionGracePeriodResponse'
        '409':
          description: Request entity error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Update Subscription Grace Periods
components:
  schemas:
    SubscriptionGracePeriod:
      type: object
      title: SubscriptionGracePeriod
      properties:
        type:
          type: string
          enum:
          - subscriptionGracePeriods
        id:
          type: string
        attributes:
          type: object
          properties:
            optIn:
              type: boolean
            sandboxOptIn:
              type: boolean
            duration:
              $ref: '#/components/schemas/SubscriptionGracePeriodDuration'
            renewalType:
              type: string
              enum:
              - ALL_RENEWALS
              - PAID_TO_PAID_ONLY
        links:
          $ref: '#/components/schemas/ResourceLinks'
      required:
      - id
      - type
    ErrorSourceParameter:
      type: object
      title: Parameter
      properties:
        parameter:
          type: string
      required:
      - parameter
    ResourceLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
    SubscriptionGracePeriodUpdateRequest:
      type: object
      title: SubscriptionGracePeriodUpdateRequest
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - subscriptionGracePeriods
            id:
              type: string
            attributes:
              type: object
              properties:
                optIn:
                  type:
                  - boolean
                  - 'null'
                sandboxOptIn:
                  type:
                  - boolean
                  - 'null'
                duration:
                  $ref: '#/components/schemas/SubscriptionGracePeriodDuration'
                renewalType:
                  type:
                  - string
                  - 'null'
                  enum:
                  - ALL_RENEWALS
                  - PAID_TO_PAID_ONLY
          required:
          - id
          - type
      required:
      - data
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              status:
                type: string
              code:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                oneOf:
                - $ref: '#/components/schemas/ErrorSourcePointer'
                - $ref: '#/components/schemas/ErrorSourceParameter'
              links:
                $ref: '#/components/schemas/ErrorLinks'
              meta:
                type: object
                additionalProperties: {}
            required:
            - code
            - detail
            - status
            - title
    ErrorSourcePointer:
      type: object
      title: JsonPointer
      properties:
        pointer:
          type: string
      required:
      - pointer
    DocumentLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
      required:
      - self
    SubscriptionGracePeriodDuration:
      type: string
      enum:
      - THREE_DAYS
      - SIXTEEN_DAYS
      - TWENTY_EIGHT_DAYS
    SubscriptionGracePeriodResponse:
      type: object
      title: SubscriptionGracePeriodResponse
      properties:
        data:
          $ref: '#/components/schemas/SubscriptionGracePeriod'
        links:
          $ref: '#/components/schemas/DocumentLinks'
      required:
      - data
      - links
    ErrorLinks:
      type: object
      properties:
        about:
          type: string
          format: uri-reference
        associated:
          oneOf:
          - type: string
            format: uri-reference
          - type: object
            properties:
              href:
                type: string
                format: uri-reference
              meta:
                type: object
                properties:
                  source:
                    type: string
  securitySchemes:
    itc-bearer-token:
      type: http
      scheme: bearer
      bearerFormat: JWT