GET /v1/subscriptions/current
Get current subscription
Returns the user's current active subscription plan with features and usage statistics
Request
GET /v1/subscriptions/current
Parameters
[]
Response
{
"200": {
"description": "Current subscription retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"subscription": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"package_id": {
"type": "string"
},
"billing_cycle": {
"type": "string"
},
"status": {
"type": "string"
},
"current_period_start": {
"type": "string"
},
"current_period_end": {
"type": "string"
},
"trial_ends_at": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"user_id",
"package_id",
"billing_cycle",
"status",
"current_period_start",
"current_period_end",
"trial_ends_at",
"created_at"
]
},
"package": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"price_monthly": {
"type": "number"
},
"price_yearly": {
"type": "number"
},
"features": {
"type": "array",
"items": {
"type": "object",
"properties": {
"feature_key": {
"type": "string"
},
"feature_value": {
"type": "string"
},
"display_name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
}
},
"required": [
"feature_key",
"feature_value",
"display_name",
"description"
]
}
}
},
"required": [
"id",
"name",
"price_monthly",
"price_yearly",
"features"
]
},
"usage": {
"type": "object",
"properties": {
"companies_used": {
"type": "number"
},
"companies_limit": {
"type": "number"
},
"properties_used": {
"type": "number"
},
"properties_limit": {
"type": "number"
},
"integrations_used": {
"type": "number"
},
"integrations_limit": {
"type": "number"
}
},
"required": [
"companies_used",
"companies_limit",
"properties_used",
"properties_limit",
"integrations_used",
"integrations_limit"
]
}
},
"required": [
"subscription",
"package",
"usage"
]
}
},
"required": [
"success",
"data"
]
}
}
}
},
"404": {
"description": "No active subscription found"
}
}
View in Interactive API Reference