HOhologram
Organizations

List data plans

List all data plans. Returns all data plans matching the specified parameters.

get/plans

Request

Query parameters

orgidinteger

Filter results to this organization ID

idinteger

Filter by a specific plan ID

idsstring

Comma-separated list of plan IDs to filter by

namestring

Filter results to plans whose name contains this string

carrieridinteger

Filter results to plans available on this carrier ID

display_categorystring

Filter results to plans in this display category

startafterinteger

Return results after the record with this ID (cursor-based pagination)

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

limitinteger
Example:25

Maximum number of results to return (max 1000)

cellular_coverage_region_idinteger

Filter results to plans assigned to this cellular coverage region ID

networkinteger

Filter results to plans available on this carrier ID (alias for carrierid)

includezdrboolean

When true, include zero data rate fields (zero_data_rate_flag, zero_data_rate) in each pricing tier

includepidboolean

When true, include the pricing entry ID (tier_pricing_id) in each pricing tier

Response

OK

successboolean

Indicates whether the request was successful.

limitinteger
sizeinteger
continuesboolean
lastidinteger

ID of the last record returned, for cursor-based pagination

Example response

{
  "success": true
}

Changes

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