Skip to content

chore: update subscriptions examples and descriptions #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damilola-paystack merged 2 commits into from
Sep 11, 2025
Merged

chore: update subscriptions examples and descriptions #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c23d9c
chore: update subscriptions examples and descriptions
damilola-paystack Sep 11, 2025
17931c1
chore: update data type
damilola-paystack Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions dist/paystack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2549,6 +2549,7 @@
tags:
- Plan
summary: Update Plan
description: Update a plan details on your integration
operationId: plan_update
requestBody:
content:
Expand All @@ -2572,6 +2573,7 @@
tags:
- Subscription
summary: Create Subscription
description: Create a subscription a customer
operationId: subscription_create
requestBody:
content:
Expand All @@ -2592,6 +2594,7 @@
tags:
- Subscription
summary: List Subscriptions
description: List all subscriptions available on your integration
operationId: subscription_list
parameters:
- in: query
Expand All @@ -2606,9 +2609,10 @@
description: The section to retrieve
- in: query
name: plan
schema:
type: string
description: Plan ID
schema:
type: integer
example: 2697466
- in: query
name: customer
schema:
Expand Down Expand Up @@ -2640,12 +2644,15 @@
- name: code
in: path
required: true
description: The subscription code for the subscription you want to fetch
schema:
type: string
example: SUB_5co81xgmwg78x3d
get:
tags:
- Subscription
summary: Fetch Subscription
description: Get details of a customer's subscription
operationId: subscription_fetch
responses:
'200':
Expand All @@ -2661,6 +2668,7 @@
tags:
- Subscription
summary: Disable Subscription
description: Disable a subscription on your integration
operationId: subscription_disable
requestBody:
content:
Expand All @@ -2682,6 +2690,7 @@
tags:
- Subscription
summary: Enable Subscription
description: Enable a subscription on your integration
operationId: subscription_enable
requestBody:
content:
Expand All @@ -2703,13 +2712,16 @@
tags:
- Subscription
summary: Generate Update Subscription Link
description: Generate a link for updating the card on a subscription
operationId: subscription_manageLink
parameters:
- name: code
in: path
required: true
description: Subscription code
schema:
type: string
example: qlgwhpyq1ts9nsw
responses:
'200':
$ref: '#/components/responses/Ok'
Expand All @@ -2722,13 +2734,16 @@
tags:
- Subscription
summary: Send Update Subscription Link
description: Email a customer a link for updating the card on their subscription
operationId: subscription_manageEmail
parameters:
- name: code
in: path
required: true
description: Subscription code
schema:
type: string
example: qlgwhpyq1ts9nsw
responses:
'200':
$ref: '#/components/responses/Ok'
Expand All @@ -2737,7 +2752,7 @@
default:
description: Server error
/transferrecipient:
post:

Check warning on line 2755 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer Recipient
summary: Create Transfer Recipient
Expand All @@ -2761,7 +2776,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 2779 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer Recipient
summary: List Transfer Recipients
Expand Down Expand Up @@ -2808,7 +2823,7 @@
default:
description: Server error
/transferrecipient/bulk:
post:

Check warning on line 2826 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer Recipient
summary: Bulk Create Transfer Recipient
Expand Down Expand Up @@ -2840,7 +2855,7 @@
required: true
schema:
type: string
get:

Check warning on line 2858 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer Recipient
summary: Fetch Transfer recipient
Expand All @@ -2858,7 +2873,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 2876 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer Recipient
summary: Update Transfer recipient
Expand All @@ -2884,7 +2899,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 2902 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer Recipient
summary: Delete Transfer Recipient
Expand All @@ -2903,7 +2918,7 @@
default:
description: Server error
/transfer:
post:

Check warning on line 2921 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Initiate Transfer
Expand All @@ -2927,7 +2942,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 2945 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: List Transfers
Expand Down Expand Up @@ -3007,7 +3022,7 @@
default:
description: Server error
/transfer/finalize_transfer:
post:

Check warning on line 3025 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Finalize Transfer
Expand All @@ -3028,7 +3043,7 @@
default:
description: Server error
/transfer/bulk:
post:

Check warning on line 3046 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Initiate Bulk Transfer
Expand Down Expand Up @@ -3060,7 +3075,7 @@
required: true
schema:
type: string
get:

