Skip to main content

SubscriptionResponse

User subscription details.

user_idUser Id (string)required
plan objectrequired

Subscription plan details.

idId (string)required
nameName (string)required
descriptionDescription (string)required
pricePrice (number)required
intervalInterval (string)required

Billing interval (month/year)

features objectrequired

Features included in a subscription plan.

api_callsApi Calls (string)required
geofencesGeofences (string)required
webhooksWebhooks (string)required
test_pointsTest Points (string)required
supportSupport (string)required
custom_domains object
anyOf
string
sla object
anyOf
string
feature_liststring[]

Feature list from model

limits objectrequired

Usage limits for a subscription plan.

api_callsApi Calls (integer)required

Monthly API call limit (-1 for unlimited)

geofencesGeofences (integer)required

Maximum number of geofences (-1 for unlimited)

webhooks_deliveredWebhooks Delivered (integer)required

Monthly webhook delivery limit (-1 for unlimited)

test_pointsTest Points (integer)required

Monthly test point limit (-1 for unlimited)

rate_limit_per_hourRate Limit Per Hour (integer)required

Hourly rate limit

log_retention_daysLog Retention Days (integer)

Log retention in days (-1 for unlimited)

Default value: 7
location_retention_daysLocation Retention Days (integer)

Location data retention in days

Default value: 90
stripe_price_id object

Stripe price ID for checkout

anyOf
string
tierTier (string)

Lowercase plan name (e.g., 'free', 'pro')

Default value:
display_nameDisplay Name (string)

Human-readable plan name

Default value:
price_monthlyPrice Monthly (number)

Monthly price in dollars

Default value: 0
price_yearlyPrice Yearly (number)

Yearly price in dollars

Default value: 0
stripe_price_monthly_id object

Stripe monthly price ID

anyOf
string
stripe_price_yearly_id object

Stripe yearly price ID

anyOf
string
event_overage_rateEvent Overage Rate (number)

Price per extra 100k events

Default value: 0
geofence_overage_rateGeofence Overage Rate (number)

Price per extra 100 geofences

Default value: 0
is_featuredIs Featured (boolean)

Whether this plan is featured/recommended

Default value: false
statusStatus (string)required

Subscription status (active/canceled/past_due)

current_period_start object

ISO 8601 datetime

anyOf
string
current_period_end object

ISO 8601 datetime

anyOf
string
cancel_at_period_endCancel At Period End (boolean)
Default value: false
created_atCreated At (string)required

ISO 8601 datetime

updated_atUpdated At (string)required

ISO 8601 datetime

SubscriptionResponse
{
  "user_id": "string",
  "plan": {
    "id": "string",
    "name": "string",
    "description": "string",
    "price": 0,
    "interval": "string",
    "features": {
      "api_calls": "string",
      "geofences": "string",
      "webhooks": "string",
      "test_points": "string",
      "support": "string",
      "custom_domains": "string",
      "sla": "string",
      "feature_list": [
        "string"
      ]
    },
    "limits": {
      "api_calls": 0,
      "geofences": 0,
      "webhooks_delivered": 0,
      "test_points": 0,
      "rate_limit_per_hour": 0,
      "log_retention_days": 7,
      "location_retention_days": 90
    },
    "stripe_price_id": "string",
    "tier": "",
    "display_name": "",
    "price_monthly": 0,
    "price_yearly": 0,
    "stripe_price_monthly_id": "string",
    "stripe_price_yearly_id": "string",
    "event_overage_rate": 0,
    "geofence_overage_rate": 0,
    "is_featured": false
  },
  "status": "string",
  "current_period_start": "string",
  "current_period_end": "string",
  "cancel_at_period_end": false,
  "created_at": "string",
  "updated_at": "string"
}