Fetch plans from the recurpay dashboard
Response Params
Attribute | Type | Description |
|---|---|---|
id | text | Recurpay plan id |
title | text | Plan’s title |
description | text | Plan’s description |
product_id | text | Ecommerce’s product id |
discount | integer | Plan’s discount |
shipping | object | Shipping details for the plan |
interval | object | Plan interval details |
prepaid | object | Plan type, if prepaid the upfront payment would be received from subscription as per the number of shipments set on the plan. |
trial | object | Trial setup for the plan |
expire | object | Plan auto expire details |
cod | boolean | Cash on delivery eligibility for the plan |
status | boolean | Plan active status |
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, |
interval [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) |
interval [type] | enum | "daily" |
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 [period] | number | The trial period in days |
status | boolean | The status whether the expire is set or not. |
deliveries | number | The number of renewals, deliveries. |
subscription_status | enum | "Active" = Subscription’s running state |