Fetch plans from the recurpay dashboard
Request Params
URL Parameters | Type | Description |
|---|---|---|
base_url | text | |
product_id | number | 4283382169675 |
Response Params
Attribute | Type | Description |
|---|---|---|
id | text | Recurpay plan id |
name | text | Plan’s title |
description | text | Plan’s description |
status | text | Plan status (active, inactive) |
type | enum | Plan type (regular, prepaid) |
shipping | object | Shipping details for the plan |
interval | object | Plan interval details |
trial | object | Trial setup for the plan |
auto_expire | object | Plan auto expire details with charge count. Eg: charge_count = 3, that means auto expire subscription after debiting customers 3 times in accordance to the plan frequency. |
cod_status | boolean | Cash on delivery eligibility for the plan |
properties | object | Frequency and interval of plan |
created_at | datetime | Plan creation date |
updated_at | datetime | Plan last updated date |
shipping [price] | float | Plan’s shipping price |
shipping [type] | enum | "first_time" = shipping will be charged only first time, |
properties [frequency] | number | The interval frequency ( also it is determined by the type of the interval, ex: 2 is the frequency and month is type, where every 2 month is the plan interval) |
properties [interval] | enum | "daily" |
properties [shipment_count][shipment_count] | number | Number of shipments/deliveries (Only applicable for prepaid plans) |
discount [type] | enum | Type of plan discount (“percentage”) |
discount [value] | number | Discount percentage of plan |
trial [status] | boolean | The status whether the trial is offered or not. |
trial [description] | text | Trial description |
trial [variant_id][variant_id] | text | The same variant of the product from a plan |
trial [days] | number | The trial period in days |