Check Subscription Status

This API is used to check the current status of a subscription after it has been set up. It helps determine whether the subscription is Active (successfully set up and ongoing), Cancelled (manually cancelled by the user), or Revoked(withdrawn by the user).

Environment

Environment	HTTP Method	API
Sandbox	`GET`	https://api-preprod.phonepe.com/apis/pg-sandbox/subscriptions/v2/{merchantSubscriptionId}/status
Production	`GET`	https://api.phonepe.com/apis/pg/subscriptions/v2/{merchantSubscriptionId}/status

Request

Request Headers

Header Name	Header Value
Content-Type	application/json
Authorization	O-Bearer <merchant-auth-token>

Path Parameters

Parameter Name	Description
`merchantSubscriptionId`	The unique merchant subscription ID provided by the merchant when creating the subscription

Response

Sample Response

{
    "merchantSubscriptionId": "OMO123",
    "subscriptionId": "OMS2602061522174978"
    "state": "ACTIVE",
    "productType": "ENACH_MANDATE",
    "authWorkflowType": "ZERO",
    "authInstrumentType": "NET_BANKING | DEBIT_CARD",
    "amountType": "VARIABLE",
    "maxAmount": 20000000,
    "frequency": "MONTHLY",
    "expireAt": 1708779903873,
    "pauseStartDate": null,
    "pauseEndDate": null
}

Response Parameters

Parameter Name	Data Type	Description
`merchantSubscriptionId`	String	Merchant’s unique ID for the subscription
`subscriptionId`	String	The subscription ID generated by PhonePe.
`state`	String	Current state (e.g., ACTIVE, FAILED)
`productType`	String	Instrument category (e.g., ENACH_MANDATE)
`authWorkflowType`	String	Validation workflow used
`authInstrumentType`	String	Method used (e.g., NET_BANKING \| DEBIT_CARD)
`amountType`	String	Billing type (Fixed/Variable)
`maxAmount`	Long	Recurring debit cap in paisa
`frequency`	String	Recurrence interval (e.g., MONTHLY)
`expireAt`	Long	Expiry timestamp in epoch