Subscription
NovyPay Subscriptions API
Overview
NovyPay allows merchants to create subscription plans (daily, weekly, monthly, or yearly) and accept recurring payments from users using their NovyPay Tokens.
Step 1: Create a Subscription Plan
Endpoint
POST https://burntpay-u44m.onrender.com/subscription/plans/
Request Body
{
"name": "Basic",
"price": "3",
"billing_interval": "daily"
}
name
string
Name of the subscription plan
price
string
Amount to be charged per interval (in USDC)
billing_interval
string
One of: daily
, weekly
, monthly
, yearly
Step 2: View All Your Subscription Plans
Endpoint
GET https://burntpay-u44m.onrender.com/subscription/plans/
Returns all subscription plans created by the authenticated developer or merchant.
Step 3: Get or Edit a Specific Plan
Endpoint
GET / PUT / PATCH https://burntpay-u44m.onrender.com/subscription/plans/{plan_id}/
Use
GET
to retrieve plan details.Use
PUT
orPATCH
to update an existing plan.
Example
GET https://burntpay-u44m.onrender.com/subscription/plans/c09950b1-649c-45c5-96f7-9a20a25eaf0f/
Step 4: Authorize a Subscription (User Action)
Once a plan is created, the user must authorize the subscription using their NovyPay Token.
Endpoint
POST https://burntpay-u44m.onrender.com/subscription/authorize/{plan_id}/
Example
POST https://burntpay-u44m.onrender.com/subscription/authorize/55ad6c0a-03a1-44cc-a833-03d68179b395/
After authorization, NovyPay will automatically deduct the subscription amount based on the interval.
How It Works
Merchant creates a subscription plan.
User authorizes the subscription using their NovyPay Token.
NovyPay handles recurring billing in USDC.
Merchant receives payments automatically at each interval.
Last updated