Check warning on line 3078 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Fetch Transfer
Expand All @@ -3079,7 +3094,7 @@
default:
description: Server error
/transfer/verify/{reference}:
get:

Check warning on line 3097 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Verify Transfer
Expand All @@ -3104,7 +3119,7 @@
default:
description: Server error
/transfer/export:
get:

Check warning on line 3122 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Export Transfers
Expand Down Expand Up @@ -3153,7 +3168,7 @@
default:
description: Server error
/transfer/resend_otp:
post:

Check warning on line 3171 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Resend OTP for Transfer
Expand All @@ -3178,7 +3193,7 @@
default:
description: Server error
/transfer/disable_otp:
post:

Check warning on line 3196 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Disable OTP for Transfers
Expand All @@ -3195,7 +3210,7 @@
default:
description: Server error
/transfer/disable_otp_finalize:
post:

Check warning on line 3213 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Finalize Disabling OTP for Transfers
Expand All @@ -3220,7 +3235,7 @@
default:
description: Server error
/transfer/enable_otp:
post:

Check warning on line 3238 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Transfer
summary: Enable OTP requirement for Transfers
Expand All @@ -3237,7 +3252,7 @@
default:
description: Server error
/product:
post:

Check warning on line 3255 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Product
summary: Create Product
Expand All @@ -3257,7 +3272,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3275 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Product
summary: List Products
Expand Down Expand Up @@ -3303,7 +3318,7 @@
required: true
schema:
type: string
get:

Check warning on line 3321 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Product
summary: Fetch Product
Expand All @@ -3317,7 +3332,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3335 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Product
summary: Update product
Expand All @@ -3339,7 +3354,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 3357 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Product
summary: Delete Product
Expand All @@ -3354,7 +3369,7 @@
default:
description: Server error
/storefront:
post:

Check warning on line 3372 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Create Storefront
Expand All @@ -3374,7 +3389,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3392 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: List Storefronts
Expand Down Expand Up @@ -3411,7 +3426,7 @@
required: true
schema:
type: string
get:

Check warning on line 3429 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Fetch Storefront
Expand All @@ -3425,7 +3440,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3443 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Update Storefront
Expand All @@ -3447,7 +3462,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 3465 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Delete Storefront
Expand All @@ -3468,7 +3483,7 @@
required: true
schema:
type: string
get:

Check warning on line 3486 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Verify Storefront Slug
Expand Down Expand Up @@ -3510,7 +3525,7 @@
required: true
schema:
type: string
post:

Check warning on line 3528 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Add Products to Storefront
Expand All @@ -3532,7 +3547,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
get:

Check warning on line 3550 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: List Products in Storefront
Expand All @@ -3553,7 +3568,7 @@
required: true
schema:
type: string
post:

Check warning on line 3571 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Publish Storefront
Expand All @@ -3574,7 +3589,7 @@
required: true
schema:
type: string
post:

Check warning on line 3592 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Duplicate Storefront
Expand All @@ -3589,7 +3604,7 @@
default:
description: Server error
/order:
post:

Check warning on line 3607 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Create Order
Expand All @@ -3609,7 +3624,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3627 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: List Orders
Expand Down Expand Up @@ -3653,7 +3668,7 @@
required: true
schema:
type: string
get:

Check warning on line 3671 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Fetch Order
Expand All @@ -3674,7 +3689,7 @@
required: true
schema:
type: string
get:

Check warning on line 3692 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Fetch Products Order
Expand All @@ -3695,7 +3710,7 @@
required: true
schema:
type: string
get:

Check warning on line 3713 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Validate pay for me order
Expand All @@ -3710,7 +3725,7 @@
default:
description: Server error
/page:
post:

Check warning on line 3728 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Create Page
Expand All @@ -3730,7 +3745,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3748 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: List Pages
Expand Down Expand Up @@ -3774,7 +3789,7 @@
required: true
schema:
type: string
get:

Check warning on line 3792 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Fetch Page
Expand All @@ -3788,7 +3803,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3806 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Update Page
Expand Down Expand Up @@ -3817,7 +3832,7 @@
required: true
schema:
type: string
get:

Check warning on line 3835 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Check Slug Availability
Expand All @@ -3838,7 +3853,7 @@
required: true
schema:
type: string
post:

