Pine LabsDOCS
Create Account

API Playground

Test Pine Labs API endpoints with real requests. All endpoints are loaded dynamically from the OpenAPI specification.

Create Subscription

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.

POSThttps://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions
Required
Request Body (editable JSON)
Request Body Schemarequired
FieldDetails
merchant_subscription_reference
stringrequired

**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.

Constraints
Minimum length: 1 characterMaximum length: 50 characters
plan_id
stringrequired

Unique identifier for the subscription plan.

enable_notification
boolean

Indicates if notifications are enabled.

start_date
stringrequireddate-time

The ISO 8601 UTC Timestamp when the subscription starts.

end_date
stringrequireddate-time

The ISO 8601 UTC Timestamp when the subscription expires.

customer_id
stringrequired

Unique identifier of the customer in the Pine Labs Online database.

Constraints
Minimum length: 1 characterMaximum length: 50 characters
allowed_payment_methods
string[]

The type of payment methods you want to offer customers.

Constraints
Allowed item values:
CARDUPIPOINTSNETBANKINGWALLET
integration_mode
stringrequired

Type of integration.

Allowed values
SEAMLESSREDIRECT
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
is_tpv_enabled
boolean

Indicates if Third-Party Validation (TPV) is enabled.

bank_account
object3 nested fields

Bank account details for Third-Party Validation (TPV).

account_number
stringnullable

Bank account number.

Constraints
Minimum length: 1 characterMaximum length: 50 characters
name
stringnullable

Name of Customer.

ifsc
stringnullable

IFSC code of the bank account.

Constraints
Minimum length: 11 charactersMaximum length: 11 characters
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.