Update a Subscription Plan

PATCH/ps/api/v1/public/plans/{plan_id}

Updates an existing subscription plan. Existing subscriptions under this plan will remain unaffected. The changes will apply only to new subscriptions created under this plan.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Path Parameters

Field	Details
`plan_id` `string`required	Unique identifier for the subscription plan.

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Request Bodyrequired

Field	Details
`plan_name` `string`	Subscription plan name.
`plan_description` `string`	Corresponding description for a plan.
`amount` `object`2 nested fields	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS
`max_limit_amount` `object`2 nested fields	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS
`trial_period_in_days` `integer`	Duration of the trial period in days.
`end_date` `string`date-time	The ISO 8601 UTC Timestamp when the subscription plan expires.
`merchant_metadata` `object`	Key-value pairs for additional information. Max 10 pairs, 256 chars each. Constraints Maximum properties: 10 Additional properties: string · Maximum length: 256 characters

Response

Field	Details
`plan_id` `string`	Unique identifier for the subscription plan in the Pine Labs database.
`status` `string`	Status of the plan. ACTIVE: Plan creation completed and start time has passed. INACTIVE: Plan is disabled or has exceeded its validity period. CREATED: Plan creation completed but start time is in the future. Allowed values: `ACTIVEINACTIVECREATED`
`plan_name` `string`	Subscription plan name.
`plan_description` `string`	Corresponding description for a plan.
`frequency` `string`	Frequency of recurring transactions for this particular plan. Allowed values: `DayWeekMonthYearBi-MonthlyQuarterlyHalf-YearlyASOTNot Applicable`
`amount` `object`2 nested fields	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS
`value` `integer`required	Amount in the smallest currency unit (paisa for INR). Minimum ₹1 (100), maximum ₹10 lakh (100000000). Constraints Minimum value: 100Maximum value: 100000000
`currency` `string`required	Three-letter ISO 4217 currency code. Constraints Default value: INR
`max_limit_amount` `object`2 nested fields	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS
`trial_period_in_days` `integer`	Duration of the trial period in days.
`start_date` `string`date-time	The ISO 8601 UTC Timestamp when the subscription plan is active.
`end_date` `string`date-time	The ISO 8601 UTC Timestamp when the subscription plan expires.
`merchant_metadata` `object`	Key-value pairs for additional information. Max 10 pairs, 256 chars each. Constraints Maximum properties: 10 Additional properties: string · Maximum length: 256 characters
`merchant_plan_reference` `string`	Unique identifier of the merchant plan reference. Constraints Minimum length: 1 characterMaximum length: 50 characters
`created_at` `string`date-timenullable	ISO 8601 UTC Timestamp when the create plan request was received.
`modified_at` `string`date-timenullable	ISO 8601 UTC Timestamp when the plan was last updated.
`initial_debit_amount` `object`2 nested fields	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS
`auto_debit_ot` `string`	Indicates whether auto-debit is enabled for one-time payments.

Status Codes

`200`	Plan updated successfully.
`400`	The request was malformed or missing required fields.

Run

Request

curl --request PATCH \
  --url https://pluraluat.v2.pinepg.in/ps/api/v1/public/plans/v1-plan-4405071524-aa-qlAtAf \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z' \
  --data '{
  "plan_name": "Monthly Plan Updated",
  "plan_description": "Updated plan description",
  "amount": {
    "value": 1000,
    "currency": "INR"
  },
  "max_limit_amount": {
    "value": 1000,
    "currency": "INR"
  },
  "trial_period_in_days": 1,
  "end_date": "2026-10-21T12:02:28Z",
  "merchant_metadata": {
    "key1": "DD"
  }
}'

Status:

{
  "plan_id": "v1-plan-4405071524-aa-qlAtAf",
  "status": "ACTIVE",
  "plan_name": "Monthly Plan",
  "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
  "frequency": "Day",
  "amount": {
    "value": 100,
    "currency": "INR"
  },
  "max_limit_amount": {
    "value": 100,
    "currency": "INR"
  },
  "trial_period_in_days": 1,
  "start_date": "2022-02-01T17:32:28Z",
  "end_date": "2022-10-21T17:32:28Z",
  "merchant_metadata": {
    "key1": "DD",
    "key2": "XOF"
  },
  "merchant_plan_reference": "1234567890",
  "created_at": "2022-10-21T17:32:28Z",
  "modified_at": "2022-10-21T17:32:28Z"
}