Check warning on line 3856 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Add Products
Expand All @@ -3859,7 +3874,7 @@
default:
description: Server error
/paymentrequest:
post:

Check warning on line 3877 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Create Payment Request
Expand All @@ -3879,7 +3894,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3897 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: List Payment Request
Expand Down Expand Up @@ -3938,7 +3953,7 @@
required: true
schema:
type: string
get:

Check warning on line 3956 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Fetch Payment Request
Expand All @@ -3952,7 +3967,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3970 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Update Payment Request
Expand Down Expand Up @@ -3981,7 +3996,7 @@
required: true
schema:
type: string
get:

Check warning on line 3999 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Verify Payment Request
Expand All @@ -4002,7 +4017,7 @@
required: true
schema:
type: string
post:

Check warning on line 4020 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Send Notification
Expand All @@ -4015,7 +4030,7 @@
default:
description: Server error
/paymentrequest/totals:
get:

Check warning on line 4033 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Payment Request Total
Expand All @@ -4036,7 +4051,7 @@
required: true
schema:
type: string
post:

Check warning on line 4054 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Finalize Payment Request
Expand All @@ -4055,7 +4070,7 @@
required: true
schema:
type: string
post:

Check warning on line 4073 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Payment Request
summary: Archive Payment Request
Expand All @@ -4068,7 +4083,7 @@
default:
description: Server error
/settlement:
get:

Check warning on line 4086 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Settlement
summary: Fetch Settlements
Expand All @@ -4094,7 +4109,7 @@
default:
description: Server error
/settlement/{id}/transaction:
get:

Check warning on line 4112 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Settlement
summary: Settlement Transactions
Expand Down Expand Up @@ -4135,7 +4150,7 @@
default:
description: Server error
/balance/ledger:
get:

Check warning on line 4153 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Balance
summary: Balance Ledger
Expand Down Expand Up @@ -4177,7 +4192,7 @@
default:
description: Server error
/integration/payment_session_timeout:
get:

Check warning on line 4195 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Integration
summary: Fetch Payment Session Timeout
Expand All @@ -4195,7 +4210,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4213 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Integration
summary: Update Payment Session Timeout
Expand All @@ -4219,7 +4234,7 @@
default:
description: Server error
/refund:
post:

Check warning on line 4237 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: Create Refund
Expand All @@ -4239,7 +4254,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 4257 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: List Refunds
Expand Down Expand Up @@ -4277,7 +4292,7 @@
default:
description: Server error
/refund/{id}:
get:

Check warning on line 4295 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: Fetch Refund
Expand All @@ -4298,7 +4313,7 @@
default:
description: Server error
/dispute:
get:

Check warning on line 4316 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: List Disputes
Expand Down Expand Up @@ -4353,7 +4368,7 @@
required: true
schema:
type: string
get:

Check warning on line 4371 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Fetch Dispute
Expand All @@ -4367,7 +4382,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4385 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Update Dispute
Expand All @@ -4390,7 +4405,7 @@
default:
description: Server error
/dispute/{id}/upload_url:
get:

Check warning on line 4408 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Get Upload URL
Expand All @@ -4412,7 +4427,7 @@
default:
description: Server error
/dispute/export:
get:

Check warning on line 4430 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Export Disputes
Expand Down Expand Up @@ -4454,7 +4469,7 @@
default:
description: Server error
/dispute/transaction/{id}:
get:

Check warning on line 4472 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: List Transaction Disputes
Expand All @@ -4476,7 +4491,7 @@
default:
description: Server error
/dispute/{id}/resolve:
put:

Check warning on line 4494 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Resolve a Dispute
Expand Down Expand Up @@ -4506,7 +4521,7 @@
default:
description: Server error
/dispute/{id}/evidence:
post:

Check warning on line 4524 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Add Evidence
Expand Down Expand Up @@ -4534,7 +4549,7 @@
default:
description: Server error
/bank:
get:

Check warning on line 4552 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Bank
summary: List Banks
Expand Down Expand Up @@ -4585,7 +4600,7 @@
default:
description: Server error
/bank/resolve:
get:

Check warning on line 4603 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Bank
summary: Resolve Account Number
Expand All @@ -4611,7 +4626,7 @@
default:
description: Server error
/bank/validate:
post:

