Subscription Plan

The Subscription Plan endpoint allows you to retrieve active subscription plans for the partner

GET/subscription-plan

Get active subscription plans

This endpoint retrieves all active subscription plan and details for the partner.

Response behavior

Returns 200 with filtered subscription plan data if found
Returns 404 if no active subscription plans found with SUBSCRIPTION_PLAN_NOT_FOUND message
Requires authentication via Bearer token
Response data is filtered through filterSubscriptionPlanFields function

Request

GET

/subscription-plan

curl https://beta-api.uprise.us/subscription-plan \
  -H "Authorization: Bearer {token}"

Response

[
  {
    "id": "plan-uuid-1",
    "name": "essential_quarterly",
    "displayName": "Essential",
    "productName": "essential",
    "description": "Essential financial planning package",
    "price": "{Plan price}",
    "currency": "USD",
    "paymentFrequency": "quarterly",
    "isActive": true,
    "isUpgradable": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  },
  {
    "id": "plan-uuid-2",
    "name": "premium_quarterly",
    "displayName": "Premium",
    "productName": "premium_business_owner",
    "description": "Premium financial planning with business focus",
    "price": "{Plan price}",
    "currency": "USD",
    "paymentFrequency": "quarterly",
    "isActive": true,
    "isUpgradable": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
]

Response (No subscription plans found)

{
  "message": "Subscription plan not found"
}