Skip to content

subscription doc correction #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ankitdas13 merged 1 commit into from
Jul 1, 2022
Merged

subscription doc correction #218

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions documents/subscription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,12 @@ client.subscription.create({
| plan_id* | string | The unique identifier for a plan that should be linked to the subscription.|
| total_count* | string | The number of billing cycles for which the customer should be charged |
| customer_notify | boolean | Indicates whether the communication to the customer would be handled by you or us |
| quantity | integer | The number of times the customer should be charged the plan amount per invoice |
| quantity | integer | The number of times the customer should be charged the plan amount per invoice |
| start_at | integer | The timestamp, in Unix format, for when the subscription should start. If not passed, the subscription starts immediately after the authorization payment. |
| expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
| addons | object | Object that contains details of any upfront amount you want to collect as part of the authorization transaction. |
| notes | object | Notes you can enter for the contact for future reference. |
| addons | array | All parameters listed [here](https://razorpay.com/docs/api/payments/subscriptions/#create-a-subscription) are supported |
| notes | array | Notes you can enter for the contact for future reference. |
| offer_id | string | The unique identifier of the offer that is linked to the subscription. |

**Response:**
```json
Expand Down Expand Up @@ -111,9 +112,10 @@ client.subscription.create({
| quantity | integer | The number of times the customer should be charged the plan amount per invoice |
| start_at | integer | The timestamp, in Unix format, for when the subscription should start. If not passed, the subscription starts immediately after the authorization payment. |
| expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
| addons | object | Object that contains details of any upfront amount you want to collect as part of the authorization transaction. |
| notes | object | Notes you can enter for the contact for future reference. |
| notify_info | object | The customer's email and phone number to which notifications are to be sent. (PN: Use this object only if you have set the `customer_notify` parameter to 1. That is, Razorpay sends notifications to the customer.) |
| addons | array | All parameters listed [here](https://razorpay.com/docs/api/payments/subscriptions/#create-a-subscription-link) are supported |
| notes | array | Notes you can enter for the contact for future reference. |
| notify_info | array | All parameters listed [here](https://razorpay.com/docs/api/payments/subscriptions/#create-a-subscription-link) are supported |
| offer_id | string | The unique identifier of the offer that is linked to the subscription. |

**Response:**
```json
Expand Down