PUT /plan/{code}
Servers
- https://api.paystack.co
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
code |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
Name of plan |
description |
String | No |
A description for this plan |
interval |
String | No |
Interval in words. Valid intervals are daily, weekly, monthly,biannually, annually |
amount |
Integer | No |
Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR |
send_sms |
Boolean | No |
Set to false if you don't want text messages to be sent to your customers |
send_invoices |
Boolean | No |
Set to false if you don't want invoices to be sent to your customers |
currency |
String | No |
Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD |
invoice_limit |
Integer | No |
Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.