Skip to main content
It stores the voucher information.
Field NameData TypeDescriptionNested Fields
_idstringUnique identifier for each document within collection0
voucher_idstringUnique identifier for voucher0
codestringField for code0
namestringName of specific voucher.0
descriptionstringField for description0
statusstringCurrent status of voucher.0
voucher_typestringField for voucher type0
discountobjectObject containing discount details4
discount.typestringField for type0
discount.valueintegerField for value0
discount.currencystringField for currency0
discount.max_discount_amountintegerField for max discount amount0
conditionsobjectObject containing conditions details7
conditions.validity_periodobjectUnique identifier for validity period2
conditions.validity_period.start_atdatetimeField for start at0
conditions.validity_period.end_atdatetimeField for end at0
conditions.min_purchaseobjectObject containing min purchase details2
conditions.min_purchase.amountintegerField for amount0
conditions.min_purchase.currencystringField for currency0
conditions.applies_toobjectObject containing applies to details2
conditions.applies_to.typestringField for type0
conditions.applies_to.idsstringUnique identifier for ids0
conditions.customer_eligibilityobjectObject containing customer eligibility details2
conditions.customer_eligibility.typestringField for type0
conditions.customer_eligibility.idsstringUnique identifier for ids0
conditions.locationobjectObject containing location details2
conditions.location.countriesarray_of_stringList of countries0
conditions.location.citiesarray_of_stringField for cities0
conditions.client_platformsarray_of_stringList of client platforms0
conditions.payment_methodsobjectObject containing payment methods details2
conditions.payment_methods.card_networksstringField for card networks0
conditions.payment_methods.issuing_banksstringField for issuing banks0
usage_limitsobjectObject containing usage limits details2
usage_limits.total_redemptionsintegerField for total redemptions0
usage_limits.redemptions_per_userintegerField for redemptions per user0
usage_statsobjectObject containing usage stats details1
usage_stats.current_redemptionsintegerField for current redemptions0
stacking_rulesobjectObject containing stacking rules details1
stacking_rules.can_stack_with_promotionsbooleanField for can stack with promotions0
auditobjectObject containing audit details3
audit.created_atdatetimeTimestamp for when created at was created/updated0
audit.updated_atdatetimeTimestamp for when updated at was created/updated0
audit.created_bystringTimestamp for when created by was created/updated0
is_activebooleanField for is active0
created_atstringTimestamp when the record was created0
updated_atstringTimestamp when the record was updated0
{
  "_id": {
    "$oid": "685abf3ea296fdf09c9c531d"
  },
  "voucher_id": "d417994b-a2dd-4516-89bd-7803b2dbe294",
  "code": "SAMPLE20",
  "name": "Sample Voucher",
  "description": "Sample voucher description",
  "status": "ACTIVE",
  "voucher_type": "MULTI_USE",
  "discount": {
    "type": "PERCENTAGE",
    "value": 20,
    "currency": "USD",
    "max_discount_amount": 100
  },
  "conditions": {
    "validity_period": {
      "start_at": {
        "$date": "2025-06-24T20:37:42.239Z"
      },
      "end_at": {
        "$date": "2025-06-24T20:37:42.239Z"
      }
    },
    "min_purchase": {
      "amount": 100,
      "currency": "USD"
    },
    "applies_to": {
      "type": "ENTIRE_ORDER",
      "ids": []
    },
    "customer_eligibility": {
      "type": "ALL_USERS",
      "ids": []
    },
    "location": {
      "countries": [
        "US"
      ],
      "cities": []
    },
    "client_platforms": [
      "WEB",
      "ANDROID_APP",
      "IOS_APP"
    ],
    "payment_methods": {
      "card_networks": [],
      "issuing_banks": []
    }
  },
  "usage_limits": {
    "total_redemptions": 1000,
    "redemptions_per_user": 1
  },
  "usage_stats": {
    "current_redemptions": 0
  },
  "stacking_rules": {
    "can_stack_with_promotions": false
  },
  "audit": {
    "created_at": {
      "$date": "2025-06-24T20:37:42.239Z"
    },
    "updated_at": {
      "$date": "2025-06-24T20:37:42.239Z"
    },
    "created_by": "system"
  },
  "is_active": true,
  "created_at": {
    "$date": "2025-06-24T20:37:42.239Z"
  },
  "updated_at": {
    "$date": "2025-06-24T20:37:42.239Z"
  }
}