Skip to main content
POST
/
subscriptions
/
plans
Subscription Plans
curl --request POST \
  --url https://api-sandbox.pavewaygroup.com/v1/subscriptions/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "amount": 123,
  "currency": "<string>",
  "billing_cycle": "<string>",
  "trial_days": 123
}
'
{
  "status_code": 200,
  "data": {
    "id": "658dc...",
    "name": "Silver Monthly",
    "code": "silver_v1",
    "amount": 5000,
    "currency": "XAF",
    "billing_cycle": "monthly"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pavewaygroup.com/llms.txt

Use this file to discover all available pages before exploring further.

Plans define the cost and frequency of a recurring charge.

​
Create a Plan

POST /subscriptions/plans
​
name
string
required
Name shown to customers (e.g., “Silver Monthly”).
​
code
string
required
Unique slug for your plan (e.g., silver_v1).
​
amount
number
required
Price per period.
​
currency
string
default:"XAF"
XAF, NGN, USD, etc.
​
billing_cycle
string
required
Frequency: daily, weekly, monthly, quarterly, yearly.
​
trial_days
integer
default:"0"
Number of free trial days before the first charge.
{
  "status_code": 200,
  "data": {
    "id": "658dc...",
    "name": "Silver Monthly",
    "code": "silver_v1",
    "amount": 5000,
    "currency": "XAF",
    "billing_cycle": "monthly"
  }
}

​
List Plans

GET /subscriptions/plans

​
Deactivate Plan

DELETE /subscriptions/plans/{id}