Organizations

Get data plan

Retrieves the details of a specific data plan.

get/plans/{planId}

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/plans/:planId/get.ts
A function with typed inputs. Its response is checked against the schema.

planIdinteger required

ID of the plan

include_rate_card_rangeboolean

When true, each plan response will include variable_rates_range metadata sourced from the rate card API

rate_card_effective_datestring

Override the effective date used when fetching plan rate card data

successboolean

Indicates whether the request was successful.

{
  "success": true
}

No recorded changes to this operation across all 1 revision of this API.