-
Notifications
You must be signed in to change notification settings - Fork 134
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #254 from razorpay/readmeUpdate
Updated readme
- Loading branch information
Showing
22 changed files
with
8,055 additions
and
289 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| ## Addons | ||
|
|
||
| ### Create an addon | ||
|
|
||
| ```php | ||
| $api->subscription->fetch($subscriptionId)->createAddon(array('item' => array('name' => 'Extra Chair', 'amount' => 30000, 'currency' => 'INR'), 'quantity' => 2)) | ||
| ``` | ||
|
|
||
| **Parameters:** | ||
|
|
||
| | Name | Type | Description | | ||
| |-------|-----------|--------------------------------------------------| | ||
| | subscriptionId* | boolean | The subscription ID to which the add-on is being added. | | ||
| | items* | array | Details of the add-on you want to create. | | ||
| | quantity* | integer | This specifies the number of units of the add-on to be charged to the customer. | | ||
|
|
||
| **Response:** | ||
| ```json | ||
| { | ||
| "id":"ao_00000000000001", | ||
| "entity":"addon", | ||
| "item":{ | ||
| "id":"item_00000000000001", | ||
| "active":true, | ||
| "name":"Extra appala (papadum)", | ||
| "description":"1 extra oil fried appala with meals", | ||
| "amount":30000, | ||
| "unit_amount":30000, | ||
| "currency":"INR", | ||
| "type":"addon", | ||
| "unit":null, | ||
| "tax_inclusive":false, | ||
| "hsn_code":null, | ||
| "sac_code":null, | ||
| "tax_rate":null, | ||
| "tax_id":null, | ||
| "tax_group_id":null, | ||
| "created_at":1581597318, | ||
| "updated_at":1581597318 | ||
| }, | ||
| "quantity":2, | ||
| "created_at":1581597318, | ||
| "subscription_id":"sub_00000000000001", | ||
| "invoice_id":null | ||
| } | ||
| ``` | ||
| ------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ### Fetch all addons | ||
|
|
||
| ```php | ||
| $api->addon->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": "ao_00000000000002", | ||
| "entity": "addon", | ||
| "item": { | ||
| "id": "item_00000000000002", | ||
| "active": true, | ||
| "name": "Extra sweet", | ||
| "description": "1 extra sweet of the day with meals", | ||
| "amount": 90000, | ||
| "unit_amount": 90000, | ||
| "currency": "INR", | ||
| "type": "addon", | ||
| "unit": null, | ||
| "tax_inclusive": false, | ||
| "hsn_code": null, | ||
| "sac_code": null, | ||
| "tax_rate": null, | ||
| "tax_id": null, | ||
| "tax_group_id": null, | ||
| "created_at": 1581597318, | ||
| "updated_at": 1581597318 | ||
| }, | ||
| "quantity": 1, | ||
| "created_at": 1581597318, | ||
| "subscription_id": "sub_00000000000001", | ||
| "invoice_id": "inv_00000000000001" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| ------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ### Fetch an addon | ||
|
|
||
| ```php | ||
| $api->addon->fetch($addonId); | ||
| ``` | ||
|
|
||
| **Parameters:** | ||
|
|
||
| | Name | Type | Description | | ||
| |-----------------|---------|------------------------------------------------------------------------------| | ||
| | addonId* | string | addon id to be fetched | | ||
| **Response:** | ||
| ```json | ||
| { | ||
| "id":"ao_00000000000001", | ||
| "entity":"addon", | ||
| "item":{ | ||
| "id":"item_00000000000001", | ||
| "active":true, | ||
| "name":"Extra appala (papadum)", | ||
| "description":"1 extra oil fried appala with meals", | ||
| "amount":30000, | ||
| "unit_amount":30000, | ||
| "currency":"INR", | ||
| "type":"addon", | ||
| "unit":null, | ||
| "tax_inclusive":false, | ||
| "hsn_code":null, | ||
| "sac_code":null, | ||
| "tax_rate":null, | ||
| "tax_id":null, | ||
| "tax_group_id":null, | ||
| "created_at":1581597318, | ||
| "updated_at":1581597318 | ||
| }, | ||
| "quantity":2, | ||
| "created_at":1581597318, | ||
| "subscription_id":"sub_00000000000001", | ||
| "invoice_id":null | ||
| } | ||
| ``` | ||
| ------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ### Delete an addon | ||
|
|
||
| ```php | ||
| $api->addon->fetch($addonId)->delete(); | ||
| ``` | ||
|
|
||
| **Parameters:** | ||
|
|
||
| | Name | Type | Description | | ||
| |-----------------|---------|------------------------------------------------------------------------------| | ||
| | addonId* | string | addon id to be deleted | | ||
|
|
||
| **Response:** | ||
| ```json | ||
| [] | ||
| ``` | ||
| ------------------------------------------------------------------------------------------------------- | ||
|
|
||
| **PN: * indicates mandatory fields** | ||
| <br> | ||
| <br> | ||
| **For reference click [here](https://razorpay.com/docs/api/subscriptions/#add-ons)** |
Oops, something went wrong.