plan.md

Plan

A collection of endpoints for creating and managing recurring payment configuration

Methods

Method	HTTP	Path	Summary
create	POST	/plan	Create Plan
fetch	GET	/plan/{code}	Fetch Plan
list	GET	/plan	List Plans
update	PUT	/plan/{code}	Update Plan

---

create

HTTP: POST
Path: /plan

paystack.plan.create({ ... })

Body Fields

Name	Required
name	true
amount	true
interval	true
description	false
send_invoices	false
send_sms	false
currency	false
invoice_limit	false

fetch

HTTP: GET
Path: /plan/{code}

paystack.plan.fetch(code)

Path Parameters

Name	Required
code	true

list

HTTP: GET
Path: /plan

paystack.plan.list({ ... })

Query Fields

Name	Required
perPage	false
page	false
interval	false
amount	false
from	false
to	false

update

HTTP: PUT
Path: /plan/{code}

paystack.plan.update(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
name	false
amount	false
interval	false
description	false
send_invoices	false
send_sms	false
currency	false
invoice_limit	false