# Resume Subscription
Use this API to resume a paused subscription.
## Environment
Use our UAT environment endpoint for testing and for integration utilize our production endpoint.
| Environment | Endpoints |
| :----------------------------- | :--------------------------------------------------------------------------------------- |
| User Acceptance Testing \[UAT] | `https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions/{subscription_id}/resume` |
| Production \[PROD] | `https://api.pluralpay.in/ps/api/v1/public/subscriptions/{subscription_id}/resume` |
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "subscription",
"version": "3.0"
},
"servers": [
{
"url": "https://pluraluat.v2.pinepg.in/ps/api/v1/public"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-bearer-format": "bearer"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/subscriptions/{subscription_id}/resume": {
"post": {
"summary": "Resume Subscription",
"description": "Use this API to resume a paused subscription.",
"operationId": "resume-subscription",
"parameters": [
{
"name": "subscription_id",
"in": "path",
"description": "Unique identifier for the subscription in the plural database.- Maximum length: 50 characters.
Example: `v1-sub-4405071524-aa-qlAtAf`",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Content-Type",
"in": "header",
"description": "The type of content included in the HTTP message body.
Possible value: `application/json`.",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Authorization",
"in": "header",
"description": "The HTTP header where you can include your secret token for authentication.
Example: `Bearer `
**Note**: Use the access token generated using our Generate Token API.",
"required": true,
"schema": {
"type": "string",
"default": "Bearer"
}
},
{
"name": "Request-Timestamp",
"in": "header",
"description": "Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.
Example: `2024-07-09T07:57:08.022Z`",
"schema": {
"type": "string"
}
},
{
"name": "Request-ID",
"in": "header",
"description": "Use a global unique identifier [GUID] for the request.- Minimum: 1 characters.
- Maximum: 50 characters
Example: `c17ce30f-f88e-4f81-ada1-c3b4909ed235`",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"order_id\": \"v1-4405071524-aa-qlAtAf\",\n \"subscription_id\": \"v1-sub-4405071524-aa-qlAtAf\",\n \"merchant_subscription_reference\": \"1234567890\",\n \"enable_notification\": true,\n \"plan_details\": {\n \"plan_id\": \"v1-plan-4405071524-aa-qlAtAf\",\n \"status\": \"ACTIVE\",\n \"plan_name\": \"Monthly Plan\",\n \"plan_description\": \"Diwali dhammaka plan intended to attract customers on diwali time\",\n \"frequency\": \"Day\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"INR\"\n },\n \"max_limit_amount\": {\n \"value\": 100,\n \"currency\": \"INR\"\n },\n \"trial_period_in_days\": 1,\n \"start_date\": \"2022-02-01T17:32:28Z\",\n \"end_date\": \"2022-10-21T17:32:28Z\",\n \"merchant_metadata\": {\n \"key1\": \"DD\",\n \"key2\": \"XOF\"\n },\n \"merchant_plan_reference\": \"1234567890\",\n \"created_at\": \"2022-10-21T17:32:28Z\",\n \"modified_at\": \"2022-10-21T17:32:28Z\"\n },\n \"quantity\": 1,\n \"start_date\": \"2022-07-21T17:32:28Z\",\n \"end_date\": \"2022-09-21T17:32:28Z\",\n \"customer_id\": \"123456\",\n \"payment_mode\": \"UPI\",\n \"allowed_payment_methods\": [\n \"UPI\"\n ],\n \"integration_mode\": \"SEAMLESS\",\n \"merchant_metadata\": {\n \"key1\": \"DD\",\n \"key2\": \"XOF\"\n },\n \"status\": \"RESUMING\",\n \"is_tpv_enabled\": true,\n \"bank_account\": {\n \"account_number\": \"123456789012345\",\n \"name\": \"Gaurav Kumar\",\n \"ifsc\": \"123456789012345\"\n },\n \"created_at\": \"2022-10-21T17:32:28Z\",\n \"modified_at\": \"2022-10-21T17:32:28Z\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"example": "v1-4405071524-aa-qlAtAf"
},
"subscription_id": {
"type": "string",
"example": "v1-sub-4405071524-aa-qlAtAf"
},
"merchant_subscription_reference": {
"type": "string",
"example": "1234567890"
},
"enable_notification": {
"type": "boolean",
"example": true,
"default": true
},
"plan_details": {
"type": "object",
"properties": {
"plan_id": {
"type": "string",
"example": "v1-plan-4405071524-aa-qlAtAf"
},
"status": {
"type": "string",
"example": "ACTIVE"
},
"plan_name": {
"type": "string",
"example": "Monthly Plan"
},
"plan_description": {
"type": "string",
"example": "Diwali dhammaka plan intended to attract customers on diwali time"
},
"frequency": {
"type": "string",
"example": "Day"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 100,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"max_limit_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 100,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"trial_period_in_days": {
"type": "integer",
"example": 1,
"default": 0
},
"start_date": {
"type": "string",
"example": "2022-02-01T17:32:28Z"
},
"end_date": {
"type": "string",
"example": "2022-10-21T17:32:28Z"
},
"merchant_metadata": {
"type": "object",
"properties": {
"key1": {
"type": "string",
"example": "DD"
},
"key2": {
"type": "string",
"example": "XOF"
}
}
},
"merchant_plan_reference": {
"type": "string",
"example": "1234567890"
},
"created_at": {
"type": "string",
"example": "2022-10-21T17:32:28Z"
},
"modified_at": {
"type": "string",
"example": "2022-10-21T17:32:28Z"
}
}
},
"quantity": {
"type": "integer",
"example": 1,
"default": 0
},
"start_date": {
"type": "string",
"example": "2022-07-21T17:32:28Z"
},
"end_date": {
"type": "string",
"example": "2022-09-21T17:32:28Z"
},
"customer_id": {
"type": "string",
"example": "123456"
},
"payment_mode": {
"type": "string",
"example": "UPI"
},
"allowed_payment_methods": {
"type": "array",
"items": {
"type": "string",
"example": "UPI"
}
},
"integration_mode": {
"type": "string",
"example": "SEAMLESS"
},
"merchant_metadata": {
"type": "object",
"properties": {
"key1": {
"type": "string",
"example": "DD"
},
"key2": {
"type": "string",
"example": "XOF"
}
}
},
"status": {
"type": "string",
"example": "RESUMING"
},
"is_tpv_enabled": {
"type": "boolean",
"example": true,
"default": true
},
"bank_account": {
"type": "object",
"properties": {
"account_number": {
"type": "string",
"example": "123456789012345"
},
"name": {
"type": "string",
"example": "Gaurav Kumar"
},
"ifsc": {
"type": "string",
"example": "123456789012345"
}
}
},
"created_at": {
"type": "string",
"example": "2022-10-21T17:32:28Z"
},
"modified_at": {
"type": "string",
"example": "2022-10-21T17:32:28Z"
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"Internal Server Error\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "INTERNAL_ERROR"
},
"message": {
"type": "string",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```