{
"customerEmail": "alice@example.com",
"customerName": "Alice Johnson",
"walletAddress": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef12"
}
{
"id": "sub_abc123def456",
"planId": "plan_abc123def456",
"planName": "Pro Monthly",
"customerEmail": "alice@example.com",
"customerName": "Alice Johnson",
"walletAddress": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef12",
"status": "trialing",
"currentPeriodStart": "2026-03-26T14:30:00Z",
"currentPeriodEnd": "2026-04-26T14:30:00Z",
"trialEnd": "2026-04-09T14:30:00Z",
"createdAt": "2026-03-26T14:30:00Z"
}
Subscriptions
Subscribe to Plan
Create a new subscription for a customer on a specific plan
POST
/
v1
/
subscription-plans
/
{id}
/
subscribe
{
"customerEmail": "alice@example.com",
"customerName": "Alice Johnson",
"walletAddress": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef12"
}
{
"id": "sub_abc123def456",
"planId": "plan_abc123def456",
"planName": "Pro Monthly",
"customerEmail": "alice@example.com",
"customerName": "Alice Johnson",
"walletAddress": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef12",
"status": "trialing",
"currentPeriodStart": "2026-03-26T14:30:00Z",
"currentPeriodEnd": "2026-04-26T14:30:00Z",
"trialEnd": "2026-04-09T14:30:00Z",
"createdAt": "2026-03-26T14:30:00Z"
}
Authentication
This endpoint requires a Bearer token in theAuthorization header.
Authorization: Bearer <your_jwt_token>
Path Parameters
string
required
The unique identifier of the subscription plan to subscribe to.
Body Parameters
string
required
The email address of the customer subscribing to the plan. Used for sending receipts and renewal notifications.
string
required
The full name of the customer.
string
required
The customer’s cryptocurrency wallet address. Recurring payments will be collected from this address via the on-chain subscription smart contract.
Response
string
Unique identifier for the subscription.
string
The ID of the subscription plan.
string
The name of the subscription plan.
string
The subscriber’s email address.
string
The subscriber’s name.
string
The subscriber’s wallet address.
string
The subscription status. Newly created subscriptions start as
active (or trialing if the plan has a trial period).string
ISO 8601 timestamp marking the start of the current billing period.
string
ISO 8601 timestamp marking the end of the current billing period.
string
ISO 8601 timestamp marking when the trial period ends, if applicable.
string
ISO 8601 timestamp of when the subscription was created.
{
"customerEmail": "alice@example.com",
"customerName": "Alice Johnson",
"walletAddress": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef12"
}
{
"id": "sub_abc123def456",
"planId": "plan_abc123def456",
"planName": "Pro Monthly",
"customerEmail": "alice@example.com",
"customerName": "Alice Johnson",
"walletAddress": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef12",
"status": "trialing",
"currentPeriodStart": "2026-03-26T14:30:00Z",
"currentPeriodEnd": "2026-04-26T14:30:00Z",
"trialEnd": "2026-04-09T14:30:00Z",
"createdAt": "2026-03-26T14:30:00Z"
}