ok
Direktori : /proc/self/root/home2/selectio/www/y1jobportal.in/razorpay-php-2.9.0/documents/ |
Current File : //proc/self/root/home2/selectio/www/y1jobportal.in/razorpay-php-2.9.0/documents/plan.md |
## Plans ### Create plan ```php $api->plan->create(array('period' => 'weekly', 'interval' => 1, 'item' => array('name' => 'Test Weekly 1 plan', 'description' => 'Description for the weekly 1 plan', 'amount' => 600, 'currency' => 'INR'),'notes'=> array('key1'=> 'value3','key2'=> 'value2'))); ``` **Parameters:** | Name | Type | Description | |-----------------|---------|------------------------------------------------------------------------------| | period* | string | Used together with `interval` to define how often the customer should be charged.Possible values:<br>1.`daily` <br>2.`weekly`<br>3.`monthly` <br>4.`yearly` | | interval* | string | Used together with `period` to define how often the customer should be charged | | items* | array | Details of the plan. For more details please refer [here](https://razorpay.com/docs/api/subscriptions/#create-a-plan) | | notes | array | Notes you can enter for the contact for future reference. | **Response:** ```json { "id":"plan_00000000000001", "entity":"plan", "interval":1, "period":"weekly", "item":{ "id":"item_00000000000001", "active":true, "name":"Test plan - Weekly", "description":"Description for the test plan - Weekly", "amount":69900, "unit_amount":69900, "currency":"INR", "type":"plan", "unit":null, "tax_inclusive":false, "hsn_code":null, "sac_code":null, "tax_rate":null, "tax_id":null, "tax_group_id":null, "created_at":1580219935, "updated_at":1580219935 }, "notes":{ "notes_key_1":"Tea, Earl Grey, Hot", "notes_key_2":"Tea, Earl Grey… decaf." }, "created_at":1580219935 } ``` ------------------------------------------------------------------------------------------------------- ### Fetch all plans ```php $api->plan->all($options); ``` **Parameters:** | Name | Type | Description | |-------|-----------|--------------------------------------------------| | from | timestamp | timestamp after which the payments were created | | to | timestamp | timestamp before which the payments were created | | count | integer | number of payments to fetch (default: 10) | | skip | integer | number of payments to be skipped (default: 0) | **Response:** ```json { "entity": "collection", "count": 1, "items": [ { "id": "plan_00000000000001", "entity": "plan", "interval": 1, "period": "weekly", "item": { "id": "item_00000000000001", "active": true, "name": "Test plan - Weekly", "description": "Description for the test plan - Weekly", "amount": 69900, "unit_amount": 69900, "currency": "INR", "type": "plan", "unit": null, "tax_inclusive": false, "hsn_code": null, "sac_code": null, "tax_rate": null, "tax_id": null, "tax_group_id": null, "created_at": 1580220492, "updated_at": 1580220492 }, "notes": { "notes_key_1": "Tea, Earl Grey, Hot", "notes_key_2": "Tea, Earl Grey… decaf." }, "created_at": 1580220492 } ] } ``` ------------------------------------------------------------------------------------------------------- ### Fetch particular plan ```php $api->plan->fetch($planId); ``` **Parameters:** | Name | Type | Description | |-------|-----------|--------------------------------------------------| | planId* | string | The id of the plan to be fetched | **Response:** ```json { "id":"plan_00000000000001", "entity":"plan", "interval":1, "period":"weekly", "item":{ "id":"item_00000000000001", "active":true, "name":"Test plan - Weekly", "description":"Description for the test plan - Weekly", "amount":69900, "unit_amount":69900, "currency":"INR", "type":"plan", "unit":null, "tax_inclusive":false, "hsn_code":null, "sac_code":null, "tax_rate":null, "tax_id":null, "tax_group_id":null, "created_at":1580220492, "updated_at":1580220492 }, "notes":{ "notes_key_1":"Tea, Earl Grey, Hot", "notes_key_2":"Tea, Earl Grey… decaf." }, "created_at":1580220492 } ``` ------------------------------------------------------------------------------------------------------- **PN: * indicates mandatory fields** <br> <br> **For reference click [here](https://razorpay.com/docs/api/subscriptions/#plans)**