subscription.md

Subscription

A collection of endpoints for creating and managing recurring payments

Methods

Method	HTTP	Path	Summary
create	POST	/subscription	Create Subscription
disable	POST	/subscription/disable	Disable Subscription
enable	POST	/subscription/enable	Enable Subscription
fetch	GET	/subscription/{code}	Fetch Subscription
list	GET	/subscription	List Subscriptions
manage_email	POST	/subscription/{code}/manage/email	Send Update Subscription Link
manage_link	GET	/subscription/{code}/manage/link	Generate Update Subscription Link

---

create

HTTP: POST
Path: /subscription

paystack.subscription.create({ ... })

Body Fields

Name	Required
customer	true
plan	true
authorization	false
start_date	false

disable

HTTP: POST
Path: /subscription/disable

paystack.subscription.disable({ ... })

Body Fields

Name	Required
code	true
token	true

enable

HTTP: POST
Path: /subscription/enable

paystack.subscription.enable({ ... })

Body Fields

Name	Required
code	true
token	true

fetch

HTTP: GET
Path: /subscription/{code}

paystack.subscription.fetch(code)

Path Parameters

Name	Required
code	true

list

HTTP: GET
Path: /subscription

paystack.subscription.list({ ... })

Query Fields

Name	Required
perPage	false
page	false
plan	false
customer	false
from	false
to	false

manage_email

HTTP: POST
Path: /subscription/{code}/manage/email

paystack.subscription.manage_email(code)

Path Parameters

Name	Required
code	true

manage_link

HTTP: GET
Path: /subscription/{code}/manage/link

paystack.subscription.manage_link(code)

Path Parameters

Name	Required
code	true