Check warning on line 4629 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Bank
summary: Validate Bank Account
Expand All @@ -4632,7 +4647,7 @@
default:
description: Server error
/decision/bin/{bin}:
get:

Check warning on line 4650 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Miscellaneous
summary: Resolve Card BIN
Expand All @@ -4653,7 +4668,7 @@
default:
description: Server error
/country:
get:

Check warning on line 4671 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Miscellaneous
summary: List Countries
Expand Down Expand Up @@ -11097,6 +11112,9 @@
description: Set the date for the first debit. (ISO 8601 format) e.g. 2017-05-16T00:30:13+01:00
type: string
format: date-time
example:
customer: CUS_xnxdt6s1zg1f4nx
plan: PLN_gx2wn530m0i3w3m
SubscriptionCreateResponse:
type: object
properties:
Expand Down Expand Up @@ -11376,6 +11394,9 @@
token:
description: Email token
type: string
example:
code: SUB_vsyqdmlzble3uii
token: d7gofp6yppn3qz7
SubscriptionDisableResponse:
type: object
properties:
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/components/schemas/SubscriptionCreate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ properties:
2017-05-16T00:30:13+01:00
type: string
format: date-time
example:
customer: "CUS_xnxdt6s1zg1f4nx"
plan: "PLN_gx2wn530m0i3w3m"
3 changes: 3 additions & 0 deletions src/assets/openapi/components/schemas/SubscriptionToggle.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ properties:
token:
description: Email token
type: string
example:
code: "SUB_vsyqdmlzble3uii"
token: "d7gofp6yppn3qz7"
1 change: 1 addition & 0 deletions src/assets/openapi/paths/plan_{code}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ put:
tags:
- Plan
summary: Update Plan
description: Update a plan details on your integration
operationId: plan_update
requestBody:
content:
Expand Down
7 changes: 5 additions & 2 deletions src/assets/openapi/paths/subscription.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ post:
tags:
- Subscription
summary: Create Subscription
description: Create a subscription a customer
operationId: subscription_create
requestBody:
content:
Expand All @@ -22,6 +23,7 @@ get:
tags:
- Subscription
summary: List Subscriptions
description: List all subscriptions available on your integration
operationId: subscription_list
parameters:
- in: query
Expand All @@ -36,9 +38,10 @@ get:
description: The section to retrieve
- in: query
name: plan
schema:
type: string
description: Plan ID
schema:
type: integer
example: 2697466
- in: query
name: customer
schema:
Expand Down
1 change: 1 addition & 0 deletions src/assets/openapi/paths/subscription_disable.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ post:
tags:
- Subscription
summary: Disable Subscription
description: Disable a subscription on your integration
operationId: subscription_disable
requestBody:
content:
Expand Down
1 change: 1 addition & 0 deletions src/assets/openapi/paths/subscription_enable.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ post:
tags:
- Subscription
summary: Enable Subscription
description: Enable a subscription on your integration
operationId: subscription_enable
requestBody:
content:
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/paths/subscription_{code}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@ parameters:
- name: code
in: path
required: true
description: The subscription code for the subscription you want to fetch
schema:
type: string
example: "SUB_5co81xgmwg78x3d"
get:
tags:
- Subscription
summary: Fetch Subscription
description: Get details of a customer's subscription
operationId: subscription_fetch
responses:
'200':
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/paths/subscription_{code}_manage_email.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@ post:
tags:
- Subscription
summary: Send Update Subscription Link
description: Email a customer a link for updating the card on their subscription
operationId: subscription_manageEmail
parameters:
- name: code
in: path
required: true
description: Subscription code
schema:
type: string
example: "qlgwhpyq1ts9nsw"
responses:
'200':
$ref: ../components/responses/Ok.yaml
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/paths/subscription_{code}_manage_link.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@ get:
tags:
- Subscription
summary: Generate Update Subscription Link
description: Generate a link for updating the card on a subscription
operationId: subscription_manageLink
parameters:
- name: code
in: path
required: true
description: Subscription code
schema:
type: string
example: "qlgwhpyq1ts9nsw"
responses:
'200':
$ref: ../components/responses/Ok.yaml
Expand Down
Loading