User Subscription Status

Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256("/v3/recurring/subscription/status/{merchantId}/{merchantSubscriptionId}" + saltKey) + "###" + saltIndex

Path Parameters

Parameter NameTypeDescriptionMandatory
merchantIdSTRINGUnique Merchant ID assigned to the merchant by PhonePeYes
merchantSubscriptionIdSTRINGmerchantSubscriptionId for which status is to be fetchedYes
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully completed. [message = Your subscription request has been successfully created.]",
  "data": {
    "subscriptionId": "OMS2105131257131014108471",
    "state": "CREATED",
    "validUpto": 1620891733101,
    "isSupportedApp": true,
    "isSupportedUser": true
  }
}

Sample Response Payload When Subscription is PAUSED

{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully completed.",
  "data": {
        "subscriptionId": "OMS2006110139450123456789",
        "merchantSubscriptionId": "MSUB123456789012345",
        "state": "PAUSED",
        "stateStartDate": 1653371461055,
        "stateEndDate": 1653371571095
    }
}

Response Parameters

Parameter NameTypeDescription
subscriptionIdSTRINGPhonePe subscription identifier
stateSTRING● CREATED
● ACTIVE
● SUSPENDED
● REVOKED
● CANCELLED
● PAUSED
● EXPIRED
● FAILED
● CANCEL_IN_PROGRESS
stateStartDateDATETIMEEpoch time from which given state is valid
stateEndDateDATETIMEEpoch time until which given state is valid
validUptoDATETIMEEpoch time until which auth must be completed
Language
Click Try It! to start a request and see the response here!