Subscriptions & Plans API

Plans

class djpaystack.api.plans.PlanAPI(client)

Bases: BaseAPI

Plans API

create(name: str, amount: int, interval: str, description: str | None = None, currency: str | None = None, invoice_limit: int | None = None, send_invoices: bool | None = None, send_sms: bool | None = None) → Dict[str, Any]

Create plan

list(per_page: int = 50, page: int | None = None, status: str | None = None, interval: str | None = None, amount: int | None = None) → Dict[str, Any]

List plans

fetch(id_or_code: str) → Dict[str, Any]

Fetch plan

update(id_or_code: str, name: str | None = None, amount: int | None = None, interval: str | None = None, description: str | None = None, currency: str | None = None, invoice_limit: int | None = None, send_invoices: bool | None = None, send_sms: bool | None = None) → Dict[str, Any]

Update plan

Subscriptions

class djpaystack.api.subscriptions.SubscriptionAPI(client)

Bases: BaseAPI

Subscriptions API

create(customer: str, plan: str, authorization: str | None = None, start_date: str | None = None) → Dict[str, Any]

Create subscription

list(per_page: int = 50, page: int | None = None, customer: int | None = None, plan: int | None = None) → Dict[str, Any]

List subscriptions

fetch(id_or_code: str) → Dict[str, Any]

Fetch subscription

enable(code: str, token: str) → Dict[str, Any]

Enable subscription

disable(code: str, token: str) → Dict[str, Any]

Disable subscription

generate_update_link(code: str) → Dict[str, Any]

Generate update subscription link

send_update_link(code: str) → Dict[str, Any]

Send update subscription link

Quick Reference

from djpaystack import PaystackClient
client = PaystackClient()

# Plans
client.plans.create(name=..., amount=..., interval=...)
client.plans.list()
client.plans.fetch(id_or_code=...)
client.plans.update(id_or_code=..., name=..., amount=...)

# Subscriptions
client.subscriptions.create(customer=..., plan=..., authorization=...)
client.subscriptions.list()
client.subscriptions.fetch(id_or_code=...)
client.subscriptions.enable(code=..., token=...)
client.subscriptions.disable(code=..., token=...)
client.subscriptions.generate_update_link(code=...)