Responses

• 200 application/json

  Orders fetched successfully

  Hide response attributes Show response attributes object

  • id string

    The Order's ID

  • status string

    Statuses:

    • PENDING_APPROVAL - The Order is awaiting approval from an Admin / Purchaser / Owner
    • PENDING_PAYMENT - The Order is awaiting payment from the User
    • PROCESSING - The Order is being processed by the network and should soon be fulfilled
    • FULFILLED - The Order has been fulfilled and the associated Subscription / eSIM is ready
    • CANCELLED - The Order has been cancelled by the User
    • FAILED - The Order has failed — see failureReason for details
    • REPLACED - The Order has been superseded by a newer one
    • IN_BASKET - The Order is currently sitting in the User's basket

    Values are PENDING_APPROVAL, PENDING_PAYMENT, PROCESSING, FULFILLED, CANCELLED, FAILED, REPLACED, or IN_BASKET.

  • accountID string

    The Account ID linked to the Order

  • planID string

    The Plan ID linked to the Order

  • userID string

    The User ID for which the Order was generated

  • type string

    Types:

    • ONE_OFF - The Order is a one-off purchase
    • TOP_UP - The Order tops up an existing Subscription
    • RECURRING - The Order is part of a recurring Subscription

    Values are ONE_OFF, TOP_UP, or RECURRING.

  • paymentID string

    The Payment ID linked to the Order, when applicable

  • paymentReference string

    The external payment reference

  • notifyRecipient boolean

    If true, the end User has been (or will be) notified about this Order

  • failureReason string

    Set when status is FAILED — explains why the Order could not be fulfilled

  • plan object
    Hide plan attributes Show plan 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
  • subscription object
    Hide subscription attributes Show subscription attributes object

    • id string

      The Subscription's ID

    • esimID string

      The associated eSIM ID

    • plan object
      Hide plan attributes Show plan 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
    • status string

      Statuses:

      • PROCESSING - The Subscription is being processed and should be ready soon
      • PENDING - The Subscription is ready and is pending first use by the User
      • ACTIVE - The Subscription is currently active and used by the User
      • EXPIRED - The Subscription has expired and is no longer valid
      • CANCELLED - The Subscription has been cancelled by the User
      • DEPLETED - The allocation of the Subscription has been fully consumed by the User

      Values are PROCESSING, PENDING, ACTIVE, EXPIRED, CANCELLED, or DEPLETED.

  • createdAt string(date-time)
  • updatedAt string(date-time)