PlanChangePreviewResponse

Preview of plan change with proration.

current_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

new_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

prorated_amountProrated Amount (integer)required

immediate_chargeImmediate Charge (integer)required

next_invoice_changeNext Invoice Change (integer)required

effective_dateEffective Date (string)required

PlanChangePreviewResponse

{
  "current_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"
  },
  "new_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"
  },
  "prorated_amount": 0,
  "immediate_charge": 0,
  "next_invoice_change": 0,
  "effective_date": "string"
}