{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-esim-purchase-schema.json",
  "title": "SIMCardRegistration",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-sim-cards-api-openapi.yml#/components/schemas/ESimPurchase",
  "properties": {
    "amount": {
      "description": "The amount of eSIMs to be purchased.",
      "minimum": 1,
      "type": "integer"
    },
    "product": {
      "description": "Type of product to be purchased, specify \"whitelabel\" to use a custom SPN",
      "type": "string"
    },
    "sim_card_group_id": {
      "description": "The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.",
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "default": "enabled",
      "description": "Status on which the SIM cards will be set after being successfully registered.",
      "enum": [
        "enabled",
        "disabled",
        "standby"
      ],
      "type": "string"
    },
    "tags": {
      "description": "Searchable tags associated with the SIM cards",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "whitelabel_name": {
      "description": "Service Provider Name (SPN) for the Whitelabel eSIM product. It will be displayed as the mobile service name by operating systems of smartphones. This parameter must only contain letters, numbers and whitespaces.",
      "type": "string"
    }
  },
  "required": [
    "amount"
  ],
  "type": "object"
}