SubscriptionActionResponse

Response for subscription actions (cancel/reactivate).

successSuccess (boolean)required

messageMessage (string)required

subscription object

anyOf

• SubscriptionResponse
• null

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
• null

string

sla object

anyOf

• string
• null

string

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

stripe_price_id object

Stripe price ID for checkout

anyOf

• string
• null

string

statusStatus (string)required

Subscription status (active/canceled/past_due)

current_period_start object

ISO 8601 datetime

anyOf

• string
• null

string

current_period_end object

ISO 8601 datetime

anyOf

• string
• null

string

cancel_at_period_endCancel At Period End (boolean)

Default value: false

created_atCreated At (string)required

ISO 8601 datetime

SubscriptionActionResponse

{
  "success": true,
  "message": "string",
  "subscription": {
    "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"
      },
      "limits": {
        "api_calls": 0,
        "geofences": 0,
        "webhooks_delivered": 0,
        "test_points": 0,
        "rate_limit_per_hour": 0
      },
      "stripe_price_id": "string"
    },
    "status": "string",
    "current_period_start": "string",
    "current_period_end": "string",
    "cancel_at_period_end": false,
    "created_at": "string"
  }
}