FAQ for Organization
  • Welcome
  • Onboarding Guide
    • Mandatory settings
      • 1. Integrate your Telecoms
      • 2. Create Company
      • 3. Upload your SIM(s)
      • 4. Create Plan(s)
      • 5. Assign the plan to SIM(s)
    • Optional settings
      • 1. Account Settings
      • 2. User Profile
      • 3. PSP Integration
      • 4. Invoice Integration
      • 5. Create Pools
      • 6. Invite Staff
      • 7. Customize Columns
      • 8. Notifications
      • 9. Communication
  • Menu
    • Roles on the platform
    • SIMs
      • SIM Statuses
      • General Terms
      • Key Features
      • Q&A
    • Satellite
      • Terminal Statuses
      • Upload Terminals
    • Pools
    • Plans
      • Prepaid
      • Subscription
      • PAYGO
    • Companies
    • End Users
    • Automation - Rules
    • Transactions
    • Wallet
    • Webhooks
      • Terms used
      • Endpoint validation
      • Authentication
      • Webhook Payload Models
        • Account Model
        • End User Model
        • Account Address Model
        • Wallet Model
        • Plan Model
        • Pool Model
        • SIM Card Model
        • Status Model
        • User Model
        • Prepaid Refill Model
        • Date Time Model
        • Rule Model
        • Payment Model
        • Credit Card Model
      • Webhook Payload Types
        • Technical Payloads
        • Event Payloads
          • Company Events
          • Company Staff Events
          • End User Events
          • SIM Card Events
          • Payment Payloads
        • Rule Payloads
          • SIM Card Rule Payloads
          • SIM Pools Payloads
          • Wallet Payloads
  • e-SIM Store
    • Upload SIMs
    • eSIM Purchase & Activation
    • eSIM Store Activation
    • Q&A
Powered by GitBook
On this page
  1. Menu
  2. Webhooks
  3. Webhook Payload Models

Plan Model

The Plan Model – is a base model for showing platform plan parameters. Model fields are presented in the table (Table 4.6), with an example below (Listing 4.5). There are the following types of this model (Table 4.7).

Table 4.6 – Fields of Plan Model

№
Key
Type
Exists
Description

1

uuid

uuid v4, string

required

Main identifier of plan

2

type

string

required

Type of the plan

3

name

string

required

Public name of the plan

4

operator_title

string

optional

Title of operator with integration, if it exists

5

prepaid_refills

array

optional

Available refills for this plan

Listing 4.5 – Example of Plan Model (JSON)

{
     "uuid":            "271295c0-2019-470d-b7d9-b79bc2686cfd",
     "type":            "prepaid",
     "name":            "Plan Name",
     "operator_title":  "Test Operator (Integration)"
     "prepaid_refills":          [
         {...//Refill Model},
         {...//Refill Model},
         ...other refills
     ]
}

Table 4.7 – Plan Types

№
Title
Description

1

Monthly bundle

Pay after using. One of subscription subtype

2

Pay per MB

There is static price for MB. One of subscription subtype

3

Unlimited

Usage is unlimited. One of subscription subtype

4

Dynamic pool

Pool usage can change. One of subscription subtype

5

Static pool

Pool usage can’t change. One of subscription subtype

6

Prepaid

Need to pay before using

7

PAYGO

One of subscription subtype

PreviousWallet ModelNextPool Model

Last updated 8 months ago