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

# Get Subscription Mandate Status

> Check the mandate status for a subscription via the Partner API.



## OpenAPI

````yaml openapi/v3-subscriptions.json GET /pg/subscriptions/{subscription_id}/mandate_status/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API - V3 Subscriptions
  description: >-
    Subscription creation and mandate management on the v3 API. Every call
    carries X-API-Version: 3.0.0.
  license:
    name: Proprietary
  version: 3.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
    apiVersionHeader: []
paths:
  /pg/subscriptions/{subscription_id}/mandate_status/:
    get:
      tags:
        - Subscriptions
      summary: Get Subscription Mandate Status
      description: >-
        Fetch the current mandate status for a subscription from the payment
        gateway. Supports both UPI and card subscriptions.
      operationId: v3_get_pg_subscriptions_subscription_id_mandate_status_
      parameters:
        - name: subscription_id
          in: path
          required: true
          description: Subscription UID.
          schema:
            type: string
      responses:
        '200':
          description: Subscription mandate status fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionMandateStatusResponse'
              example:
                success: true
                message: Subscription mandate status fetched successfully
                data:
                  subscription_id: SUB7989707770
                  mandate_is_active: true
                  status: ACTIVE
                  amount: 1000
                  mandate_start_date: '2026-04-10T00:00:00+05:30'
                  mandate_end_date: '2027-04-10T23:59:59+05:30'
        '400':
          description: Business validation error (e.g. mandate not yet created)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Configuration / unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_SERVICE_ERROR_000
                  message: Payment gateway error
                  details:
                    error: An unexpected error occurred. Please try again later
        '503':
          description: Payment gateway API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - clientAuth: []
          clientSecretAuth: []
          merchantAuth: []
          apiVersionHeader: []
components:
  schemas:
    GetSubscriptionMandateStatusResponse:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            subscription_id:
              type: string
            mandate_is_active:
              type: boolean
              description: >-
                Whether the mandate is currently active. Only act on the
                subscription when this is true.
            status:
              type: string
              description: Mandate status reported by the payment gateway.
              enum:
                - ACTIVE
                - PAUSED
                - CANCELLED
                - EXPIRED
                - FAILED
                - PENDING
            amount:
              type: number
              description: Billing amount (card mandates).
            mandate_start_date:
              type: string
              description: Mandate start date (card mandates).
            mandate_end_date:
              type: string
              description: Mandate end date (card mandates).
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **Client Application ID** - Your unique application identifier used to
        authenticate API requests. You can find your Client ID in the Developer
        Settings section of the merchant dashboard.
      x-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **Client Secret Key** - Your secret key used alongside the Client ID for
        secure authentication. Keep this confidential and never expose it in
        client-side code. Available in the Developer Settings section of the
        merchant dashboard.
      x-displayName: Client Secret
      x-example: your-client-secret
    apiVersionHeader:
      type: apiKey
      name: X-API-Version
      in: header
      description: >-
        **API Version** - Selects the API version this call is made against.
        Send `3.0.0` for v3.
      x-displayName: API Version
      x-example: 3.0.0
    merchantAuth:
      type: apiKey
      name: X-Merchant-ID
      in: header
      description: >-
        **Merchant Identifier** - The unique ID for the merchant account. This
        is required for PSP (Payment Service Provider) merchants who manage
        multiple merchant accounts. You can find merchant IDs in the Merchant
        Management section of the dashboard.
      x-displayName: Merchant ID
      x-example: your-merchant-id

````