> ## Documentation Index
> Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get pending downgrade for a membership contract

> Retrieves the pending/scheduled downgrade details for a specific membership contract. This endpoint returns information about a downgrade that has been scheduled but not yet executed.

**Response Information:**
- **contractId**: The membership contract ID
- **waitTillTimestamp**: When the downgrade will be executed
- **oldVariantId**: The current product variant ID
- **newVariantId**: The target product variant ID after downgrade
- **oldPrice**: Current membership price
- **newPrice**: New price after downgrade
- **sellingPlanId**: The selling plan ID for the new membership
- **sellingPlanName**: Name of the selling plan

**Use Cases:**
- Check if a customer has a pending downgrade scheduled
- Display pending downgrade information in custom dashboards
- Verify downgrade details before allowing further modifications

**Authentication:** Requires API key authentication via X-API-Key header or api_key parameter



## OpenAPI

````yaml /memberships/admin-api-swagger.json get /api/external/v2/subscription-contract-details/{contractId}/pending-downgrade
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing memberships, payments, and
    related operations. These APIs allow you to programmatically manage
    membership lifecycles, handle payments, configure products, and integrate
    membership functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://membership-admin.appstle.com
security: []
tags:
  - description: >-
      APIs for retrieving product swap/substitution options allowing members to
      exchange membership items based on configured swap rules and variant
      groups
    name: Product Swap Rules
  - description: >-
      APIs for managing customer payment methods, payment tokens, and payment
      method retrieval for memberships
    name: Customer Payment Methods
  - description: >-
      APIs for managing one-time product additions to upcoming membership
      orders, including adding, retrieving, and removing one-off items
    name: One-Time Add-Ons
  - description: >-
      APIs for managing membership contracts including creation, updates, status
      changes, line items, discounts, and billing operations
    name: Membership Contracts
  - description: >-
      APIs for retrieving historical discount code usage and redemption
      information for membership contracts
    name: Customer Discount History
  - description: >-
      APIs for managing customer portal settings including UI customization,
      text labels, feature toggles, and branding options for the member
      self-service portal
    name: Customer Portal Configuration
  - description: >-
      APIs for retrieving custom CSS styles applied to membership widgets and
      customer portal for theme customization
    name: Custom CSS Styling
  - description: >-
      APIs for managing membership cancellation flow settings including
      retention offers, survey questions, and cancel confirmation screens
    name: Cancellation Flow Configuration
  - description: >-
      APIs for managing membership billing attempts, recurring orders, payment
      retries, order history, and order skipping
    name: Billing & Orders
  - description: >-
      APIs for managing Shopify delivery profiles, shipping rates, zones, and
      free shipping configuration for membership memberships
    name: Shipping & Delivery Profiles
  - description: >-
      APIs for managing membership plan groups, including creating plans,
      configuring discounts, billing intervals, and assigning products to plans
    name: Membership Plans
  - description: >-
      APIs for retrieving product catalog, variants, pricing, and inventory
      information for memberships.
    name: Product & Inventory Data
  - description: >-
      APIs for managing shop-level membership settings, configuration, and
      general store information.
    name: Shop Settings
  - description: >-
      APIs for performing bulk/mass operations on multiple membership contracts
      including status updates, product replacements, and billing date changes.
    name: Bulk Operations
paths:
  /api/external/v2/subscription-contract-details/{contractId}/pending-downgrade:
    get:
      tags:
        - Membership Contracts
      summary: Get pending downgrade for a membership contract
      description: >-
        Retrieves the pending/scheduled downgrade details for a specific
        membership contract. This endpoint returns information about a downgrade
        that has been scheduled but not yet executed.


        **Response Information:**

        - **contractId**: The membership contract ID

        - **waitTillTimestamp**: When the downgrade will be executed

        - **oldVariantId**: The current product variant ID

        - **newVariantId**: The target product variant ID after downgrade

        - **oldPrice**: Current membership price

        - **newPrice**: New price after downgrade

        - **sellingPlanId**: The selling plan ID for the new membership

        - **sellingPlanName**: Name of the selling plan


        **Use Cases:**

        - Check if a customer has a pending downgrade scheduled

        - Display pending downgrade information in custom dashboards

        - Verify downgrade details before allowing further modifications


        **Authentication:** Requires API key authentication via X-API-Key header
        or api_key parameter
      operationId: getPendingDowngradeV2
      parameters:
        - description: API Key (Deprecated - Use Header X-API-Key instead)
          in: query
          name: api_key
          required: false
          schema:
            type: string
        - in: header
          name: X-API-Key
          required: false
          schema:
            type: string
        - description: The membership contract ID
          example: 12345
          in: path
          name: contractId
          required: true
          schema:
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledDowngradeRequest'
          description: Pending downgrade found and returned successfully
        '401':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScheduledDowngradeRequest'
          description: Authentication required - invalid or missing API key
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScheduledDowngradeRequest'
          description: No pending downgrade found for this contract
components:
  schemas:
    ScheduledDowngradeRequest:
      properties:
        contractId:
          format: int64
          type: integer
        customerId:
          format: int64
          type: integer
        eventSource:
          type: string
        executionArn:
          type: string
        newCustomerTag:
          type: string
        newOrderTag:
          type: string
        newPrice:
          format: double
          type: number
        newVariantId:
          type: string
        oldCustomerTags:
          type: string
        oldLineId:
          type: string
        oldPrice:
          format: double
          type: number
        oldVariantId:
          type: string
        retryCount:
          format: int32
          type: integer
        sellingPlanId:
          type: string
        sellingPlanName:
          type: string
        shop:
          type: string
        waitTillTimestamp:
          type: string
      type: object

````