All URIs are relative to https://api.paystack.co
| Method | HTTP request | Description |
|---|---|---|
| create | POST /plan | Create Plan |
| fetch | GET /plan/{code} | Fetch Plan |
| list | GET /plan | List Plans |
| update | PUT /plan/{code} | Update Plan |
Response create(name, amount, interval, description=description, send_invoices=send_invoices, send_sms=send_sms, currency=currency, invoice_limit=invoice_limit)
Create Plan
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'name='name_example'# str | Name of planamount=56# int | Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZARinterval='interval_example'# str | Interval in words. Valid intervals are daily, weekly, monthly,biannually, annually# Create Planresponse=paystack.Plan.create(
name,
amount,
interval,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | Name of plan | |
| amount | int | Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR | |
| interval | str | Interval in words. Valid intervals are daily, weekly, monthly,biannually, annually | |
| description | bool | A description for this plan | [optional] |
| send_invoices | bool | Set to false if you don't want invoices to be sent to your customers | [optional] |
| send_sms | bool | Set to false if you don't want text messages to be sent to your customers | [optional] |
| currency | str | Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD | [optional] |
| invoice_limit | int | Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. | [optional] |
- Content-Type: application/x-www-form-urlencoded, application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 0 | Server error | - |
[Back to top][Back to API list][Back to Model list][Back to README]
Response fetch(code)
Fetch Plan
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'code='code_example'# str | # Fetch Planresponse=paystack.Plan.fetch(
code,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| code | str |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 404 | Entity not found | - |
| 0 | Server error | - |
[Back to top][Back to API list][Back to Model list][Back to README]
Response list(per_page=per_page, page=page, interval=interval, amount=amount, _from=_from, to=to)
List Plans
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'# List Plansresponse=paystack.Plan.list(
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| per_page | int | Number of records to fetch per page | [optional] |
| page | int | The section to retrieve | [optional] |
| interval | str | Specify interval of the plan | [optional] |
| amount | int | The amount on the plans to retrieve | [optional] |
| _from | datetime | The start date | [optional] |
| to | datetime | The end date | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 404 | Entity not found | - |
| 0 | Server error | - |
[Back to top][Back to API list][Back to Model list][Back to README]
Response update(code, name=name, amount=amount, interval=interval, description=description, send_invoices=send_invoices, send_sms=send_sms, currency=currency, invoice_limit=invoice_limit)
Update Plan
- Bearer Authentication (bearerAuth):
importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'code='code_example'# str | # Update Planresponse=paystack.Plan.update(
code,
)
pprint(response)| Name | Type | Description | Notes |
|---|---|---|---|
| code | str | ||
| name | str | Name of plan | [optional] |
| amount | int | Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR | [optional] |
| interval | str | Interval in words. Valid intervals are daily, weekly, monthly,biannually, annually | [optional] |
| description | bool | A description for this plan | [optional] |
| send_invoices | bool | Set to false if you don't want invoices to be sent to your customers | [optional] |
| send_sms | bool | Set to false if you don't want text messages to be sent to your customers | [optional] |
| currency | str | Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD | [optional] |
| invoice_limit | int | Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. | [optional] |
- Content-Type: application/x-www-form-urlencoded, application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successful | - |
| 401 | Unauthorized operation | - |
| 404 | Entity not found | - |
| 0 | Server error | - |
[Back to top][Back to API list][Back to Model list][Back to README]