Subscription Status

To check the status of the subscription.

Host Details

EnvironmentValue
UAThttps://api-preprod.phonepe.com/apis/pg-sandbox
PRODhttps://api.phonepe.com/apis/pg

API Endpoint

/subscriptions/v2/{merchantSubscriptionId}/status?details=true

Complete Host URL

Http Method: GET

EnvironmentValue
UAThttps://api-preprod.phonepe.com/apis/pg-sandbox/subscriptions/v2/{merchantSubscriptionId}/status?details=true
PRODhttps://api.phonepe.com/apis/pg/subscriptions/v2/{merchantSubscriptionId}/status?details=true

Request Details

Request Headers

Header NameHeader Value
Content-Typeapplication/json
AuthorizationO-Bearer <access_token>

Note: access_token can be generated using the Auth Token API. Refer here

Path Parameter Details

Parameter NameDescription
merchantSubscriptionIdUnique merchant subscription Id passed
by the merchant while creating the
subscription.

Sample Response

For State – Active/Cancelled/Revoked

{
    "merchantSubscriptionId": "MS1708797962855",
    "subscriptionId": "OMS2402242336054995042603",
    "state": "ACTIVE/CANCELLED/REVOKED",
    "authWorkflowType": "TRANSACTION",
    "amountType": "FIXED",
    "maxAmount": 200,
    "frequency": "ON_DEMAND",
    "expireAt": 1737278524000,
    "pauseStartDate": null,
    "pauseEndDate": null
}

For State – Paused

{
    "merchantSubscriptionId": "MS1708797962855",
    "subscriptionId": "OMS2402242336054995042603",
    "state": "PAUSED",
    "authWorkflowType": "TRANSACTION",
    "amountType": "FIXED",
    "maxAmount": 200,
    "frequency": "ON_DEMAND",
    "expireAt": 1737278524000,
    "pauseStartDate": 1708798426196,
    "pauseEndDate": 1708885799000
}

Response Parameters

Parameter NameData TypeDescription
merchantSubscriptionIdStringUnique merchant subscription Id passed by the merchant while creating the subscription.
subscriptionIdStringPhonePe generated subscription Id.
stateStringStatus of the subscription. Possible values:
● ACTIVE
● PAUSED
● CANCELLED
● REVOKED
authWorkflowTypeStringType of Authorization
amountTypeStringType of amount
Fixed
Variable
maxAmountStringMax Amount that can be charged
frequencyStringFrequency type of subscription
expireAtDateTimeSubscription Expiry Time as Epoch (in milliseconds)
pauseStartDateDateTimeSubscription pause start date only for Pause State or else null. ( in Epoch (in milliseconds))
pauseEndDateDateTimeSubscription pause end date only for Pause state or else null. ( in Epoch (in milliseconds))