To check the status of the subscription.
Host Details
Environment | Value |
---|---|
UAT | https://api-preprod.phonepe.com/apis/pg-sandbox |
PROD | https://api.phonepe.com/apis/pg |
API Endpoint
/subscriptions/v2/{merchantSubscriptionId}/status?details=true
Complete Host URL
Http Method: GET
Environment | Value |
---|---|
UAT | https://api-preprod.phonepe.com/apis/pg-sandbox/subscriptions/v2/{merchantSubscriptionId}/status?details=true |
PROD | https://api.phonepe.com/apis/pg/subscriptions/v2/{merchantSubscriptionId}/status?details=true |
Request Details
Request Headers
Header Name | Header Value |
---|---|
Content-Type | application/json |
Authorization | O-Bearer <access_token> |
Note: access_token can be generated using the Auth Token API. Refer here
Path Parameter Details
Parameter Name | Description |
---|---|
merchantSubscriptionId | Unique 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 Name | Data Type | Description |
---|---|---|
merchantSubscriptionId | String | Unique merchant subscription Id passed by the merchant while creating the subscription. |
subscriptionId | String | PhonePe generated subscription Id. |
state | String | Status of the subscription. Possible values: ● ACTIVE ● PAUSED ● CANCELLED ● REVOKED |
authWorkflowType | String | Type of Authorization |
amountType | String | Type of amount ● Fixed ● Variable |
maxAmount | String | Max Amount that can be charged |
frequency | String | Frequency type of subscription |
expireAt | DateTime | Subscription Expiry Time as Epoch (in milliseconds) |
pauseStartDate | DateTime | Subscription pause start date only for Pause State or else null. ( in Epoch (in milliseconds)) |
pauseEndDate | DateTime | Subscription pause end date only for Pause state or else null. ( in Epoch (in milliseconds)) |