Zendit · Schema

Offer

Product offer (top-up, eSIM, voucher).

eSIMGift CardsMobile Top-UpPaymentsPrepaid

Properties

Name	Type	Description
offerId	string	Unique offer identifier.
name	string	Offer display name.
brand	string	Brand identifier.
country	string	Country code.
type	string	Offer type.
subType	string	Offer sub-type.
price	object
send	object
receive	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Offer",
  "description": "Product offer (top-up, eSIM, voucher).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zendit/refs/heads/main/json-schema/zendit-api-offer-schema.json",
  "type": "object",
  "properties": {
    "offerId": {
      "type": "string",
      "description": "Unique offer identifier.",
      "example": "offer-12345"
    },
    "name": {
      "type": "string",
      "description": "Offer display name.",
      "example": "Rebel Prepaid 10 USD"
    },
    "brand": {
      "type": "string",
      "description": "Brand identifier.",
      "example": "rebel-prepaid"
    },
    "country": {
      "type": "string",
      "description": "Country code.",
      "example": "US"
    },
    "type": {
      "type": "string",
      "description": "Offer type.",
      "example": "TOPUP"
    },
    "subType": {
      "type": "string",
      "description": "Offer sub-type.",
      "example": "Mobile Top Up"
    },
    "price": {
      "$ref": "#/components/schemas/Price"
    },
    "send": {
      "$ref": "#/components/schemas/Price"
    },
    "receive": {
      "$ref": "#/components/schemas/Price"
    }
  }
}