Path parameters

• iso3 string Required

  ISO Alpha-3 code of the Destination

Query parameters

• discountCode string

  Optional discount code applied to the returned Plan prices

• planType string

  Optional filter on the Plan type:

  • DATA - Data-only Plans
  • VOICE_AND_DATA - Plans including voice (and SMS) in addition to data

  Values are DATA or VOICE_AND_DATA.

Responses

• 200 application/json

  Unlimited local Plans fetched successfully

  Hide response attributes Show response attributes object

  • id string
  • destination object
    Hide destination attributes Show destination attributes object

    • name string
    • isoAlpha3 string
  • region object
    Hide region attributes Show region attributes object

    • name string
    • abbreviation string
  • dataUnit string

    Possible values:

    • MB - MegaByte representation
    • GB - GigaByte representation

    Values are MB or GB.

  • dataValue number

    Details:

    • If dataValue >= 0 then the plan is capped to that amount of consumable data
      
    • If dataValue == -1 then the plan is unlimited and does not have a cap on consumable data
  • callUnit string

    Details:

    • MINUTES - Minutes representation
      
    • HOURS - Hours representation

    Values are MINUTES or HOURS.

  • callValue number

    Details:

    • If callValue >= 0 then the plan is capped to that amount of consumable call time
      
    • If callValue == -1 then the plan is unlimited and does not have a cap on call time
  • smsUnit string
  • smsValue number

    Details:

    • If smsValue >= 0 then the plan is capped to that amount of consumable SMS sent
      
    • If smsValue == -1 then the plan is unlimited and does not have a cap on SMS sent
  • durationUnit string
  • durationValue number
  • features array[object]
    Hide features attributes Show features attributes object

    • name string

      Possible values:

      • HOTSPOT - The plan does support the hotspot function
      • TOP_UP - The plan does support top up operations
      • 3G - The plan and its associated network supports speeds up to 3G
      • 4G - The plan and its associated network supports speeds up to 4G
      • 5G - The plan and its associated network supports speeds up to 5G

      Values are HOTSPOT, TOP_UP, 3G, 4G, or 5G.

    • category string

      Values are UTILITY, BILLING, or NETWORK.

  • prices array[object]
    Hide prices attributes Show prices attributes object

    • currencyISO string
    • value number

      The unit amount in cents (if supported), represented as a signed integer

    • minorExponentUnits number

      Indicates the number of decimals in the price for currencies supporting this format or 0 for zero-decimal currencies such as JPY. Examples:

      • A USD price value of 490 with a minorExponentUnits of 2 would be $4.90
      • A JPY price value of 775 with a minorExponentUnits of 0 would be ¥775