Set a coupon's expiration time

v1.0.0

Set a coupon's expiry time with the specified coupon ID. The expiredTime of a coupon must be greater than its issuedTime. This cannot be performed on expired coupons.

Input

{
  "type": "object",
  "required": [
    "expiredTime"
  ],
  "properties": {
    "expiredTime": {
      "type": "string",
      "format": "date-time",
      "description": "The coupon's expiry time, must be greater than the issued time. Null or empty string will immediately expire the coupon."
    }
  }
}

Output

{
  "type": "object",
  "description": "Coupons and Discounts.",
  "required": [
    "discount",
    "issuedTime"
  ],
  "properties": {
    "_links": {
      "type": "array",
      "description": "The links related to resource.",
      "items": {
        "type": "object",
        "required": [
          "rel"
        ],
        "properties": {
          "rel": {
            "type": "string",
            "description": "The link type.",
            "enum": [
              "self"
            ]
          }
        }
      }
    },
    "createdTime": {
      "description": "Coupon created time.",
      "type": "object"
    },
    "description": {
      "type": "string",
      "description": "Your coupon description. When it is not empty this is used for invoice discount item description, otherwise the item's description uses coupon's ID like 'Coupon \"COUPON-ID\"'.\n"
    },
    "discount": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Discount type.",
          "enum": [
            "fixed",
            "percent"
          ]
        }
      }
    },
    "expiredTime": {
      "type": "string",
      "format": "date-time",
      "description": "Coupon's expire time (end time)."
    },
    "id": {
      "description": "Coupon's ID a.k.a redemption code.",
      "type": "object"
    },
    "issuedTime": {
      "type": "string",
      "format": "date-time",
      "description": "Coupon's issued time (start time)."
    },
    "redemptionsCount": {
      "type": "integer",
      "description": "Coupon's redemptions count."
    },
    "restrictions": {
      "type": "array",
      "description": "Coupon restrictions.",
      "items": {
        "type": "object",
        "description": "Coupon restrictions.",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "Coupon's restriction type.",
            "enum": [
              "discounts-per-redemption",
              "minimum-order-amount",
              "redemptions-per-customer",
              "restrict-to-invoices",
              "restrict-to-plans",
              "restrict-to-subscriptions",
              "restrict-to-products",
              "total-redemptions",
              "paid-by-time"
            ]
          }
        }
      }
    },
    "status": {
      "type": "string",
      "description": "If coupon enabled.",
      "enum": [
        "draft",
        "issued",
        "expired"
      ]
    },
    "updatedTime": {
      "description": "Coupon updated time.",
      "type": "object"
    }
  }
}