Create Subscription

POST/ps/api/v1/public/subscriptions

Creates a new subscription against an existing plan. The subscription defines the recurring billing cycle for a customer based on the selected plan's pricing and frequency.

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

Requires Bearer token. Get token →

Request Body

Name	Type	Description
`merchant_subscription_reference`	`string`required	Idempotency Key. Unique identifier of the merchant subscription reference. Duplicate requests with the same `merchant_subscription_reference` will return the existing subscription instead of creating a new one.
`plan_id`	`string`required	Unique identifier for the subscription plan.
`enable_notification`	`boolean`	Indicates if notifications are enabled.
`start_date`	`string`required	The ISO 8601 UTC Timestamp when the subscription starts.
`end_date`	`string`required	The ISO 8601 UTC Timestamp when the subscription expires.
`customer_id`	`string`required	Unique identifier of the customer in the Pine Labs Online database.
`allowed_payment_methods`	`string[]`	The type of payment methods you want to offer customers.
`integration_mode`	`string`required	Type of integration. Allowed values: `SEAMLESSREDIRECT`
`merchant_metadata`	`object`	Key-value pairs for additional information. Max 10 pairs, 256 chars each.
`is_tpv_enabled`	`boolean`	Indicates if Third-Party Validation (TPV) is enabled.
`bank_account`	`object`	Bank account details for Third-Party Validation (TPV).
`account_number`	`stringnull`	Bank account number.
`name`	`stringnull`	Name of Customer.
`ifsc`	`stringnull`	IFSC code of the bank account.
`callback_url`	`string`	URL to redirect customers to specific success or failure pages.
`failure_callback_url`	`string`	URL specifically used to redirect customers to a failure page.

Status Codes

`201`	Subscription created successfully.
`404`	The requested resource does not exist.
`422`	Unprocessable Entity — validation failed or duplicate request.
`500`	An unexpected error occurred on the server.

Request

curl --request POST \
  --url https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "merchant_subscription_reference": "f5d77ef9-fa11-4f58-a9f4-543e4a7022c5",
  "plan_id": "v1-pla-250612061639-aa-666Zge",
  "enable_notification": true,
  "start_date": "2025-06-12T06:22:21Z",
  "end_date": "2025-06-21T17:32:28Z",
  "customer_id": "cust-v1-250519171901-aa-dPF6mg",
  "allowed_payment_methods": [
    "UPI"
  ],
  "integration_mode": "REDIRECT",
  "merchant_metadata": {
    "key1": "DD",
    "key2": "XOF"
  },
  "is_tpv_enabled": false,
  "bank_account": {
    "account_number": "12345678912345",
    "name": "Kevin Bob",
    "ifsc": "HDFC0001234"
  },
  "callback_url": "www.google.com",
  "failure_callback_url": "www.example.com/failure"
}'

Run this request

Bearer token

Request body (JSON)

Status:

201 Created

{
  "callback_url": "www.google.com",
  "failure_callback_url": "www.example.com/failure",
  "redirect_url": "https://api.pluralonline.com/api/v3/checkout-bff/redirect/checkout?token=V3_ye7V868X7DP92HQCSnVq7XZNlxvVhOQ3OgXGt96Buwfc53BwN9mUDwJsOcr%2Fw5uq&subscription_id=v1-sub-250612062122-aa-3HLXL5",
  "order_id": "v1-250612062122-aa-UZyPbu",
  "subscription_id": "v1-sub-250612062122-aa-3HLXL5",
  "merchant_subscription_reference": "f5d77ef9-fa11-4f58-a9f4-543e4a7022c5",
  "enable_notification": true,
  "plan_details": {
    "plan_id": "v1-pla-250612061639-aa-666Zge",
    "status": "ACTIVE",
    "plan_name": "Monthly Plan 2025-06-12T06:16:37.364Z",
    "plan_description": "Diwali dhammaka plan intended to attract customers on diwali time",
    "frequency": "Month",
    "amount": {
      "value": 100,
      "currency": "INR"
    },
    "max_limit_amount": {
      "value": 210,
      "currency": "INR"
    },
    "trial_period_in_days": 0,
    "start_date": "2025-06-12T06:16:39.927105Z",
    "end_date": "2026-10-21T12:02:28Z",
    "merchant_metadata": {
      "key1": "DD"
    },
    "merchant_plan_reference": "b41770ac-cd3a-48d3-9e93-7dc9246b4751",
    "created_at": null,
    "modified_at": null,
    "initial_debit_amount": {
      "value": 110,
      "currency": "INR"
    },
    "auto_debit_ot": "false"
  },
  "quantity": 1,
  "start_date": "2025-06-12T06:22:21Z",
  "end_date": "2025-06-21T17:32:28Z",
  "customer_id": "cust-v1-250519171901-aa-dPF6mg",
  "payment_mode": null,
  "allowed_payment_methods": [
    "UPI"
  ],
  "integration_mode": "REDIRECT",
  "merchant_metadata": {
    "key1": "DD",
    "key2": "XOF"
  },
  "status": "CREATED",
  "is_tpv_enabled": false,
  "bank_account": {
    "account_number": null,
    "name": null,
    "ifsc": null
  },
  "created_at": "2025-06-12T06:21:22.242344Z",
  "modified_at": "2025-06-12T06:21:22.267111Z",
  "order_amount": {
    "value": 210,
    "currency": "INR"
  }
}